Class Index | Cross Index | Namespace Index |
Class to handle frame I/O.
Contained in: FrameCPP::Version_6
Derived from:
Common::FrameStreamBase
FrameCPP::Version_6::FrameStreamBase
Derived by:
none
#include "../../../../../lib/framecpp/src/Version6/IFrameStream.hh"
public function member index: |
|||
IFrameStream | (std::istream& Stream, int Mode = ( MODE_TOC | MODE_DAQ | MODE_RANDOM_ACCESS )); | Constructor | |
IFrameStream | (std::istream& Stream, const std::vector< io_calls_type >& LibraryDefs, INT_4U NumberOfClassTypes, int Mode = ( MODE_TOC | MODE_DAQ | MODE_RANDOM_ACCESS )); | ||
~IFrameStream | (); | Destructor | |
void | AddContainer | (ContainerBasic< T >& C, const PTR_STRUCT& Ref); | |
void | AddPointer | (FrBase** Pointer, const PTR_STRUCT& Ref); | |
void | CheckReadBoundry | (INT_8U Offset); | Ensure that the read boundry is somewhere beyond the data to be read |
Frame5ReaderBase& | GetExposedFrame5Reader | (); | |
FrameReaderBase& | GetFrame5Reader | (); | |
INT_8U | GetLengthOfLastObject | () const; | |
PTR_STRUCT | GetNextNode5 | (); | Retrieve the Instance of the next pointer for version 5 frames |
INT_4U | GetNumberOfFrames | () const; | |
const char* | GetOriginator | () const; | Retrieve the originator of the frame |
INT_8U | GetPositionH | (INT_4U Frame); | |
const FrTOC* | GetTOC | () const; | |
FrAdcData* | ReadFrAdcData | (INT_4U Frame, const std::string& Channel); | |
FrAdcData* | ReadFrAdcData | (INT_4U Frame, INT_4U Channel); | |
FrAdcData* | ReadFrAdcStruct | (INT_4U Frame, const std::string& Channel); | |
FrAdcData* | ReadFrAdcStruct | (INT_4U Frame, INT_4U Channel); | |
FrEvent* | ReadFrEvent | (INT_4U Frame, const std::string& Channel); | |
FrProcData* | ReadFrProcData | (INT_4U Frame, const std::string& Channel); | |
FrProcData* | ReadFrProcData | (INT_4U Frame, INT_4U Channel); | |
FrProcData* | ReadFrProcStruct | (INT_4U Frame, const std::string& Channel); | |
FrProcData* | ReadFrProcStruct | (INT_4U Frame, INT_4U Channel); | |
FrRawData* | ReadFrRawData | (INT_4U Frame); | |
FrSerData* | ReadFrSerData | (INT_4U Frame, const std::string& Channel); | |
FrSerData* | ReadFrSerStruct | (INT_4U Frame, const std::string& Channel); | |
FrSimData* | ReadFrSimData | (INT_4U Frame, const std::string& Channel); | |
FrSimEvent* | ReadFrSimEvent | (INT_4U Frame, const std::string& Channel); | |
FrSimData* | ReadFrSimStruct | (INT_4U Frame, const std::string& Channel); | |
INT_4U | ReadFrStatData | (const std::string& NamePattern, const std::string& DetectorPattern, const General::GPSTime& StartTime, const General::GPSTime& EndTime, const INT_4U Version, Query& QueryResults); | Read FrStatData from the input file |
std::auto_ptr< FrStatData > | ReadFrStatData | (INT_8U Position); | Read FrStatData at a given position in the file |
FrameH* | ReadFrameH | (INT_4U Frame, INT_4U ContainerSet); | |
FrameH* | ReadFullFrame | (INT_4U Index); | |
FrameH* | ReadNextFrame | (); | |
FrBase* | ReadObject | (); | Read the next object |
FrBase* | ReadObject | (FrBase& Base); | Read the next object |
FrBase* | ReadObjectBase | (bool SkipUnknown = true); | Read the base of most objects |
IFrameStream& | ReadVector | (T& Data, INT_4U Size); | |
IFrameStream& | ReadVector | (std::vector< T >& Data, INT_4U Size); | |
void | RemoveContainer | (ContainerBasic< T >& C); | |
void | RemovePointer | (FrBase** Pointer); | |
virtual void | SetChecksumMethodFile | (const CheckSum::kind_type Method); | |
void | SetReadBoundry | (INT_8U Boundry = INT_8U( 0 )); | Establish the read boundry |
void | SkipObject | (const FrBase& Base) const; | Skip over unknown objects. |
void | clear | (); | |
bool | eof | () const; | |
bool | good | () const; | |
IFrameStream& | operator >> | (T* Data); | |
IFrameStream& | operator >> | (Container< T >& Data); | Read container from the stream |
IFrameStream& | operator >> | (T& Data); | Read data from the stream |
INT_4U | read | (void* Dest, INT_4U Length, bool CalcChecksum = true); | |
INT_8U | tellg | () const; | |
private function member index: |
|||
IFrameStream | (const IFrameStream&); | ||
void | MapRef | (); | |
void | init | (); | |
const IFrameStream& | operator = | (const IFrameStream&); | |
std::auto_ptr< FrData > | read_fr_data | (INT_8U Position); | |
FrBase* | read_object | (const PTR_STRUCT& Object); | |
FrBase* | read_objects_through | (INT_2U id); | |
void | read_recursive | (); | |
FrBase* | skip_till_class | (INT_2U id); | |
Parameters:
Parameter | Description |
std::iostream& Stream | Input or Output stream |
Parameters:
Parameter | Description |
INT_8U Offset | Number of bytes to read |
Return value:
nothingThis method will throw an exception if reading Offset number of bytes would extend beyond the current value of m_road_block
Read in a number of bytes
Parameters:
Parameter | Description |
void *Dest | Pointer to buffer receiving the data. |
INT_4U Length | Number of bytes to read. |
bool CalcChecksum | true if checksum is to be calcuted, false otherwise |
Return value:
INT_4UNumber of bytes actually read.
Reader for version 3, 4 and 5 frames
Mode of stream
This value is intended to be a soft marker of where the end of a structure should be
Input stream.