ByteStreamDataWriterV5 Class Reference

Implementation of ByteStreamDataWriter for version 5 (run1) of EventStorage. More...

#include <ByteStreamDataWriterV5.h>

Inheritance diagram for ByteStreamDataWriterV5:

Collaboration diagram for ByteStreamDataWriterV5:

Public Member Functions
	ByteStreamDataWriterV5 (const std::string &writingPath, const std::string &fileNameCore, const EventStorage::run_parameters_record &rPar, const std::vector< std::string > &fmdStrings, unsigned int maxFileNE, unsigned int maxFileMB, unsigned int startIndex, EventStorage::CompressionType compression, unsigned int compLevel)
	ByteStreamDataWriterV5 (const std::string &writingPath, boost::shared_ptr< EventStorage::FileNameCallback > theFNCB, const EventStorage::run_parameters_record &rPar, const std::string &project, const std::string &streamType, const std::string &streamName, const std::string &stream, unsigned int lumiBlockNumber, const std::string &applicationName, const std::vector< std::string > &fmdStrings, unsigned int maxFileNE, unsigned int maxFileMB, EventStorage::CompressionType compression, unsigned int compLevel)
virtual	~ByteStreamDataWriterV5 ()
	ByteStreamDataWriterV5 (const ByteStreamDataWriterV5 &)=delete
ByteStreamDataWriterV5 &	operator= (const ByteStreamDataWriterV5 &)=delete
virtual EventStorage::DWError	putData (unsigned int dataSize, const void *data) override
	Write a single block of data. More...
virtual bool	good () const override
	Feedback to user, check if open and last write went OK. More...

Static Public Member Functions
static std::unique_ptr< ByteStreamDataWriter >	makeWriter (int version, const std::string &writingPath, const std::string &fileNameCore, const EventStorage::run_parameters_record &rPar, const std::vector< std::string > &fmdStrings, unsigned int maxFileNE=0, unsigned int maxFileMB=0, unsigned int startIndex=1, EventStorage::CompressionType compression=EventStorage::NONE, unsigned int compLevel=1)
	Factory method returning data writer instance for specified version. More...
static std::unique_ptr< ByteStreamDataWriter >	makeWriter (int version, const std::string &writingPath, boost::shared_ptr< EventStorage::FileNameCallback > theFNCB, const EventStorage::run_parameters_record &rPar, const std::string &project, const std::string &streamType, const std::string &streamName, const std::string &stream, unsigned int lumiBlockNumber, const std::string &applicationName, const std::vector< std::string > &fmdStrings, unsigned int maxFileNE=0, unsigned int maxFileMB=0, EventStorage::CompressionType compression=EventStorage::NONE, unsigned int compLevel=1)
	Factory method returning data writer instance for specified version. More...
static std::unique_ptr< ByteStreamDataWriter >	makeWriter (const DataWriterParameters &parameters)
	Factory method returning data writer instance for specified version. More...

Private Attributes
std::unique_ptr< offline_EventStorage_v5::DataWriter >	m_writer

Detailed Description

Implementation of ByteStreamDataWriter for version 5 (run1) of EventStorage.

Definition at line 24 of file ByteStreamDataWriterV5.h.

Constructor & Destructor Documentation

ByteStreamDataWriterV5() [1/3]

ByteStreamDataWriterV5::ByteStreamDataWriterV5	(	const std::string &	writingPath,
		const std::string &	fileNameCore,
		const EventStorage::run_parameters_record &	rPar,
		const std::vector< std::string > &	fmdStrings,
		unsigned int	maxFileNE,
		unsigned int	maxFileMB,
		unsigned int	startIndex,
		EventStorage::CompressionType	compression,
		unsigned int	compLevel
	)

Definition at line 34 of file ByteStreamDataWriterV5.cxx.

{
    // convert current run_parameters_record to v5
    offline_EventStorage_v5::run_parameters_record rPar_v5 = ::runPram_to_v5(rPar);
 
    // convert compression type
    offline_EventStorage_v5::CompressionType compression_v5 =
                    offline_EventStorage_v5::CompressionType(compression);
 
    m_writer.reset(new offline_EventStorage_v5::DataWriter(writingPath,
                                                           fileNameCore,
                                                           rPar_v5,
                                                           fmdStrings,
                                                           startIndex,
                                                           compression_v5,
                                                           compLevel));
    m_writer->setMaxFileNE(maxFileNE);
    m_writer->setMaxFileMB(maxFileMB);
}

ByteStreamDataWriterV5() [2/3]

