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

Implementation of file input for HLD files. More...

#include <hadaq/HldInput.h>

Inheritance diagram for hadaq::HldInput:
dabc::FileInput dabc::DataInput

Public Member Functions

 HldInput (const dabc::Url &ulr)
 
virtual unsigned Read_Complete (dabc::Buffer &buf)
 Complete reading of the buffer from source,. More...
 
virtual bool Read_Init (const dabc::WorkerRef &wrk, const dabc::Command &cmd)
 Initialize data input, using port and command. More...
 
virtual unsigned Read_Size ()
 Defines required buffer size for next operation. More...
 
virtual ~HldInput ()
 
- Public Member Functions inherited from dabc::FileInput
virtual bool Read_Stat (dabc::Command cmd)
 Provide timeout value. More...
 
void SetIO (dabc::FileInterface *io)
 
virtual ~FileInput ()
 
- Public Member Functions inherited from dabc::DataInput
virtual unsigned Read_Start (Buffer &buf)
 Prepare buffer for reading (if required) More...
 
virtual double Read_Timeout ()
 Provide timeout value. More...
 
Buffer ReadBuffer ()
 Reads complete buffer. More...
 
virtual ~DataInput ()
 

Protected Member Functions

bool CloseFile ()
 
bool OpenNextFile ()
 
- Protected Member Functions inherited from dabc::FileInput
void ClearCurrentFileName ()
 
const std::string & CurrentFileName () const
 
 FileInput (const dabc::Url &url)
 
bool InitFilesList ()
 
bool TakeNextFileName ()
 
- Protected Member Functions inherited from dabc::DataInput
virtual WorkerAddonRead_GetAddon ()
 Returns addon, provided by data input If specified, supposed that I/O object is double-deriver from DataInput and Addon. More...
 

Protected Attributes

hadaq::HldFile fFile
 
- Protected Attributes inherited from dabc::FileInput
std::string fCurrentName
 
std::string fFileName
 
dabc::Reference fFilesList
 
dabc::FileInterfacefIO
 
bool fLoop
 read file(s) in endless loop More...
 
double fReduce
 factor to reduce buffer size when reading More...
 

Detailed Description

Implementation of file input for HLD files.

Definition at line 31 of file HldInput.h.

Constructor & Destructor Documentation

◆ HldInput()

hadaq::HldInput::HldInput ( const dabc::Url ulr)

Definition at line 26 of file HldInput.cxx.

◆ ~HldInput()

hadaq::HldInput::~HldInput ( )
virtual

Definition at line 36 of file HldInput.cxx.

Member Function Documentation

◆ CloseFile()

bool hadaq::HldInput::CloseFile ( )
protected

Definition at line 65 of file HldInput.cxx.

◆ OpenNextFile()

bool hadaq::HldInput::OpenNextFile ( )
protected

Definition at line 48 of file HldInput.cxx.

◆ Read_Init()

bool hadaq::HldInput::Read_Init ( const dabc::WorkerRef wrk,
const dabc::Command cmd 
)
virtual

Initialize data input, using port and command.

This is generic virtual method to initialize input, using configurations from Port and (or) from the Command

Parameters
[in]wrkreference on input port
[in]cmdreference on command object
Returns
false when method fails

Reimplemented from dabc::FileInput.

Definition at line 41 of file HldInput.cxx.

◆ Read_Size()

unsigned hadaq::HldInput::Read_Size ( )
virtual

Defines required buffer size for next operation.

Returns
  • 0..di_ValidSize - size of buffer for next read operation (di_ValidSize = 0xFFFFFFF0)
  • di_EndOfStream - this is end of stream, normal close of the input
  • di_DfltBufSize - any non-zero buffer can be provided
  • di_Repeat - nothing to read now, try again as soon as possible
  • di_RepeatTimeOut - nothing to read now, try again after timeout
  • di_CallBack - input will activate transport via callback
  • di_Error - error, close input

Reimplemented from dabc::DataInput.

Definition at line 72 of file HldInput.cxx.

◆ Read_Complete()

unsigned hadaq::HldInput::Read_Complete ( dabc::Buffer buf)
virtual

Complete reading of the buffer from source,.

Returns
  • di_Ok - buffer filled and ready
  • di_EndOfStream - this is end of stream, normal close of the input
  • di_SkipBuffer - skip buffer
  • di_Error - error, skip buffer and close input
  • di_Repeat - not ready, call again as soon as possible
  • di_RepeatTimeOut - not ready, call again after timeout

Reimplemented from dabc::DataInput.

Definition at line 82 of file HldInput.cxx.

Field Documentation

◆ fFile

hadaq::HldFile hadaq::HldInput::fFile
protected

Definition at line 34 of file HldInput.h.


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