DABC (Data Acquisition Backbone Core)  2.9.9
Public Member Functions | Protected Member Functions | Protected Attributes
dabc::BinaryFileOutput Class Reference

Binary file output object. More...

#include <dabc/BinaryFileIO.h>

Inheritance diagram for dabc::BinaryFileOutput:
dabc::FileOutput dabc::DataOutput

Public Member Functions

 BinaryFileOutput (const dabc::Url &url)
virtual unsigned Write_Buffer (Buffer &buf)
 Start writing of buffer to output. More...
virtual bool Write_Init ()
 This is generic virtual method to initialize output before real work is started. More...
virtual ~BinaryFileOutput ()
- Public Member Functions inherited from dabc::FileOutput
virtual std::string ProvideInfo ()
 Method can be used to get debug info about output. More...
void SetIO (dabc::FileInterface *io)
virtual bool Write_Stat (dabc::Command cmd)
 Fill different statistic parameters into provided command. More...
virtual ~FileOutput ()
- Public Member Functions inherited from dabc::DataOutput
void SetInfoParName (const std::string &name)
 Methods set parameter name, which could be used for debug output. More...
virtual unsigned Write_Check ()
 Check if output can be done. More...
virtual unsigned Write_Complete ()
 Complete writing of the buffer. More...
virtual void Write_Flush ()
 Flush output object, called when buffer with EOL type is appeared. More...
virtual bool Write_Restart (dabc::Command cmd)
 Method used to restart output - like recreate new output file. More...
virtual bool Write_Retry ()
 Returns true if output object can be reinitialized for recover error. More...
virtual double Write_Timeout ()
 Timeout in seconds for write operation. More...
bool WriteBuffer (Buffer &buf)
 Write buffer to the output. More...
virtual ~DataOutput ()

Protected Member Functions

bool CloseFile ()
bool StartNewFile ()
- Protected Member Functions inherited from dabc::FileOutput
void AccountBuffer (unsigned sz, int numev=0)
bool CheckBufferForNextFile (unsigned sz)
 Return true if new file should be started. More...
const std::string & CurrentFileName () const
 FileOutput (const dabc::Url &url, const std::string &ext="")
int GetSizeLimitMB () const
std::string ProduceFileName (const std::string &suffix)
void ProduceNewFileName ()
- Protected Member Functions inherited from dabc::DataOutput
 DataOutput (const dabc::Url &url)
void ShowInfo (int lvl, const std::string &info)
virtual WorkerAddonWrite_GetAddon ()
 Returns addon, provided by data output If specified, supposed that I/O object is double-derived from DataOutput and Addon. More...

Protected Attributes

BinaryFile fFile
- Protected Attributes inherited from dabc::FileOutput
std::string fCurrentFileName
int fCurrentFileNumber
long fCurrentFileSize
std::string fFileExtens
std::string fFileName
int fSizeLimitMB
long fTotalFileSize
long fTotalNumBufs
long fTotalNumEvents
- Protected Attributes inherited from dabc::DataOutput
std::string fInfoName

Detailed Description

Binary file output object.

Implements dabc::DataOutput for binary dabc files.

Definition at line 67 of file BinaryFileIO.h.

Constructor & Destructor Documentation

◆ BinaryFileOutput()

dabc::BinaryFileOutput::BinaryFileOutput ( const dabc::Url url)

Definition at line 103 of file BinaryFileIO.cxx.

◆ ~BinaryFileOutput()

dabc::BinaryFileOutput::~BinaryFileOutput ( )

Definition at line 109 of file BinaryFileIO.cxx.

Member Function Documentation

◆ CloseFile()

bool dabc::BinaryFileOutput::CloseFile ( )

Definition at line 141 of file BinaryFileIO.cxx.

◆ StartNewFile()

bool dabc::BinaryFileOutput::StartNewFile ( )

Definition at line 124 of file BinaryFileIO.cxx.

◆ Write_Init()

bool dabc::BinaryFileOutput::Write_Init ( )

This is generic virtual method to initialize output before real work is started.

If returns false, object is immediately deleted

Reimplemented from dabc::FileOutput.

Definition at line 115 of file BinaryFileIO.cxx.

◆ Write_Buffer()

unsigned dabc::BinaryFileOutput::Write_Buffer ( Buffer buf)

Start writing of buffer to output.

Return values: do_Ok - operation is started, Write_Complete() must be called do_Error - error do_Skip - buffer must be skipped do_Close - output is closed

Reimplemented from dabc::DataOutput.

Definition at line 151 of file BinaryFileIO.cxx.

Field Documentation

◆ fFile

BinaryFile dabc::BinaryFileOutput::fFile

Definition at line 70 of file BinaryFileIO.h.

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