ldas-tools-framecpp  2.7.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Common::IFrameStreamPlanWrapper< DECL > Class Template Reference

Frame Reading FrameStreamPlanWrapper. More...

#include <FrameStreamPlanWrapper.hh>

Inheritance diagram for FrameCPP::Common::IFrameStreamPlanWrapper< DECL >:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Common::IFrameStreamPlanWrapper< DECL >:
Collaboration graph
[legend]

Public Member Functions

fr_adc_data_type ReadFrAdcData (frame_offset_type Frame, INT_4U Channel)
 Extract the requested FrAdcData structure from the stream. More...
 
fr_adc_data_type ReadFrAdcData (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrAdcData structure from the stream. More...
 
fr_event_type ReadFrEvent (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrEvent structure from the stream. More...
 
fr_event_type ReadFrEvent (const std::string &EventType, fr_event_offset_type Offset)
 Extract the requested FrEvent structure from the stream. More...
 
fr_proc_data_type ReadFrProcData (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrProcData structure from the stream. More...
 
fr_ser_data_type ReadFrSerData (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSerData structure from the stream. More...
 
fr_sim_data_type ReadFrSimData (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSimData structure from the stream. More...
 
fr_sim_event_type ReadFrSimEvent (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSimEvent structure from the stream. More...
 
fr_sim_event_type ReadFrSimEvent (const std::string &SimEventType, fr_event_offset_type Offset)
 Extract the requested FrSimEvent structure from the stream. More...
 
fr_adc_data_type ReadFrAdcData (frame_offset_type Frame, INT_4U Channel)
 Extract the requested FrAdcData structure from the stream. More...
 
fr_adc_data_type ReadFrAdcData (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrAdcData structure from the stream. More...
 
fr_event_type ReadFrEvent (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrEvent structure from the stream. More...
 
fr_event_type ReadFrEvent (const std::string &EventType, fr_event_offset_type Offset)
 Extract the requested FrEvent structure from the stream. More...
 
fr_proc_data_type ReadFrProcData (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrProcData structure from the stream. More...
 
fr_ser_data_type ReadFrSerData (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSerData structure from the stream. More...
 
fr_sim_data_type ReadFrSimData (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSimData structure from the stream. More...
 
fr_sim_event_type ReadFrSimEvent (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSimEvent structure from the stream. More...
 
fr_sim_event_type ReadFrSimEvent (const std::string &SimEventType, fr_event_offset_type Offset)
 Extract the requested FrSimEvent structure from the stream. More...
 
frame_h_type ReadFrameH (frame_offset_type Frame, INT_4U ContainerSet)
 Extract the requested FrameH structure from the stream. More...
 
frame_h_type ReadFrameH (frame_offset_type Frame, INT_4U ContainerSet)
 Extract the requested FrameH structure from the stream. More...
 
fr_adc_data_type ReadFrAdcData (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrAdcData structure from the stream. More...
 
fr_adc_data_type ReadFrAdcData (frame_offset_type Frame, INT_4U Channel)
 Extract the requested FrAdcData structure from the stream. More...
 
fr_adc_data_type ReadFrAdcStruct (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrAdcData structure from the stream. More...
 
fr_adc_data_type ReadFrAdcStruct (frame_offset_type Frame, INT_4U Channel)
 Extract the requested FrAdcData structure from the stream. More...
 
fr_adc_data_type ReadFrAdcStruct (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrAdcData structure from the stream. More...
 
fr_adc_data_type ReadFrAdcStruct (frame_offset_type Frame, INT_4U Channel)
 Extract the requested FrAdcData structure from the stream. More...
 
fr_event_type ReadFrEvent (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrEvent structure from the stream. More...
 
fr_event_type ReadFrEventStruct (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrEvent structure from the stream. More...
 
fr_event_type ReadFrEventStruct (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrEvent structure from the stream. More...
 
fr_proc_data_type ReadFrProcData (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrProcData structure from the stream. More...
 
fr_proc_data_type ReadFrProcData (frame_offset_type Frame, INT_4U Channel)
 Extract the requested FrProcData structure from the stream. More...
 
fr_proc_data_type ReadFrProcStruct (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrProcData structure from the stream. More...
 
fr_proc_data_type ReadFrProcStruct (frame_offset_type Frame, INT_4U Channel)
 Extract the requested FrProcData structure from the stream. More...
 
fr_proc_data_type ReadFrProcStruct (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrProcData structure from the stream. More...
 
fr_proc_data_type ReadFrProcStruct (frame_offset_type Frame, INT_4U Channel)
 Extract the requested FrProcData structure from the stream. More...
 
fr_raw_data_type ReadFrRawData (frame_offset_type Frame)
 Extract the requested FrRawData structure from the stream. More...
 
fr_raw_data_type ReadFrRawData (frame_offset_type Frame)
 Extract the requested FrRawData structure from the stream. More...
 
fr_ser_data_type ReadFrSerData (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSerData structure from the stream. More...
 
fr_ser_data_type ReadFrSerStruct (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSerData structure from the stream. More...
 
fr_ser_data_type ReadFrSerStruct (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSerData structure from the stream. More...
 
fr_sim_event_type ReadFrSimEvent (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSimEvent structure from the stream. More...
 
fr_sim_event_type ReadFrSimEventStruct (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSimEvent structure from the stream. More...
 
fr_sim_event_type ReadFrSimEventStruct (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSimEvent structure from the stream. More...
 
fr_sim_data_type ReadFrSimStruct (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSerData structure from the stream. More...
 
fr_sim_data_type ReadFrSimStruct (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSerData structure from the stream. More...
 
fr_sim_data_type ReadFrSimData (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSerData structure from the stream. More...
 
frame_h_type ReadNextFrame ()
 Extract the next FrameH structure from the stream. More...
 
frame_h_type ReadNextFrame ()
 Extract the next FrameH structure from the stream. More...
 
size_type GetCurrentFrameOffset () const
 Retrieve the current frame. More...
 
size_type GetCurrentFrameOffset () const
 Retrieve the current frame. More...
 
object_type Read ()
 
object_type ReadDetector (const std::string &Name)
 Read the detector via the table of contents. More...
 
object_type ReadDetector (const std::string &Name)
 Read the detector via the table of contents. More...
 
IFrameStream::object_type ReadFrStatData (INT_8U Position)
 Read FrStatData at a given postion in the stream. More...
 
IFrameStream::object_type ReadFrStatData (INT_8U Position)
 Read FrStatData at a given postion in the stream. More...
 

Protected Member Functions

object_type readObject (const StreamRefInterface *StreamRef)
 Read an Object referenced in the stream. More...
 
object_type readObject (const StreamRefInterface *StreamRef)
 Read an Object referenced in the stream. More...
 
ptr_struct_base_type ReadPtrStruct ()
 
void Resolve ()
 Method to resolve links.
 
cmn_streamsize_type Size ()
 Return the size of the stream. More...
 
cmn_streamsize_type Size ()
 Return the size of the stream. More...
 

Protected Attributes

checksum_filter_type m_file_checksum
 Checksum for file.
 
checksum_filter_type m_frame_checksum
 Checksum for frame.
 
checksum_filter_type m_obj_checksum
 Checksum for object.
 
md5sum_filter_type m_file_md5sum
 MD5Sum value for the files.
 

Detailed Description

template<DECL>
class FrameCPP::Common::IFrameStreamPlanWrapper< DECL >

Frame Reading FrameStreamPlanWrapper.

Member Function Documentation

◆ GetCurrentFrameOffset() [1/2]

IFrameStream::size_type IFrameStream::GetCurrentFrameOffset ( ) const
inlineinherited

Retrieve the current frame.

Returns
If no frames have been read, then the value of ~0 is returned, otherwise the value of the current frame is returned.

◆ GetCurrentFrameOffset() [2/2]

size_type FrameCPP::Common::IFrameStream::GetCurrentFrameOffset ( ) const
inherited

Retrieve the current frame.

Returns
If no frames have been read, then the value of ~0 is returned, otherwise the value of the current frame is returned.

◆ Read()

IFrameStream::object_type IFrameStream::Read ( )
inherited
Todo:
Check if read goes beyond the end of the file

◆ ReadDetector() [1/2]

IFrameStream::object_type IFrameStream::ReadDetector ( const std::string &  Name)
inherited

Read the detector via the table of contents.

Parameters
[in]NameThe name of the detector to be read
Returns
Upon successfully reading the detector, a reference to the detector is returned, otherwise an exception is is thrown.
Note
The caller is responsible to recycle the resources incurred from this call.

◆ ReadDetector() [2/2]

object_type FrameCPP::Common::IFrameStream::ReadDetector ( const std::string &  Name)
inherited

Read the detector via the table of contents.

Parameters
[in]NameThe name of the detector to be read
Returns
Upon successfully reading the detector, a reference to the detector is returned, otherwise an exception is is thrown.
Note
The caller is responsible to recycle the resources incurred from this call.

◆ ReadFrAdcData() [1/6]

template<DECL >
fr_adc_data_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrAdcData ( frame_offset_type  Frame,
INT_4U  Channel 
)

Extract the requested FrAdcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelZero based index of channel being requested.
Returns
Upon success, a non-NULL pointer to the FrAdcData is returned. Upon failure, either an exception is thrown

◆ ReadFrAdcData() [2/6]

template<DECL >
IFrameStreamPlanWrapper< DECL_PARAMS >::fr_adc_data_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrAdcData ( frame_offset_type  Frame,
INT_4U  Channel 
)
inline

Extract the requested FrAdcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelZero based index of channel being requested.
Returns
Upon success, a non-NULL pointer to the FrAdcData is returned. Upon failure, either an exception is thrown

◆ ReadFrAdcData() [3/6]

template<DECL >
IFrameStreamPlanWrapper< DECL_PARAMS >::fr_adc_data_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrAdcData ( frame_offset_type  Frame,
const std::string &  Channel 
)
inline

Extract the requested FrAdcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrAdcData is returned. Upon failure, either an exception is thrown

◆ ReadFrAdcData() [4/6]

template<DECL >
fr_adc_data_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrAdcData ( frame_offset_type  Frame,
const std::string &  Channel 
)

Extract the requested FrAdcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrAdcData is returned. Upon failure, either an exception is thrown

◆ ReadFrAdcData() [5/6]

IFrameStreamWrapper< DECL_PARAMS >::fr_adc_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrAdcData ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrAdcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrAdcData is returned. Upon failure, either an exception is thrown

◆ ReadFrAdcData() [6/6]

IFrameStreamWrapper< DECL_PARAMS >::fr_adc_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrAdcData ( frame_offset_type  Frame,
INT_4U  Channel 
)
inherited

Extract the requested FrAdcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelZero based index of channel being requested.
Returns
Upon success, a non-NULL pointer to the FrAdcData is returned. Upon failure, either an exception is thrown

◆ ReadFrAdcStruct() [1/4]

fr_adc_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrAdcStruct ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrAdcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrAdcData is returned. Upon failure, either an exception is thrown

◆ ReadFrAdcStruct() [2/4]

IFrameStreamWrapper< DECL_PARAMS >::fr_adc_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrAdcStruct ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrAdcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrAdcData is returned. Upon failure, either an exception is thrown

◆ ReadFrAdcStruct() [3/4]

IFrameStreamWrapper< DECL_PARAMS >::fr_adc_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrAdcStruct ( frame_offset_type  Frame,
INT_4U  Channel 
)
inherited

Extract the requested FrAdcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelZero based index of channel being requested.
Returns
Upon success, a non-NULL pointer to the FrAdcData is returned. Upon failure, either an exception is thrown

◆ ReadFrAdcStruct() [4/4]

fr_adc_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrAdcStruct ( frame_offset_type  Frame,
INT_4U  Channel 
)
inherited

Extract the requested FrAdcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelZero based index of channel being requested.
Returns
Upon success, a non-NULL pointer to the FrAdcData is returned. Upon failure, either an exception is thrown

◆ ReadFrameH() [1/2]

IFrameStreamWrapper< DECL_PARAMS >::frame_h_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrameH ( frame_offset_type  Frame,
INT_4U  ContainerSet 
)
inherited

Extract the requested FrameH structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ContainerSetBit map of components to included.
Returns
Upon successful completion, the address of the FrameH structure linked with all requested subcomponents by ContainerSet.

◆ ReadFrameH() [2/2]

frame_h_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrameH ( frame_offset_type  Frame,
INT_4U  ContainerSet 
)
inherited

Extract the requested FrameH structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ContainerSetBit map of components to included.
Returns
Upon successful completion, the address of the FrameH structure linked with all requested subcomponents by ContainerSet.

◆ ReadFrEvent() [1/5]

template<DECL >
IFrameStreamPlanWrapper< DECL_PARAMS >::fr_event_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrEvent ( frame_offset_type  Frame,
const std::string &  Channel 
)
inline

Extract the requested FrEvent structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrEvent is returned. Upon failure, either an exception is thrown

◆ ReadFrEvent() [2/5]

template<DECL >
fr_event_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrEvent ( frame_offset_type  Frame,
const std::string &  Channel 
)

Extract the requested FrEvent structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrEvent is returned. Upon failure, either an exception is thrown

◆ ReadFrEvent() [3/5]

template<DECL >
IFrameStreamPlanWrapper< DECL_PARAMS >::fr_event_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrEvent ( const std::string &  EventType,
fr_event_offset_type  Offset 
)
inline

Extract the requested FrEvent structure from the stream.

Parameters
[in]EventTypeName of the event type being requested.
[in]OffsetIndex into the Event array for the Event type
Returns
Upon success, a non-NULL pointer to the FrEvent is returned. Upon failure, either an exception is thrown

◆ ReadFrEvent() [4/5]

template<DECL >
fr_event_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrEvent ( const std::string &  EventType,
fr_event_offset_type  Offset 
)

Extract the requested FrEvent structure from the stream.

Parameters
[in]EventTypeName of the event type being requested.
[in]OffsetIndex into the Event array for the Event type
Returns
Upon success, a non-NULL pointer to the FrEvent is returned. Upon failure, either an exception is thrown

◆ ReadFrEvent() [5/5]

IFrameStreamWrapper< DECL_PARAMS >::fr_event_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrEvent ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrEvent structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrEvent is returned. Upon failure, either an exception is thrown

◆ ReadFrEventStruct() [1/2]

fr_event_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrEventStruct ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrEvent structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrEvent is returned. Upon failure, either an exception is thrown

◆ ReadFrEventStruct() [2/2]

IFrameStreamWrapper< DECL_PARAMS >::fr_event_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrEventStruct ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrEvent structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrEvent is returned. Upon failure, either an exception is thrown

◆ ReadFrProcData() [1/4]

template<DECL >
IFrameStreamPlanWrapper< DECL_PARAMS >::fr_proc_data_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrProcData ( frame_offset_type  Frame,
const std::string &  Channel 
)
inline

Extract the requested FrProcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrProcData is returned. Upon failure, either an exception is thrown

◆ ReadFrProcData() [2/4]

template<DECL >
fr_proc_data_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrProcData ( frame_offset_type  Frame,
const std::string &  Channel 
)

Extract the requested FrProcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrProcData is returned. Upon failure, either an exception is thrown

◆ ReadFrProcData() [3/4]

IFrameStreamWrapper< DECL_PARAMS >::fr_proc_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrProcData ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrProcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrProcData is returned. Upon failure, either an exception is thrown

◆ ReadFrProcData() [4/4]

IFrameStreamWrapper< DECL_PARAMS >::fr_proc_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrProcData ( frame_offset_type  Frame,
INT_4U  Channel 
)
inherited

Extract the requested FrProcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelZero based index of channel being requested.
Returns
Upon success, a non-NULL pointer to the FrProcData is returned. Upon failure, either an exception is thrown

◆ ReadFrProcStruct() [1/4]

IFrameStreamWrapper< DECL_PARAMS >::fr_proc_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrProcStruct ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrProcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrProcData is returned. Upon failure, either an exception is thrown

◆ ReadFrProcStruct() [2/4]

fr_proc_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrProcStruct ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrProcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrProcData is returned. Upon failure, either an exception is thrown

◆ ReadFrProcStruct() [3/4]

IFrameStreamWrapper< DECL_PARAMS >::fr_proc_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrProcStruct ( frame_offset_type  Frame,
INT_4U  Channel 
)
inherited

Extract the requested FrProcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelZero based index of channel being requested.
Returns
Upon success, a non-NULL pointer to the FrProcData is returned. Upon failure, either an exception is thrown

◆ ReadFrProcStruct() [4/4]

fr_proc_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrProcStruct ( frame_offset_type  Frame,
INT_4U  Channel 
)
inherited

Extract the requested FrProcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelZero based index of channel being requested.
Returns
Upon success, a non-NULL pointer to the FrProcData is returned. Upon failure, either an exception is thrown

◆ ReadFrRawData() [1/2]

IFrameStreamWrapper< DECL_PARAMS >::fr_raw_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrRawData ( frame_offset_type  Frame)
inherited

Extract the requested FrRawData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
Returns
Upon success, a non-NULL pointer to the FrRawData is returned. Upon failure, either an exception is thrown

◆ ReadFrRawData() [2/2]

fr_raw_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrRawData ( frame_offset_type  Frame)
inherited

Extract the requested FrRawData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
Returns
Upon success, a non-NULL pointer to the FrRawData is returned. Upon failure, either an exception is thrown

◆ ReadFrSerData() [1/3]

template<DECL >
fr_ser_data_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrSerData ( frame_offset_type  Frame,
const std::string &  Channel 
)

Extract the requested FrSerData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSerData is returned. Upon failure, either an exception is thrown

◆ ReadFrSerData() [2/3]

template<DECL >
IFrameStreamPlanWrapper< DECL_PARAMS >::fr_ser_data_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrSerData ( frame_offset_type  Frame,
const std::string &  Channel 
)
inline

Extract the requested FrSerData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSerData is returned. Upon failure, either an exception is thrown

◆ ReadFrSerData() [3/3]

IFrameStreamWrapper< DECL_PARAMS >::fr_ser_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrSerData ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrSerData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSerData is returned. Upon failure, either an exception is thrown

◆ ReadFrSerStruct() [1/2]

IFrameStreamWrapper< DECL_PARAMS >::fr_ser_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrSerStruct ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrSerData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSerData is returned. Upon failure, either an exception is thrown

◆ ReadFrSerStruct() [2/2]

fr_ser_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrSerStruct ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrSerData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSerData is returned. Upon failure, either an exception is thrown

◆ ReadFrSimData() [1/3]

template<DECL >
fr_sim_data_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrSimData ( frame_offset_type  Frame,
const std::string &  Channel 
)

Extract the requested FrSimData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSimData is returned. Upon failure, either an exception is thrown

◆ ReadFrSimData() [2/3]

template<DECL >
IFrameStreamPlanWrapper< DECL_PARAMS >::fr_sim_data_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrSimData ( frame_offset_type  Frame,
const std::string &  Channel 
)
inline

Extract the requested FrSimData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSimData is returned. Upon failure, either an exception is thrown

◆ ReadFrSimData() [3/3]

IFrameStreamWrapper< DECL_PARAMS >::fr_sim_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrSimData ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrSerData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSimData is returned. Upon failure, either an exception is thrown

◆ ReadFrSimEvent() [1/5]

template<DECL >
fr_sim_event_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrSimEvent ( frame_offset_type  Frame,
const std::string &  Channel 
)

Extract the requested FrSimEvent structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSimEvent is returned. Upon failure, either an exception is thrown

◆ ReadFrSimEvent() [2/5]

template<DECL >
IFrameStreamPlanWrapper< DECL_PARAMS >::fr_sim_event_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrSimEvent ( frame_offset_type  Frame,
const std::string &  Channel 
)
inline

Extract the requested FrSimEvent structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSimEvent is returned. Upon failure, either an exception is thrown

◆ ReadFrSimEvent() [3/5]

template<DECL >
fr_sim_event_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrSimEvent ( const std::string &  SimEventType,
fr_event_offset_type  Offset 
)

Extract the requested FrSimEvent structure from the stream.

Parameters
[in]SimEventTypeName of the simulated event type being requested.
[in]OffsetIndex into the SimEvent array for the SimEvent type
Returns
Upon success, a non-NULL pointer to the FrSimEvent is returned. Upon failure, either an exception is thrown

◆ ReadFrSimEvent() [4/5]

template<DECL >
IFrameStreamPlanWrapper< DECL_PARAMS >::fr_sim_event_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrSimEvent ( const std::string &  SimEventType,
fr_event_offset_type  Offset 
)
inline

Extract the requested FrSimEvent structure from the stream.

Parameters
[in]SimEventTypeName of the simulated event type being requested.
[in]OffsetIndex into the SimEvent array for the SimEvent type
Returns
Upon success, a non-NULL pointer to the FrSimEvent is returned. Upon failure, either an exception is thrown

◆ ReadFrSimEvent() [5/5]

IFrameStreamWrapper< DECL_PARAMS >::fr_sim_event_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrSimEvent ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrSimEvent structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSimEvent is returned. Upon failure, either an exception is thrown

◆ ReadFrSimEventStruct() [1/2]

IFrameStreamWrapper< DECL_PARAMS >::fr_sim_event_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrSimEventStruct ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrSimEvent structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSimEvent is returned. Upon failure, either an exception is thrown

◆ ReadFrSimEventStruct() [2/2]

fr_sim_event_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrSimEventStruct ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrSimEvent structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSimEvent is returned. Upon failure, either an exception is thrown

◆ ReadFrSimStruct() [1/2]

IFrameStreamWrapper< DECL_PARAMS >::fr_sim_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrSimStruct ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrSerData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSimData is returned. Upon failure, either an exception is thrown

◆ ReadFrSimStruct() [2/2]

fr_sim_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrSimStruct ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrSerData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSimData is returned. Upon failure, either an exception is thrown

◆ ReadFrStatData() [1/2]

IFrameStream::object_type FrameCPP::Common::IFrameStream::ReadFrStatData ( INT_8U  Position)
inherited

Read FrStatData at a given postion in the stream.

Parameters
PositionOffset of the FrStatData in the stream

◆ ReadFrStatData() [2/2]

IFrameStream::object_type IFrameStream::ReadFrStatData ( INT_8U  Position)
inherited

Read FrStatData at a given postion in the stream.

Parameters
PositionOffset of the FrStatData in the stream
Todo:
Need to add support for reading the FrDetector for FrStatData structures where the FrStatData is before any FrameH structures.

◆ ReadNextFrame() [1/2]

IFrameStreamWrapper< DECL_PARAMS >::frame_h_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadNextFrame ( )
inherited

Extract the next FrameH structure from the stream.

Returns
Upon success, a pointer to a FrameH structure.

◆ ReadNextFrame() [2/2]

frame_h_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadNextFrame ( )
inherited

Extract the next FrameH structure from the stream.

Returns
Upon success, a pointer to a FrameH structure.

◆ readObject() [1/2]

IFrameStream::object_type IFrameStream::readObject ( const StreamRefInterface *  StreamRef)
protectedinherited

Read an Object referenced in the stream.

Parameters
StreamRefStream reference information for the requested object.
Note
In version 3 patch level 0 of the framecpp library, the length attribute for the FrSH and FrSE structures were not properly calculated. This reader will ignore this specific error so analysis of these frame files can continue.

◆ readObject() [2/2]

object_type FrameCPP::Common::IFrameStream::readObject ( const StreamRefInterface *  StreamRef)
protectedinherited

Read an Object referenced in the stream.

Parameters
StreamRefStream reference information for the requested object.

◆ ReadPtrStruct()

IStream::ptr_struct_base_type FrameCPP::Common::IStream::ReadPtrStruct ( )
inherited

Reads the next group of bytes from the stream as a PTR_STRUCT as defined by the active frame specification associated with the stream.

◆ Size() [1/2]

cmn_streamsize_type FrameCPP::Common::IStream::Size ( )
inlineinherited

Return the size of the stream.

Returns
The number of bytes that compose the stream

◆ Size() [2/2]

cmn_streamsize_type FrameCPP::Common::IStream::Size ( )
inherited

Return the size of the stream.

Returns
The number of bytes that compose the stream

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