Class containing parameters needed to initiate DataWriter. More...

#include <ByteStreamDataWriter.h>

Collaboration diagram for DataWriterParameters:

Public Attributes
int	version {0}
	Writer version to instantiate, 0 for most current version. More...

std::string	writingPath {""}
	Directory where to write data. More...

std::string	fileNameCore {""}
	File name not including the ending "._NNNN.data". More...

EventStorage::run_parameters_record	rPar
	Other parameters from IS including the run number. More...

std::vector< std::string >	fmdStrings
	Optional vector of strings containing metadata. More...

unsigned int	maxFileNE {0}
	Max size of a file in number of data blocks (or events) More...

unsigned int	maxFileMB {0}
	Max size of a file in MB. The file is closed before this limit is overrun. More...

unsigned int	startIndex {1}
	Initial file sequence index. More...

EventStorage::CompressionType	compression {EventStorage::NONE}
	Compression type. More...

unsigned int	compLevel {1}
	Compression level. More...

boost::shared_ptr< EventStorage::FileNameCallback >	theFNCB
	callback method for generating file names More...

std::string	project {""}
	project name for use with simple file name More...

std::string	streamType {""}
	stream type for use with simple file name More...

std::string	streamName {""}
	stream name for use with simple file name More...

std::string	stream {""}
	not sure for use with simple file name More...

unsigned int	lumiBlockNumber {0}
	luminosity block number for use with simple file name More...

std::string	applicationName {""}
	application name for use with simple file name More...

Detailed Description

Class containing parameters needed to initiate DataWriter.

This class is meant to given to the factory method creating data writer instances. The parameters need to be set to valid values.

Definition at line 153 of file ByteStreamDataWriter.h.

Member Data Documentation

◆ applicationName

std::string DataWriterParameters::applicationName {""}

application name for use with simple file name

Definition at line 208 of file ByteStreamDataWriter.h.

◆ compLevel

unsigned int DataWriterParameters::compLevel {1}

Compression level.

Definition at line 187 of file ByteStreamDataWriter.h.

◆ compression

EventStorage::CompressionType DataWriterParameters::compression {EventStorage::NONE}

Compression type.

Definition at line 184 of file ByteStreamDataWriter.h.

◆ fileNameCore

std::string DataWriterParameters::fileNameCore {""}

File name not including the ending "._NNNN.data".

Definition at line 165 of file ByteStreamDataWriter.h.

◆ fmdStrings

std::vector<std::string> DataWriterParameters::fmdStrings

Optional vector of strings containing metadata.

Definition at line 172 of file ByteStreamDataWriter.h.

◆ lumiBlockNumber

unsigned int DataWriterParameters::lumiBlockNumber {0}

luminosity block number for use with simple file name

Definition at line 205 of file ByteStreamDataWriter.h.

◆ maxFileMB

unsigned int DataWriterParameters::maxFileMB {0}

Max size of a file in MB. The file is closed before this limit is overrun.

Definition at line 178 of file ByteStreamDataWriter.h.

◆ maxFileNE

unsigned int DataWriterParameters::maxFileNE {0}

Max size of a file in number of data blocks (or events)

Definition at line 175 of file ByteStreamDataWriter.h.

◆ project

std::string DataWriterParameters::project {""}

project name for use with simple file name

Definition at line 193 of file ByteStreamDataWriter.h.

◆ rPar

EventStorage::run_parameters_record DataWriterParameters::rPar

Initial value:

{

0, 0, 0, 0, 0, 0, 0xFFFFFFFFFFFFFFFFULL, 0xFFFFFFFFFFFFFFFFULL, 0, 0 }

Other parameters from IS including the run number.

Definition at line 168 of file ByteStreamDataWriter.h.

◆ startIndex

unsigned int DataWriterParameters::startIndex {1}

Initial file sequence index.

Definition at line 181 of file ByteStreamDataWriter.h.

◆ stream

std::string DataWriterParameters::stream {""}

not sure for use with simple file name

Definition at line 202 of file ByteStreamDataWriter.h.

◆ streamName

std::string DataWriterParameters::streamName {""}

stream name for use with simple file name

Definition at line 199 of file ByteStreamDataWriter.h.

◆ streamType

std::string DataWriterParameters::streamType {""}

stream type for use with simple file name

Definition at line 196 of file ByteStreamDataWriter.h.

◆ theFNCB

boost::shared_ptr<EventStorage::FileNameCallback> DataWriterParameters::theFNCB

callback method for generating file names

Definition at line 190 of file ByteStreamDataWriter.h.

◆ version

int DataWriterParameters::version {0}

Writer version to instantiate, 0 for most current version.

Other supported values: 5 for run1-compatible output. Exception is thrown is version is not supported.

Definition at line 159 of file ByteStreamDataWriter.h.

◆ writingPath

std::string DataWriterParameters::writingPath {""}

Directory where to write data.

Definition at line 162 of file ByteStreamDataWriter.h.

The documentation for this struct was generated from the following file:

ByteStreamDataWriter.h

Public Attributes