Wrapper to properly cast return values into the namespace associated with the frame specification namespace. More...

#include <FrameStreamWrapper.hh>

Public Types
typedef IFrameStream::buffer_type	buffer_type
	Definition of buffer_type.
typedef IFrameStream::buffer_type	buffer_type
	Definition of buffer_type.

Public Member Functions
	IFrameStreamWrapper (buffer_type *Buffer)
	Constructor.
	IFrameStreamWrapper (bool AutoDelete, buffer_type *Buffer)
	Constructor.
frame_h_type	ReadFrameH (frame_offset_type Frame, INT_4U ContainerSet)
	Extract the requested FrameH structure from the stream.
fr_adc_data_type	ReadFrAdcData (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrAdcData structure from the stream.
fr_adc_data_type	ReadFrAdcData (frame_offset_type Frame, INT_4U Channel)
	Extract the requested FrAdcData structure from the stream.
fr_adc_data_type	ReadFrAdcStruct (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrAdcData structure from the stream.
fr_adc_data_type	ReadFrAdcStruct (frame_offset_type Frame, INT_4U Channel)
	Extract the requested FrAdcData structure from the stream.
fr_event_type	ReadFrEvent (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrEvent structure from the stream.
fr_event_type	ReadFrEvent (const std::string &EventType, fr_event_offset_type Offset)
	Extract the requested FrEvent structure from the stream.
fr_event_type	ReadFrEventStruct (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrEvent structure from the stream.
fr_proc_data_type	ReadFrProcData (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrProcData structure from the stream.
fr_proc_data_type	ReadFrProcData (frame_offset_type Frame, INT_4U Channel)
	Extract the requested FrProcData structure from the stream.
fr_proc_data_type	ReadFrProcStruct (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrProcData structure from the stream.
fr_proc_data_type	ReadFrProcStruct (frame_offset_type Frame, INT_4U Channel)
	Extract the requested FrProcData structure from the stream.
fr_raw_data_type	ReadFrRawData (frame_offset_type Frame)
	Extract the requested FrRawData structure from the stream.
fr_ser_data_type	ReadFrSerData (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrSerData structure from the stream.
fr_ser_data_type	ReadFrSerStruct (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrSerData structure from the stream.
fr_sim_event_type	ReadFrSimEvent (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrSimEvent structure from the stream.
fr_sim_event_type	ReadFrSimEvent (const std::string &SimEventType, fr_sim_event_offset_type Offset)
	Extract the requested FrSimEvent structure from the stream.
fr_sim_event_type	ReadFrSimEventStruct (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrSimEvent structure from the stream.
fr_sim_data_type	ReadFrSimStruct (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrSerData structure from the stream.
fr_sim_data_type	ReadFrSimData (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrSerData structure from the stream.
frame_h_type	ReadNextFrame ()
	Extract the next FrameH structure from the stream.
	IFrameStreamWrapper (buffer_type *Buffer)
	Constructor.
	IFrameStreamWrapper (bool AutoDelete, buffer_type *Buffer)
	Constructor.
frame_h_type	ReadFrameH (frame_offset_type Frame, INT_4U ContainerSet)
	Extract the requested FrameH structure from the stream.
fr_adc_data_type	ReadFrAdcData (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrAdcData structure from the stream.
fr_adc_data_type	ReadFrAdcData (frame_offset_type Frame, INT_4U Channel)
	Extract the requested FrAdcData structure from the stream.
fr_adc_data_type	ReadFrAdcStruct (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrAdcData structure from the stream.
fr_adc_data_type	ReadFrAdcStruct (frame_offset_type Frame, INT_4U Channel)
	Extract the requested FrAdcData structure from the stream.
fr_event_type	ReadFrEvent (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrEvent structure from the stream.
fr_event_type	ReadFrEvent (const std::string &EventType, fr_event_offset_type Offset)
	Extract the requested FrEvent structure from the stream.
fr_event_type	ReadFrEventStruct (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrEvent structure from the stream.
fr_proc_data_type	ReadFrProcData (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrProcData structure from the stream.
fr_proc_data_type	ReadFrProcData (frame_offset_type Frame, INT_4U Channel)
	Extract the requested FrProcData structure from the stream.
fr_proc_data_type	ReadFrProcStruct (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrProcData structure from the stream.
fr_proc_data_type	ReadFrProcStruct (frame_offset_type Frame, INT_4U Channel)
	Extract the requested FrProcData structure from the stream.
fr_raw_data_type	ReadFrRawData (frame_offset_type Frame)
	Extract the requested FrRawData structure from the stream.
fr_ser_data_type	ReadFrSerData (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrSerData structure from the stream.
fr_ser_data_type	ReadFrSerStruct (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrSerData structure from the stream.
fr_sim_event_type	ReadFrSimEvent (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrSimEvent structure from the stream.
fr_sim_event_type	ReadFrSimEvent (const std::string &SimEventType, fr_sim_event_offset_type Offset)
	Extract the requested FrSimEvent structure from the stream.
fr_sim_event_type	ReadFrSimEventStruct (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrSimEvent structure from the stream.
fr_sim_data_type	ReadFrSimStruct (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrSerData structure from the stream.
fr_sim_data_type	ReadFrSimData (frame_offset_type Frame, const std::string &Channel)
	Extract the requested FrSerData structure from the stream.
frame_h_type	ReadNextFrame ()
	Extract the next FrameH structure from the stream.
size_type	GetCurrentFrameOffset () const
	Retrieve the current frame.
size_type	GetCurrentFrameOffset () const
	Retrieve the current frame.
object_type	Read ()
object_type	ReadDetector (const std::string &Name)
	Read the detector via the table of contents.
object_type	ReadDetector (const std::string &Name)
	Read the detector via the table of contents.
IFrameStream::object_type	ReadFrStatData (INT_8U Position)
	Read FrStatData at a given postion in the stream.
IFrameStream::object_type	ReadFrStatData (INT_8U Position)
	Read FrStatData at a given postion in the stream.
ptr_struct_base_type	ReadPtrStruct ()
void	Resolve ()
	Method to resolve links.
cmn_streamsize_type	Size ()
	Return the size of the stream.
cmn_streamsize_type	Size ()
	Return the size of the stream.

Protected Member Functions
object_type	readObject (const StreamRefInterface *StreamRef)
	Read an Object referenced in the stream.
object_type	readObject (const StreamRefInterface *StreamRef)
	Read an Object referenced in the stream.
object_type	morph (object_type Obj)
	Modify an object so it is appropriate for the stream.
object_type	morph (object_type Obj)
	Modify an object so it is appropriate for the stream.

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::IFrameStreamWrapper< DECL >

Wrapper to properly cast return values into the namespace associated with the frame specification namespace.

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.

◆ morph() [1/2]

FrameStream::object_type FrameStream::morph ( object_type Obj )

protectedinherited

Modify an object so it is appropriate for the stream.

Parameters

[in] Obj The object that should be transformed.

Returns: A pointer to the object appropriately converted. If no conversion was necessary, the same pointer is returned.

◆ morph() [2/2]

object_type FrameCPP::Common::FrameStream::morph ( object_type Obj )

protectedinherited

Modify an object so it is appropriate for the stream.

Parameters

[in] Obj The object that should be transformed.

Returns: A pointer to the object appropriately converted. If no conversion was necessary, the same pointer 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] Name The 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] Name The 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/4]

template<DECL>

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

Extract the requested FrAdcData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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() [2/4]

template<DECL>

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

Extract the requested FrAdcData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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() [3/4]

template<DECL>

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

Extract the requested FrAdcData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Zero 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() [4/4]

template<DECL>

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

Extract the requested FrAdcData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Zero 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]

template<DECL>

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

Extract the requested FrAdcData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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]

template<DECL>

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

Extract the requested FrAdcData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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]

template<DECL>

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

Extract the requested FrAdcData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Zero 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]

template<DECL>

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

Extract the requested FrAdcData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Zero 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]

template<DECL>

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

Extract the requested FrameH structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	ContainerSet	Bit 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]

template<DECL>

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

Extract the requested FrameH structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	ContainerSet	Bit map of components to included.

Returns: Upon successful completion, the address of the FrameH structure linked with all requested subcomponents by ContainerSet.

◆ ReadFrEvent() [1/4]

template<DECL>

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

Extract the requested FrEvent structure from the stream.

Parameters

[in]	EventType	Name of the event being requested.
[in]	Offset	Index 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() [2/4]

template<DECL>

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

Extract the requested FrEvent structure from the stream.

Parameters

[in]	EventType	Name of the event being requested.
[in]	Offset	Index 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() [3/4]

template<DECL>

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

Extract the requested FrEvent structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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() [4/4]

template<DECL>

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

Extract the requested FrEvent structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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]

template<DECL>

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

Extract the requested FrEvent structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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]

template<DECL>

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

Extract the requested FrEvent structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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>

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

Extract the requested FrProcData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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::IFrameStreamWrapper< DECL >::ReadFrProcData	(	frame_offset_type	Frame,
		const std::string &	Channel )

Extract the requested FrProcData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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]

template<DECL>

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

Extract the requested FrProcData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Zero 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

◆ ReadFrProcData() [4/4]

template<DECL>

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

Extract the requested FrProcData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Zero 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]

template<DECL>

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

Extract the requested FrProcData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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]

template<DECL>

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

Extract the requested FrProcData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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]

template<DECL>

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

Extract the requested FrProcData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Zero 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]

template<DECL>

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

Extract the requested FrProcData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Zero 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]

template<DECL>

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

Extract the requested FrRawData structure from the stream.

Parameters

[in] Frame Zero 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]

template<DECL>

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

Extract the requested FrRawData structure from the stream.

Parameters

[in] Frame Zero 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/2]

template<DECL>

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

Extract the requested FrSerData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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/2]

template<DECL>

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

Extract the requested FrSerData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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]

template<DECL>

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

Extract the requested FrSerData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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]

template<DECL>

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

Extract the requested FrSerData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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/2]

