ByteStreamDataWriter Class Reference

This class defines abstract interface for data writing. More...

#include <ByteStreamDataWriter.h>

Inheritance diagram for ByteStreamDataWriter:

Collaboration diagram for ByteStreamDataWriter:

Public Member Functions
	ByteStreamDataWriter ()
virtual	~ByteStreamDataWriter ()=default
	ByteStreamDataWriter (const ByteStreamDataWriter &)=delete
ByteStreamDataWriter &	operator= (const ByteStreamDataWriter &)=delete
virtual EventStorage::DWError	putData (unsigned int dataSize, const void *data)=0
	Write a single block of data.
virtual bool	good () const =0
	Feedback to user, check if open and last write went OK.

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.
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.
static std::unique_ptr< ByteStreamDataWriter >	makeWriter (const DataWriterParameters &parameters)
	Factory method returning data writer instance for specified version.

Detailed Description

This class defines abstract interface for data writing.

Main purpose of this class is to provide interface for writing different versions of output ByteStream files. This interface will be implemented on top of the EventStorage/DataWriter (from tdaq-common) and it will only provide few methods relevant to this package. The interface is defined in terms of data structures of the current version of the EventStorage, implementations for older versions will need to translate those structures into their version-specific data.

In addition to abstract methods this class defines few factory methods which return instances implementing this interface.

Definition at line 41 of file ByteStreamDataWriter.h.

Constructor & Destructor Documentation

ByteStreamDataWriter() [1/2]

ByteStreamDataWriter::ByteStreamDataWriter ( )

inline

Definition at line 123 of file ByteStreamDataWriter.h.

{}

~ByteStreamDataWriter()

virtual ByteStreamDataWriter::~ByteStreamDataWriter ( )

virtualdefault

ByteStreamDataWriter() [2/2]

ByteStreamDataWriter::ByteStreamDataWriter ( const ByteStreamDataWriter & )

delete

Member Function Documentation

good()

virtual bool ByteStreamDataWriter::good ( ) const

pure virtual

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

Implemented in ByteStreamDataWriterV5.

makeWriter() [1/3]

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

static

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 )

static

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 )

static

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=()

ByteStreamDataWriter & ByteStreamDataWriter::operator= ( const ByteStreamDataWriter & )

delete

putData()

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

pure virtual

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

Implemented in ByteStreamDataWriterV5.

---

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

• ByteStreamDataWriter.h
• ByteStreamDataWriter.cxx