CFEL - ASG Software Suite  2.5.0
CASS
Public Member Functions | Private Attributes | List of all members
cass::XtcReader Class Reference

class for reading xtc files More...

#include <xtc_reader.h>

+ Inheritance diagram for cass::XtcReader:
+ Collaboration diagram for cass::XtcReader:

Public Member Functions

 XtcReader ()
 constructor More...
 
bool operator() (std::ifstream &file, CASSEvent &event)
 read the xtc file contents put them into cassevent More...
 
void loadSettings ()
 load the settings of the reader More...
 
void readHeaderInfo (std::ifstream &file)
 read the file header More...
 
- Public Member Functions inherited from cass::FileReader
virtual ~FileReader ()
 virtual destructor More...
 
void filename (const std::string &filename)
 set the filename of the instance More...
 
const std::string & filename () const
 retrieve the filename that this instance is working on More...
 
std::string type () const
 return the type of file that this is for More...
 

Private Attributes

FormatConverter_convert
 a reference to the format converter functor More...
 

Additional Inherited Members

- Public Types inherited from cass::FileReader
typedef std::tr1::shared_ptr< FileReadershared_pointer
 typedef the shared pointer of this More...
 
- Static Public Member Functions inherited from cass::FileReader
static shared_pointer instance (const std::string &filename)
 create an instance of the requested type More...
 
- Protected Member Functions inherited from cass::FileReader
 FileReader ()
 only inheritants can create this More...
 
 FileReader (const std::string &type)
 set the readers type More...
 
- Protected Attributes inherited from cass::FileReader
std::string _filename
 the name of the file that we read the values from More...
 
std::string _type
 the reader type as string More...
 

Detailed Description

class for reading xtc files

it uses the format converter to the xtc datagrams to cassevent

Author
Lutz Foucar

Definition at line 29 of file xtc_reader.h.

Constructor & Destructor Documentation

XtcReader::XtcReader ( )

constructor

Definition at line 38 of file xtc_reader.cpp.

Member Function Documentation

void XtcReader::loadSettings ( )
virtual

load the settings of the reader

Implements cass::FileReader.

Definition at line 43 of file xtc_reader.cpp.

References _convert, and cass::FormatConverter::loadSettings().

bool XtcReader::operator() ( std::ifstream &  file,
CASSEvent event 
)
virtual

read the xtc file contents put them into cassevent

read datagrams until the return value of the conversion is true, which indicates

Returns
true when the workers should work on the filled cassevent, false if not.
Parameters
filethe file that contains the data to be put into the cassevent
eventthe CASSEvent where the data will be put into

Implements cass::FileReader.

Definition at line 70 of file xtc_reader.cpp.

References _convert, cass::CASSEvent::datagrambuffer(), readDgramHeaderToBuf(), and readDgramPayloadToBuf().

void XtcReader::readHeaderInfo ( std::ifstream &  file)
virtual

read the file header

read datagram by datagram until the first L1 transition appears

Parameters
filethe filestream to the header information of the file

Reimplemented from cass::FileReader.

Definition at line 48 of file xtc_reader.cpp.

References _convert, readDgramHeaderToBuf(), and readDgramPayloadToBuf().

Member Data Documentation

FormatConverter& cass::XtcReader::_convert
private

a reference to the format converter functor

Definition at line 60 of file xtc_reader.h.

Referenced by loadSettings(), operator()(), and readHeaderInfo().


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