template<DECL>

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

Extract the requested FrSerData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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/2]

template<DECL>

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

Extract the requested FrSerData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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/4]

template<DECL>

IFrameStreamWrapper< DECL_PARAMS >::fr_sim_event_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrSimEvent	(	const std::string &	SimEventType,
		fr_sim_event_offset_type	Offset )

Extract the requested FrSimEvent structure from the stream.

Parameters

[in]	SimEventType	Name of the simulated event being requested.
[in]	Offset	Index into the Event array for the Event type

Returns: Upon success, a non-NULL pointer to the FrSimEvent is returned. Upon failure, either an exception is thrown

◆ ReadFrSimEvent() [2/4]

template<DECL>

fr_sim_event_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrSimEvent	(	const std::string &	SimEventType,
		fr_sim_event_offset_type	Offset )

Extract the requested FrSimEvent structure from the stream.

Parameters

[in]	SimEventType	Name of the simulated event being requested.
[in]	Offset	Index into the Event array for the Event type

Returns: Upon success, a non-NULL pointer to the FrSimEvent is returned. Upon failure, either an exception is thrown

◆ ReadFrSimEvent() [3/4]

template<DECL>

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

Extract the requested FrSimEvent structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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() [4/4]

template<DECL>

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

Extract the requested FrSimEvent structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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]