ByteStreamDataWriterV5::ByteStreamDataWriterV5	(	const std::string &	writingPath,
		boost::shared_ptr< EventStorage::FileNameCallback >	theFNCB,
		const EventStorage::run_parameters_record &	rPar,
		const std::string &	project,
		const std::string &	streamType,
		const std::string &	streamName,
		const std::string &	stream,
		unsigned int	lumiBlockNumber,
		const std::string &	applicationName,
		const std::vector< std::string > &	fmdStrings,
		unsigned int	maxFileNE,
		unsigned int	maxFileMB,
		EventStorage::CompressionType	compression,
		unsigned int	compLevel
	)

Definition at line 62 of file ByteStreamDataWriterV5.cxx.

{
    // convert current run_parameters_record to v5
    offline_EventStorage_v5::run_parameters_record rPar_v5 = ::runPram_to_v5(rPar);
 
    // convert compression type
    offline_EventStorage_v5::CompressionType compression_v5 =
                    offline_EventStorage_v5::CompressionType(compression);
 
    m_writer.reset(new offline_EventStorage_v5::DataWriter(writingPath,
                                                           theFNCB,
                                                           rPar_v5,
                                                           project,
                                                           streamType,
                                                           streamName,
                                                           stream,
                                                           lumiBlockNumber,
                                                           applicationName,
                                                           fmdStrings,
                                                           compression_v5,
                                                           compLevel));
    m_writer->setMaxFileNE(maxFileNE);
    m_writer->setMaxFileMB(maxFileMB);
}

~ByteStreamDataWriterV5()

ByteStreamDataWriterV5::~ByteStreamDataWriterV5 ( )

virtual

Definition at line 100 of file ByteStreamDataWriterV5.cxx.

{
}

ByteStreamDataWriterV5() [3/3]

ByteStreamDataWriterV5::ByteStreamDataWriterV5 ( const ByteStreamDataWriterV5 &  )

delete

Member Function Documentation

good()

bool ByteStreamDataWriterV5::good ( ) const

overridevirtual

Feedback to user, check if open and last write went OK.

Implements ByteStreamDataWriter.

Definition at line 111 of file ByteStreamDataWriterV5.cxx.

{
    return m_writer->good();
}

makeWriter() [1/3]

std::unique_ptr< ByteStreamDataWriter > ByteStreamDataWriter::makeWriter ( const DataWriterParameters &  parameters )

staticinherited

Factory method returning data writer instance for specified version.

Throws exception in case of problems, never returns zero pointer.

Parameters

parameters

set of parameters needed to initiate DataWriter

Exceptions

std::exception

(or sub-class) is thrown in case of problems.

Definition at line 170 of file ByteStreamDataWriter.cxx.

                                                                       {
  // initiate with production file name
  if (parameters.theFNCB == nullptr)
    return makeWriter(
      parameters.version,
      parameters.writingPath,
      parameters.fileNameCore,
      parameters.rPar,
      parameters.fmdStrings,
      parameters.maxFileNE,
      parameters.maxFileMB,
      parameters.startIndex,
      parameters.compression,
      parameters.compLevel);
 
  // initiate for user-defined file name
  return makeWriter(
      parameters.version,
      parameters.writingPath,
      parameters.theFNCB,
      parameters.rPar,
      parameters.project,
      parameters.streamType,
      parameters.streamName,
      parameters.stream,
      parameters.lumiBlockNumber,
      parameters.applicationName,
      parameters.fmdStrings,
      parameters.maxFileNE,
      parameters.maxFileMB,
      parameters.compression,
      parameters.compLevel);
}

makeWriter() [2/3]

std::unique_ptr< ByteStreamDataWriter > ByteStreamDataWriter::makeWriter ( int  version, const std::string &  writingPath, boost::shared_ptr< EventStorage::FileNameCallback >  theFNCB, const EventStorage::run_parameters_record &  rPar, const std::string &  project, const std::string &  streamType, const std::string &  streamName, const std::string &  stream, unsigned int  lumiBlockNumber, const std::string &  applicationName, const std::vector< std::string > &  fmdStrings, unsigned int  maxFileNE = 0, unsigned int  maxFileMB = 0, EventStorage::CompressionType  compression = EventStorage::NONE, unsigned int  compLevel = 1  )

staticinherited

Factory method returning data writer instance for specified version.

Throws exception in case of problems, never returns zero pointer.

Parameters

version	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.
writingPath	directory where to write data
theFNCB	callback method for generating file names
rPar	other parameters from IS including the run number
fmdStrings	optional vector of strings containing metadata
maxFileNE	max size of a file in number of data blocks (or events)
maxFileMB	max size of a file in MB. The file is closed before this limit is overrun.
startIndex	initial file sequence index
compression	Compression type
compLevel	Compression level