template<DECL>

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

Extract the requested FrSimEvent structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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]

template<DECL>

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

Extract the requested FrSimEvent structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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]

template<DECL>

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

Extract the requested FrSerData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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]

template<DECL>

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

Extract the requested FrSerData structure from the stream.

Parameters

[in]	Frame	Zero based index of the frame.
[in]	Channel	Name 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 IFrameStream::ReadFrStatData ( INT_8U Position )

inherited

Read FrStatData at a given postion in the stream.

Parameters

Position Offset 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.

◆ ReadFrStatData() [2/2]

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

inherited

Read FrStatData at a given postion in the stream.

Parameters

Position Offset of the FrStatData in the stream

◆ ReadNextFrame() [1/2]

template<DECL>

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

Extract the next FrameH structure from the stream.

Returns: Upon success, a pointer to a FrameH structure.

◆ ReadNextFrame() [2/2]

template<DECL>

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

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

StreamRef Stream 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

StreamRef Stream reference information for the requested object.

◆ ReadPtrStruct()

IStream::ptr_struct_base_type 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 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 files:

/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Common/FrameStreamWrapper.hh
/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Common/FrameStreamWrapper.hh

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ GetCurrentFrameOffset() [1/2]

◆ GetCurrentFrameOffset() [2/2]

◆ morph() [1/2]

◆ morph() [2/2]

◆ Read()

◆ ReadDetector() [1/2]

◆ ReadDetector() [2/2]

◆ ReadFrAdcData() [1/4]

◆ ReadFrAdcData() [2/4]

◆ ReadFrAdcData() [3/4]

◆ ReadFrAdcData() [4/4]

◆ ReadFrAdcStruct() [1/4]

◆ ReadFrAdcStruct() [2/4]

◆ ReadFrAdcStruct() [3/4]

◆ ReadFrAdcStruct() [4/4]

◆ ReadFrameH() [1/2]

◆ ReadFrameH() [2/2]

◆ ReadFrEvent() [1/4]

◆ ReadFrEvent() [2/4]

◆ ReadFrEvent() [3/4]

◆ ReadFrEvent() [4/4]

◆ ReadFrEventStruct() [1/2]

◆ ReadFrEventStruct() [2/2]

◆ ReadFrProcData() [1/4]

◆ ReadFrProcData() [2/4]

◆ ReadFrProcData() [3/4]

◆ ReadFrProcData() [4/4]

◆ ReadFrProcStruct() [1/4]

◆ ReadFrProcStruct() [2/4]

◆ ReadFrProcStruct() [3/4]

◆ ReadFrProcStruct() [4/4]

◆ ReadFrRawData() [1/2]

◆ ReadFrRawData() [2/2]

◆ ReadFrSerData() [1/2]

◆ ReadFrSerData() [2/2]

◆ ReadFrSerStruct() [1/2]

◆ ReadFrSerStruct() [2/2]

◆ ReadFrSimData() [1/2]

◆ ReadFrSimData() [2/2]

◆ ReadFrSimEvent() [1/4]

◆ ReadFrSimEvent() [2/4]

◆ ReadFrSimEvent() [3/4]

◆ ReadFrSimEvent() [4/4]

◆ ReadFrSimEventStruct() [1/2]

◆ ReadFrSimEventStruct() [2/2]

◆ ReadFrSimStruct() [1/2]

◆ ReadFrSimStruct() [2/2]

◆ ReadFrStatData() [1/2]

◆ ReadFrStatData() [2/2]

◆ ReadNextFrame() [1/2]

◆ ReadNextFrame() [2/2]

◆ readObject() [1/2]

◆ readObject() [2/2]

◆ ReadPtrStruct()

◆ Size() [1/2]

◆ Size() [2/2]