Exceptions

std::exception

(or sub-class) is thrown in case of problems.

Definition at line 112 of file ByteStreamDataWriter.cxx.

{
    ByteStreamDataWriter* res = nullptr;
    if (version == 0 or version == FILE_FORMAT_VERSION) {
        // Use current version
        res = new ByteStreamDataWriterCurrent(writingPath,
                                              theFNCB,
                                              rPar,
                                              project,
                                              streamType,
                                              streamName,
                                              stream,
                                              lumiBlockNumber,
                                              applicationName,
                                              fmdStrings,
                                              maxFileNE,
                                              maxFileMB,
                                              compression,
                                              compLevel);
    } else if (version == 5) {
        // Run1 version
        res = new ByteStreamDataWriterV5(writingPath,
                                         theFNCB,
                                         rPar,
                                         project,
                                         streamType,
                                         streamName,
                                         stream,
                                         lumiBlockNumber,
                                         applicationName,
                                         fmdStrings,
                                         maxFileNE,
                                         maxFileMB,
                                         compression,
                                         compLevel);
    } else {
        // Unexpected something
        versionException(version);
    }
 
    return std::unique_ptr<ByteStreamDataWriter>(res);
}

makeWriter() [3/3]

std::unique_ptr< ByteStreamDataWriter > ByteStreamDataWriter::makeWriter ( int  version, const std::string &  writingPath, const std::string &  fileNameCore, const EventStorage::run_parameters_record &  rPar, const std::vector< std::string > &  fmdStrings, unsigned int  maxFileNE = 0, unsigned int  maxFileMB = 0, unsigned int  startIndex = 1, EventStorage::CompressionType  compression = EventStorage::NONE, unsigned int  compLevel = 1  )

staticinherited

Factory method returning data writer instance for specified version.

Throws exception in case of problems, never returns zero pointer.

Parameters

version	writer version to instantiate, 0 for most current version, other supported values: 5 for run1-compatible output. Exception is thrown if version is not supported.
writingPath	directory where to write data
fileNameCore	file name not including the ending "._NNNN.data"
rPar	other parameters from IS including the run number
fmdStrings	optional vector of strings containing metadata
maxFileNE	max size of a file in number of data blocks (or events)
maxFileMB	max size of a file in MB. The file is closed before this limit is overrun.
startIndex	initial file sequence index
compression	Compression type
compLevel	Compression level

Exceptions

std::exception

(or sub-class) is thrown in case of problems.

Definition at line 69 of file ByteStreamDataWriter.cxx.

{
    ByteStreamDataWriter* res = nullptr;
    if (version == 0 or version == FILE_FORMAT_VERSION) {
        // Use current version
        res = new ByteStreamDataWriterCurrent(writingPath,
                                              fileNameCore,
                                              rPar,
                                              fmdStrings,
                                              maxFileNE,
                                              maxFileMB,
                                              startIndex,
                                              compression,
                                              compLevel);
    } else if (version == 5) {
        // Run1 version
        res = new ByteStreamDataWriterV5(writingPath,
                                         fileNameCore,
                                         rPar,
                                         fmdStrings,
                                         maxFileNE,
                                         maxFileMB,
                                         startIndex,
                                         compression,
                                         compLevel);
    } else {
        // Unexpected something
        versionException(version);
    }
 
    return std::unique_ptr<ByteStreamDataWriter>(res);
}

operator=()

ByteStreamDataWriterV5& ByteStreamDataWriterV5::operator= ( const ByteStreamDataWriterV5 &  )

delete

putData()

EventStorage::DWError ByteStreamDataWriterV5::putData ( unsigned int  dataSize, const void *  data  )

overridevirtual

Write a single block of data.

If one of the size limits would be exceeded, the current file will be closed and another one will be opened automatically.

Parameters

dataSize	size of the data block in bytes
data	start of the event data in memory

Implements ByteStreamDataWriter.

Definition at line 105 of file ByteStreamDataWriterV5.cxx.

{
    return m_writer->putData(dataSize, data);
}

Member Data Documentation

m_writer

std::unique_ptr<offline_EventStorage_v5::DataWriter> ByteStreamDataWriterV5::m_writer

private

Definition at line 64 of file ByteStreamDataWriterV5.h.

---

The documentation for this class was generated from the following files:

• ByteStreamDataWriterV5.h
• ByteStreamDataWriterV5.cxx