Inheritance diagram for IFrameStream:

Collaboration diagram for IFrameStream:

Public Types
typedef IStream::buffer_type	buffer_type

typedef IStream::buffer_type	buffer_type

typedef INT_4U	size_type

typedef INT_4U	size_type

typedef FrHeader::frame_library_type	frame_library_type

typedef FrHeader::frame_library_type	frame_library_type

typedef FrHeader::library_revision_type	library_revision_type

typedef FrHeader::library_revision_type	library_revision_type

typedef FrameSpec::version_type	version_type

typedef FrameSpec::version_type	version_type

typedef const StreamRefInterface *	streamref_interface_type

typedef const StreamRefInterface *	streamref_interface_type

typedef INT_4U	fr_event_offset_type

typedef INT_4U	fr_event_offset_type

typedef INT_4U	fr_sim_event_offset_type

typedef INT_4U	fr_sim_event_offset_type

typedef boost::shared_ptr< FrameSpec::Object >	object_type

typedef boost::shared_ptr< FrameSpec::Object >	object_type

typedef boost::shared_ptr< FrameSpec::Object >	object_type

typedef boost::shared_ptr< FrameSpec::Object >	object_type

Public Member Functions
	IFrameStream (buffer_type *Stream, INT_2U Version=FRAME_SPEC_CURRENT)

virtual void	Cleanup ()

virtual void	Cleanup ()

size_type	GetCurrentFrameOffset () const
	Retrieve the current frame. More...

size_type	GetCurrentFrameOffset () const
	Retrieve the current frame. More...

virtual const FrHeader &	GetFrHeader () const

virtual const FrHeader &	GetFrHeader () const

const FrTOC *	GetTOC () const

const FrTOC *	GetTOC () const

size_type	GetNumberOfFrames () const

size_type	GetNumberOfFrames () const

FrameSpec::Info::verification_func_type	VerificationFunc () const

FrameSpec::Info::verification_func_type	VerificationFunc () const

object_type	Read ()

object_type	Read ()

object_type	ReadNextFrameAsObject ()

object_type	ReadNextFrameAsObject ()

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

object_type	ReadFrame (bool Decompress=false)

object_type	ReadFrame (bool Decompress=false)

object_type	ReadFrameN (INT_4U FrameIndex, bool Decompress=false)

object_type	ReadFrameN (INT_4U FrameIndex, bool Decompress=false)

object_type	ReadFrameNSubset (INT_4U FrameIndex, INT_4U ElementMask)

object_type	ReadFrameNSubset (INT_4U FrameIndex, INT_4U ElementMask)

IFrameStream::object_type	ReadFrStatData (INT_8U Position)
	Read FrStatData at a given postion in the stream. More...

INT_4U	ReadFrStatData (const std::string &NamePattern, const std::string &DetectorPattern, const LDASTools::AL::GPSTime &StartTime, const LDASTools::AL::GPSTime &EndTime, const INT_4U Version, FrStatData::Query &QueryResults)

IFrameStream::object_type	ReadFrStatData (INT_8U Position)
	Read FrStatData at a given postion in the stream. More...

INT_4U	ReadFrStatData (const std::string &NamePattern, const std::string &DetectorPattern, const LDASTools::AL::GPSTime &StartTime, const LDASTools::AL::GPSTime &EndTime, const INT_4U Version, FrStatData::Query &QueryResults)

void	SetAutoDeleteBuffer (const bool AutoDelete)

void	SetAutoDeleteBuffer (const bool AutoDelete)

void	SetCheckSumFile (const CheckSum::kind_type Type)

void	SetCheckSumFile (const CheckSum::kind_type Type)

void	SetMD5Sum (bool Value)

void	SetMD5Sum (bool Value)

void	VerifyHeader (Verify &Verifier)

void	VerifyHeader (Verify &Verifier)

CheckSumFilter *	GetCheckSumFile () const

CheckSumFilter *	GetCheckSumFile () const

CheckSumFilter *	GetCheckSumFile () const

CheckSumFilter *	GetCheckSumFile () const

CheckSumFilter *	GetCheckSumFrame () const

CheckSumFilter *	GetCheckSumFrame () const

CheckSumFilter *	GetCheckSumFrame () const

CheckSumFilter *	GetCheckSumFrame () const

CheckSumFilter *	GetCheckSumObject () const

CheckSumFilter *	GetCheckSumObject () const

CheckSumFilter *	GetCheckSumObject () const

CheckSumFilter *	GetCheckSumObject () const

void	SetCheckSumFrame (const CheckSum::kind_type Type)

void	SetCheckSumFrame (const CheckSum::kind_type Type)

void	SetCheckSumFrame (const CheckSum::kind_type Type)

void	SetCheckSumFrame (const CheckSum::kind_type Type)

void	SetCheckSumObject (const CheckSum::kind_type Type)

void	SetCheckSumObject (const CheckSum::kind_type Type)

void	SetCheckSumObject (const CheckSum::kind_type Type)

void	SetCheckSumObject (const CheckSum::kind_type Type)

frame_library_type	FrameLibrary () const

frame_library_type	FrameLibrary () const

library_revision_type	LibraryRevision () const

library_revision_type	LibraryRevision () const

version_type	Version () const

version_type	Version () const

const std::string &	GetLastError () const

const std::string &	GetLastError () const

const MD5Sum &	GetMD5Sum () const

const MD5Sum &	GetMD5Sum () const

Protected Types
typedef boost::shared_ptr< FrTOC >	toc_type

typedef boost::shared_ptr< FrTOC >	toc_type

typedef const Dictionary::streamref_type::element_type *	const_stream_ref_ptr_type

typedef const Dictionary::streamref_type::element_type *	const_stream_ref_ptr_type

typedef Dictionary::streamref_type	streamref_type

typedef Dictionary::streamref_type	streamref_type

typedef std::unique_ptr< CheckSumFilter >	checksum_filter_type

typedef std::unique_ptr< CheckSumFilter >	checksum_filter_type

typedef std::unique_ptr< MD5SumFilter >	md5sum_filter_type

typedef std::unique_ptr< MD5SumFilter >	md5sum_filter_type

typedef LDASTools::AL::unordered_map< INT_2U, INT_2U >	streamid_to_fsiid_type

typedef LDASTools::AL::unordered_map< INT_2U, INT_2U >	streamid_to_fsiid_type

typedef boost::shared_ptr< PTR_STRUCT_BASE >	ptr_struct_base_type

typedef boost::shared_ptr< PTR_STRUCT_BASE >	ptr_struct_base_type

typedef std::istream::char_type	char_type

typedef std::istream::char_type	char_type

typedef std::istream	istream_type

typedef std::istream	istream_type

typedef boost::shared_ptr< resolver >	resolver_type

typedef boost::shared_ptr< resolver >	resolver_type

typedef std::list< resolver_type >	resolver_container_type

typedef std::list< resolver_type >	resolver_container_type

Protected Member Functions
virtual ptr_struct_base_type	Next (object_type::element_type *Obj)

virtual ptr_struct_base_type	Next (object_type::element_type *Obj)

virtual ptr_struct_base_type	Next (object_type Obj)

virtual ptr_struct_base_type	Next (object_type::element_type *Obj)

virtual ptr_struct_base_type	Next (object_type Obj)

virtual ptr_struct_base_type	Next (object_type::element_type *Obj)

virtual ptr_struct_base_type	Next (object_type Obj)

virtual ptr_struct_base_type	Next (object_type::element_type *Obj)

virtual ptr_struct_base_type	Next (object_type Obj)

virtual ptr_struct_base_type	Next (object_type::element_type *Obj)

virtual ptr_struct_base_type	Next (object_type Obj)

object_type	advanceToFrame (INT_4U Frame)

object_type	advanceToFrame (INT_4U Frame)

object_type	readFrameHSubset (INT_4U Frame, INT_4U ElementMask)

object_type	readFrameHSubset (INT_4U Frame, INT_4U ElementMask)

object_type	readFrAdcData (INT_4U Frame, const std::string &Channel)

object_type	readFrAdcData (INT_4U Frame, INT_4U Channel)

object_type	readFrAdcData (INT_4U Frame, const std::string &Channel)

object_type	readFrAdcData (INT_4U Frame, INT_4U Channel)

object_type	readFrAdcStruct (INT_4U Frame, const std::string &Channel)

object_type	readFrAdcStruct (INT_4U Frame, INT_4U Channel)

object_type	readFrAdcStruct (INT_4U Frame, const std::string &Channel)

object_type	readFrAdcStruct (INT_4U Frame, INT_4U Channel)

object_type	readFrEvent (INT_4U Frame, const std::string &Channel)

object_type	readFrEvent (const std::string &EventType, fr_event_offset_type Offset)

object_type	readFrEvent (INT_4U Frame, const std::string &Channel)

object_type	readFrEvent (const std::string &EventType, fr_event_offset_type Offset)

std::unique_ptr< FrEndOfFile >	readFrEndOfFile ()

std::unique_ptr< FrEndOfFile >	readFrEndOfFile ()

object_type	readFrEventStruct (INT_4U Frame, const std::string &Channel)

object_type	readFrEventStruct (INT_4U Frame, const std::string &Channel)

object_type	readFrProcData (INT_4U Frame, const std::string &Channel)

object_type	readFrProcData (INT_4U Frame, INT_4U Channel)

object_type	readFrProcData (INT_4U Frame, const std::string &Channel)

object_type	readFrProcData (INT_4U Frame, INT_4U Channel)

object_type	readFrProcStruct (INT_4U Frame, const std::string &Channel)

object_type	readFrProcStruct (INT_4U Frame, INT_4U Channel)

object_type	readFrProcStruct (INT_4U Frame, const std::string &Channel)

object_type	readFrProcStruct (INT_4U Frame, INT_4U Channel)

object_type	readFrRawData (INT_4U Frame)

object_type	readFrRawData (INT_4U Frame)

object_type	readFrSerData (INT_4U Frame, const std::string &Channel)

object_type	readFrSerData (INT_4U Frame, const std::string &Channel)

object_type	readFrSerStruct (INT_4U Frame, const std::string &Channel)

object_type	readFrSerStruct (INT_4U Frame, const std::string &Channel)

object_type	readFrSimData (INT_4U Frame, const std::string &Channel)

object_type	readFrSimData (INT_4U Frame, const std::string &Channel)

object_type	readFrSimStruct (INT_4U Frame, const std::string &Channel)

object_type	readFrSimStruct (INT_4U Frame, const std::string &Channel)

object_type	readFrSimEvent (INT_4U Frame, const std::string &Channel)

object_type	readFrSimEvent (const std::string &SimEventType, fr_sim_event_offset_type Offset)

object_type	readFrSimEvent (INT_4U Frame, const std::string &Channel)

object_type	readFrSimEvent (const std::string &SimEventType, fr_sim_event_offset_type Offset)

object_type	readFrSimEventStruct (INT_4U Frame, const std::string &Channel)

object_type	readFrSimEventStruct (INT_4U Frame, const std::string &Channel)

std::unique_ptr< FrTOC >	readFrTOCHeader (FrEndOfFile::seekTOC_cmn_type Offset)

std::unique_ptr< FrTOC >	readFrTOCHeader (FrEndOfFile::seekTOC_cmn_type Offset)

object_type	readNextFrame ()

object_type	readNextFrame ()

boost::shared_ptr< StreamRefInterface >	readStreamRef ()

boost::shared_ptr< StreamRefInterface >	readStreamRef ()

void	readTOC ()

void	readTOC ()

virtual void	reset ()

virtual void	reset ()

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

void	readRecursive (INT_4U StopOnClassId, bool Decompress=false)

void	readRecursive (INT_4U StopOnClassId, bool Decompress=false)

bool	removeRecursiveDependant (const StreamRefInterface *StreamRef)

bool	removeRecursiveDependant (const StreamRefInterface *StreamRef)

virtual void	addRecursiveDependant (ptr_struct_base_type Ref)

void	addRecursiveDependant (const StreamRefInterface *StreamRef)

virtual void	addRecursiveDependant (ptr_struct_base_type Ref)

void	addRecursiveDependant (const StreamRefInterface *StreamRef)

toc_type	getTOC () const

toc_type	getTOC () const

virtual void	pushResolver (resolver_type Resolver)

virtual void	pushResolver (resolver_type Resolver)

void	seedTOCInfo (const IFrameStream &Source)

void	seedTOCInfo (const IFrameStream &Source)

CheckSumFilter *	GetCheckSumFile () const

CheckSumFilter *	GetCheckSumFrame () const

CheckSumFilter *	GetCheckSumObject () const

void	SetCheckSumFrame (const CheckSum::kind_type Type)

void	SetCheckSumObject (const CheckSum::kind_type Type)

virtual void	frameSpecInfo (const FrameSpec::Info *Spec)

virtual void	frameSpecInfo (const FrameSpec::Info *Spec)

const FrameSpec::Info &	frameSpecInfo () const

virtual void	frameSpecInfo (const FrameSpec::Info *Spec)

const FrameSpec::Info &	frameSpecInfo () const

virtual void	frameSpecInfo (const FrameSpec::Info *Spec)

const FrameSpec::Info &	frameSpecInfo () const

virtual void	frameSpecInfo (const FrameSpec::Info *Spec)

const FrameSpec::Info &	frameSpecInfo () const

virtual void	frameSpecInfo (const FrameSpec::Info *Spec)

const FrameSpec::Info &	frameSpecInfo () const

void	setLastError (const std::string &Message)

void	setLastError (const std::string &Message)

void	setTOC ()

void	setTOC ()

const StreamRefInterface &	streamRef () const

const StreamRefInterface &	streamRef () const

void	version_stream (version_type Version)

void	version_stream (version_type Version)

void	frameLibrary (frame_library_type FrameLibrary)

void	frameLibrary (frame_library_type FrameLibrary)

void	libraryRevision (library_revision_type LibraryRevision)

void	libraryRevision (library_revision_type LibraryRevision)

version_type	memoryVersion () const

version_type	memoryVersion () const

version_type	streamVersion () const

version_type	streamVersion () const

INT_2U	GetClassId (const std::string &ClassName) const

INT_2U	GetClassId (const std::string &ClassName) const

INT_2U	GetFSIId (INT_2U StreamId) const

INT_2U	GetFSIId (INT_2U StreamId) const

cmn_streamsize_type	PtrStructBytes () const

cmn_streamsize_type	PtrStructBytes () const

const_stream_ref_ptr_type	ReferenceStreamRef () const

const_stream_ref_ptr_type	ReferenceStreamRef () const

const Dictionary &	GetDictionary () const

Dictionary &	GetDictionary ()

const Dictionary &	GetDictionary () const

Dictionary &	GetDictionary ()

Dictionary::ptr_struct_key_type	NextLookup (object_type Obj) const

Dictionary::ptr_struct_key_type	NextLookup (object_type Obj) const

void	RemoveResolver (const void *Old, int MaxDepth)

void	RemoveResolver (const void *Old, int MaxDepth)

template<typename T >
void	PushPtr (boost::shared_ptr< T > *Obj)

template<typename T >
void	PushPtr (boost::shared_ptr< T > *Obj)

template<typename T_NEW , typename T_OLD >
void	ReplacePtr (boost::shared_ptr< T_NEW > Obj, boost::shared_ptr< T_OLD > OldPtr, const int MaxDepth)

template<typename T_NEW , typename T_OLD >
void	ReplacePtr (boost::shared_ptr< T_NEW > Obj, boost::shared_ptr< T_OLD > OldPtr, const int MaxDepth)

template<typename T >
void	PushRef (Container< T > &C)

template<typename T >
void	PushRef (Container< T > &C)

template<typename T , typename OT >
void	ReplaceRef (Container< T > &C, const Container< OT > &Old, const int MaxDepth)

template<typename T , typename OT >
void	ReplaceRef (Container< T > &C, const Container< OT > &Old, const int MaxDepth)

FrameBufferInterface *	rdbuf () const

FrameBufferInterface *	rdbuf () const

IStream &	read (char_type *S, std::streamsize N)

IStream &	read (char_type *S, std::streamsize N)

ptr_struct_base_type	ReadPtrStruct ()

ptr_struct_base_type	ReadPtrStruct ()

void	Resolve ()
	Method to resolve links. More...

void	Resolve ()

cmn_streamsize_type	Size ()
	Return the size of the stream. More...

cmn_streamsize_type	Size ()
	Return the size of the stream. More...

template<typename T >
IStream &	operator>> (boost::shared_ptr< T > *Data)

template<typename T , const std::string &(T::*)() const F>
IStream &	operator>> (SearchContainer< T, F > &SC)

template<typename T >
IStream &	operator>> (Container< T > &C)

template<typename L >
IStream &	operator>> (STRING< L > &String)

template<typename L >
IStream &	operator>> (STRING_SHADOW< L > &String)

template<typename L >
IStream &	operator>> (std::vector< STRING< L > > &String)

template<typename DT >
IStream &	operator>> (std::vector< DT > &Data)

template<typename DT >
IStream &	operator>> (DT &Data)

template<typename T , typename S >
IStream &	operator>> (IStream::Resizer< T, S > Value)

template<typename T >
IStream &	operator>> (boost::shared_ptr< T > *Data)

template<typename T , const std::string &(T::*)() const F>
IStream &	operator>> (SearchContainer< T, F > &SC)

template<typename T >
IStream &	operator>> (Container< T > &C)

template<typename L >
IStream &	operator>> (STRING< L > &String)

template<typename L >
IStream &	operator>> (STRING_SHADOW< L > &String)

template<typename L >
IStream &	operator>> (std::vector< STRING< L > > &String)

template<typename DT >
IStream &	operator>> (std::vector< DT > &Data)

template<typename DT >
IStream &	operator>> (DT &Data)

template<typename T , typename S >
IStream &	operator>> (IStream::Resizer< T, S > Value)

template<>
IStream &	operator>> (LDASTools::AL::GPSTime &Data)

bool	ByteSwapping () const

bool	ByteSwapping () const

void	nextReplace (object_type OldObj, object_type NewObj)

void	nextReplace (object_type OldObj, object_type NewObj)

void	byteSwapping (bool Value)

void	byteSwapping (bool Value)

object_type	objectLookup (object_type::element_type *Pointer)

object_type	objectLookup (object_type::element_type *Pointer)

const resolver_container_type &	resolverContainer () const

resolver_container_type &	resolverContainer ()

const resolver_container_type &	resolverContainer () const

resolver_container_type &	resolverContainer ()

void	setAutoDeleteBuffer (const bool Value)

void	setAutoDeleteBuffer (const bool Value)

Protected Attributes
bool	m_closed_state

std::unique_ptr< MD5SumFilter >	m_md5sumFilter

Dictionary	m_dictionary

object_type	m_null_stream_ref

ptr_struct_base_type	m_ptr_struct_object

streamid_to_fsiid_type	m_stream_id_to_fsi_id

checksum_filter_type	m_file_checksum
	Checksum for file. More...

checksum_filter_type	m_frame_checksum
	Checksum for frame. More...

checksum_filter_type	m_obj_checksum
	Checksum for object. More...

md5sum_filter_type	m_file_md5sum
	MD5Sum value for the files. More...

bool	m_logNextPtr

Member Typedef Documentation

◆ buffer_type [1/2]

typedef IStream::buffer_type FrameCPP::Common::IFrameStream::buffer_type

inherited

◆ buffer_type [2/2]

typedef IStream::buffer_type FrameCPP::Common::IFrameStream::buffer_type

inherited

◆ char_type [1/2]

typedef std::istream::char_type FrameCPP::Common::IStream::char_type

inherited

◆ char_type [2/2]

typedef std::istream::char_type FrameCPP::Common::IStream::char_type

inherited

◆ checksum_filter_type [1/2]

typedef std::unique_ptr< CheckSumFilter > FrameCPP::Common::StreamBase::checksum_filter_type

protectedinherited

◆ checksum_filter_type [2/2]

typedef std::unique_ptr< CheckSumFilter > FrameCPP::Common::StreamBase::checksum_filter_type

protectedinherited

◆ const_stream_ref_ptr_type [1/2]

typedef const Dictionary::streamref_type::element_type* FrameCPP::Common::StreamBase::const_stream_ref_ptr_type

inherited

◆ const_stream_ref_ptr_type [2/2]

typedef const Dictionary::streamref_type::element_type* FrameCPP::Common::StreamBase::const_stream_ref_ptr_type

inherited

◆ fr_event_offset_type [1/2]

typedef INT_4U FrameCPP::Common::FrameStream::fr_event_offset_type

inherited

◆ fr_event_offset_type [2/2]

typedef INT_4U FrameCPP::Common::FrameStream::fr_event_offset_type

inherited

◆ fr_sim_event_offset_type [1/2]

typedef INT_4U FrameCPP::Common::FrameStream::fr_sim_event_offset_type

inherited

◆ fr_sim_event_offset_type [2/2]

typedef INT_4U FrameCPP::Common::FrameStream::fr_sim_event_offset_type

inherited

◆ frame_library_type [1/2]

typedef FrHeader::frame_library_type FrameCPP::Common::FrameStream::frame_library_type

inherited

◆ frame_library_type [2/2]

typedef FrHeader::frame_library_type FrameCPP::Common::FrameStream::frame_library_type

inherited

◆ istream_type [1/2]

typedef std::istream FrameCPP::Common::IStream::istream_type

inherited

◆ istream_type [2/2]

typedef std::istream FrameCPP::Common::IStream::istream_type

inherited

◆ library_revision_type [1/2]

typedef FrHeader::library_revision_type FrameCPP::Common::FrameStream::library_revision_type

inherited

◆ library_revision_type [2/2]

typedef FrHeader::library_revision_type FrameCPP::Common::FrameStream::library_revision_type

inherited

◆ md5sum_filter_type [1/2]

typedef std::unique_ptr< MD5SumFilter > FrameCPP::Common::StreamBase::md5sum_filter_type

protectedinherited

◆ md5sum_filter_type [2/2]

typedef std::unique_ptr< MD5SumFilter > FrameCPP::Common::StreamBase::md5sum_filter_type

protectedinherited

◆ object_type [1/4]

typedef boost::shared_ptr< FrameSpec::Object > FrameCPP::Common::StreamBase::object_type

inherited

◆ object_type [2/4]

typedef boost::shared_ptr< FrameSpec::Object > FrameCPP::Common::StreamBase::object_type

inherited

◆ object_type [3/4]

typedef boost::shared_ptr< FrameSpec::Object > FrameCPP::Common::StreamBase::object_type

inherited

◆ object_type [4/4]

typedef boost::shared_ptr< FrameSpec::Object > FrameCPP::Common::StreamBase::object_type

inherited

◆ ptr_struct_base_type [1/2]

typedef boost::shared_ptr< PTR_STRUCT_BASE > FrameCPP::Common::StreamBase::ptr_struct_base_type

protectedinherited

◆ ptr_struct_base_type [2/2]

typedef boost::shared_ptr< PTR_STRUCT_BASE > FrameCPP::Common::StreamBase::ptr_struct_base_type

protectedinherited

◆ resolver_container_type [1/2]

typedef std::list< resolver_type > FrameCPP::Common::IStream::resolver_container_type

protectedinherited

◆ resolver_container_type [2/2]

typedef std::list< resolver_type > FrameCPP::Common::IStream::resolver_container_type

protectedinherited

◆ resolver_type [1/2]

typedef boost::shared_ptr< resolver > FrameCPP::Common::IStream::resolver_type

protectedinherited

◆ resolver_type [2/2]

typedef boost::shared_ptr< resolver > FrameCPP::Common::IStream::resolver_type

protectedinherited

◆ size_type [1/2]

typedef INT_4U FrameCPP::Common::IFrameStream::size_type

inherited

◆ size_type [2/2]

typedef INT_4U FrameCPP::Common::IFrameStream::size_type

inherited

◆ streamid_to_fsiid_type [1/2]

typedef LDASTools::AL::unordered_map< INT_2U, INT_2U > FrameCPP::Common::StreamBase::streamid_to_fsiid_type

protectedinherited

◆ streamid_to_fsiid_type [2/2]

typedef LDASTools::AL::unordered_map< INT_2U, INT_2U > FrameCPP::Common::StreamBase::streamid_to_fsiid_type

protectedinherited

◆ streamref_interface_type [1/2]

typedef const StreamRefInterface* FrameCPP::Common::FrameStream::streamref_interface_type

inherited

◆ streamref_interface_type [2/2]

typedef const StreamRefInterface* FrameCPP::Common::FrameStream::streamref_interface_type

inherited

◆ streamref_type [1/2]

typedef Dictionary::streamref_type FrameCPP::Common::StreamBase::streamref_type

inherited

◆ streamref_type [2/2]

typedef Dictionary::streamref_type FrameCPP::Common::StreamBase::streamref_type

inherited

◆ toc_type [1/2]

typedef boost::shared_ptr< FrTOC > FrameCPP::Common::IFrameStream::toc_type

protectedinherited

◆ toc_type [2/2]

typedef boost::shared_ptr< FrTOC > FrameCPP::Common::IFrameStream::toc_type

protectedinherited

◆ version_type [1/2]

typedef FrameSpec::version_type FrameCPP::Common::FrameStream::version_type

inherited

◆ version_type [2/2]

typedef FrameSpec::version_type FrameCPP::Common::FrameStream::version_type

inherited

Constructor & Destructor Documentation

◆ IFrameStream()

IFrameStream::IFrameStream	(	buffer_type *	Stream,
		INT_2U	Version = `FRAME_SPEC_CURRENT`
	)

inline

Member Function Documentation

◆ addRecursiveDependant() [1/4]

void IFrameStream::addRecursiveDependant ( ptr_struct_base_type Ref )

protectedvirtualinherited

◆ addRecursiveDependant() [2/4]

virtual void FrameCPP::Common::IFrameStream::addRecursiveDependant ( ptr_struct_base_type Ref )

protectedvirtualinherited

◆ addRecursiveDependant() [3/4]

void IFrameStream::addRecursiveDependant ( const StreamRefInterface * StreamRef )

protectedinherited

◆ addRecursiveDependant() [4/4]

void FrameCPP::Common::IFrameStream::addRecursiveDependant ( const StreamRefInterface * StreamRef )

protectedinherited

◆ advanceToFrame() [1/2]

IFrameStream::object_type IFrameStream::advanceToFrame ( INT_4U Frame )

protectedinherited

◆ advanceToFrame() [2/2]

object_type FrameCPP::Common::IFrameStream::advanceToFrame ( INT_4U Frame )

protectedinherited

◆ ByteSwapping() [1/2]

bool FrameCPP::Common::IStream::ByteSwapping ( ) const

inlineinherited

◆ ByteSwapping() [2/2]

bool FrameCPP::Common::IStream::ByteSwapping ( ) const

inherited

◆ byteSwapping() [1/2]

void FrameCPP::Common::IStream::byteSwapping ( bool Value )

inlineprotectedinherited

◆ byteSwapping() [2/2]

void FrameCPP::Common::IStream::byteSwapping ( bool Value )

protectedinherited

◆ Cleanup() [1/2]

virtual void FrameCPP::Common::IFrameStream::Cleanup ( )

virtualinherited

Reimplemented from FrameCPP::Common::IStream.

◆ Cleanup() [2/2]

void IFrameStream::Cleanup ( )

virtualinherited

Reimplemented from FrameCPP::Common::IStream.

◆ FrameLibrary() [1/2]

FrameStream::frame_library_type FrameStream::FrameLibrary ( ) const

inlineinherited

◆ FrameLibrary() [2/2]

frame_library_type FrameCPP::Common::FrameStream::FrameLibrary ( ) const

inherited

◆ frameLibrary() [1/2]

void FrameStream::frameLibrary ( frame_library_type FrameLibrary )

inlineprotectedinherited

◆ frameLibrary() [2/2]

void FrameCPP::Common::FrameStream::frameLibrary ( frame_library_type FrameLibrary )

protectedinherited

◆ frameSpecInfo() [1/11]

const FrameSpec::Info & FrameCPP::Common::StreamBase::frameSpecInfo

inlineprotectedinherited

◆ frameSpecInfo() [2/11]

void FrameCPP::Common::StreamBase::frameSpecInfo

protectedinherited

◆ frameSpecInfo() [3/11]

const FrameSpec::Info& FrameCPP::Common::StreamBase::frameSpecInfo

protectedinherited

◆ frameSpecInfo() [4/11]

virtual void FrameCPP::Common::StreamBase::frameSpecInfo

protectedinherited

◆ frameSpecInfo() [5/11]

const FrameSpec::Info & FrameCPP::Common::StreamBase::frameSpecInfo

inlineprotectedinherited

◆ frameSpecInfo() [6/11]

virtual void FrameCPP::Common::StreamBase::frameSpecInfo

protectedinherited

◆ frameSpecInfo() [7/11]

void FrameCPP::Common::StreamBase::frameSpecInfo

protectedinherited

◆ frameSpecInfo() [8/11]

const FrameSpec::Info& FrameCPP::Common::StreamBase::frameSpecInfo

protectedinherited

◆ frameSpecInfo() [9/11]

void FrameStream::frameSpecInfo ( const FrameSpec::Info * Spec )

protectedvirtualinherited

Reimplemented from FrameCPP::Common::StreamBase.

◆ frameSpecInfo() [10/11]

virtual void FrameCPP::Common::FrameStream::frameSpecInfo ( const FrameSpec::Info * Spec )

protectedvirtualinherited

Reimplemented from FrameCPP::Common::StreamBase.

◆ frameSpecInfo() [11/11]

const FrameSpec::Info & FrameCPP::Common::StreamBase::frameSpecInfo ( ) const

inlineprotectedinherited

◆ GetCheckSumFile() [1/5]

CheckSumFilter* FrameCPP::Common::IStream::GetCheckSumFile

inherited

◆ GetCheckSumFile() [2/5]

CheckSumFilter * FrameCPP::Common::IStream::GetCheckSumFile

inlineinherited

◆ GetCheckSumFile() [3/5]

CheckSumFilter * FrameCPP::Common::IStream::GetCheckSumFile

inlineinherited

◆ GetCheckSumFile() [4/5]

CheckSumFilter* FrameCPP::Common::IStream::GetCheckSumFile

inherited

◆ GetCheckSumFile() [5/5]

CheckSumFilter * FrameCPP::Common::IStream::GetCheckSumFile ( ) const

inlineinherited

◆ GetCheckSumFrame() [1/5]

CheckSumFilter * FrameCPP::Common::IStream::GetCheckSumFrame

inlineinherited

◆ GetCheckSumFrame() [2/5]

CheckSumFilter* FrameCPP::Common::IStream::GetCheckSumFrame

inherited

◆ GetCheckSumFrame() [3/5]

CheckSumFilter * FrameCPP::Common::IStream::GetCheckSumFrame

inlineinherited

◆ GetCheckSumFrame() [4/5]

CheckSumFilter* FrameCPP::Common::IStream::GetCheckSumFrame

inherited

◆ GetCheckSumFrame() [5/5]

CheckSumFilter * FrameCPP::Common::IStream::GetCheckSumFrame ( ) const

inlineinherited

◆ GetCheckSumObject() [1/5]

CheckSumFilter * FrameCPP::Common::IStream::GetCheckSumObject

inlineinherited

◆ GetCheckSumObject() [2/5]

CheckSumFilter * FrameCPP::Common::IStream::GetCheckSumObject

inlineinherited

◆ GetCheckSumObject() [3/5]

CheckSumFilter* FrameCPP::Common::IStream::GetCheckSumObject

inherited

◆ GetCheckSumObject() [4/5]

CheckSumFilter* FrameCPP::Common::IStream::GetCheckSumObject

inherited

◆ GetCheckSumObject() [5/5]

CheckSumFilter * FrameCPP::Common::IStream::GetCheckSumObject ( ) const

inlineinherited

◆ GetClassId() [1/2]

INT_2U FrameCPP::Common::StreamBase::GetClassId ( const std::string & ClassName ) const

inherited

◆ GetClassId() [2/2]

INT_2U FrameCPP::Common::StreamBase::GetClassId ( const std::string & ClassName ) const

inherited

◆ GetCurrentFrameOffset() [1/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.

◆ GetCurrentFrameOffset() [2/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.

◆ GetDictionary() [1/4]

const Dictionary & FrameCPP::Common::StreamBase::GetDictionary ( ) const

inlineinherited

◆ GetDictionary() [2/4]

const Dictionary& FrameCPP::Common::StreamBase::GetDictionary ( ) const

inherited

◆ GetDictionary() [3/4]

Dictionary & FrameCPP::Common::StreamBase::GetDictionary ( )

inlineinherited

◆ GetDictionary() [4/4]

Dictionary& FrameCPP::Common::StreamBase::GetDictionary ( )

inherited

◆ GetFrHeader() [1/2]

const FrHeader & IFrameStream::GetFrHeader ( ) const

inlinevirtualinherited

Reimplemented from FrameCPP::Common::IStream.

◆ GetFrHeader() [2/2]

virtual const FrHeader& FrameCPP::Common::IFrameStream::GetFrHeader ( ) const

virtualinherited

Reimplemented from FrameCPP::Common::IStream.

◆ GetFSIId() [1/2]

INT_2U FrameCPP::Common::StreamBase::GetFSIId ( INT_2U StreamId ) const

inlineinherited

◆ GetFSIId() [2/2]

INT_2U FrameCPP::Common::StreamBase::GetFSIId ( INT_2U StreamId ) const

inherited

◆ GetLastError() [1/2]

const std::string & FrameStream::GetLastError ( ) const

inlineinherited

◆ GetLastError() [2/2]

const std::string& FrameCPP::Common::FrameStream::GetLastError ( ) const

inherited

◆ GetMD5Sum() [1/2]

const MD5Sum & FrameStream::GetMD5Sum ( ) const

inlineinherited

◆ GetMD5Sum() [2/2]

const MD5Sum& FrameCPP::Common::FrameStream::GetMD5Sum ( ) const

inherited

◆ GetNumberOfFrames() [1/2]

INT_4U IFrameStream::GetNumberOfFrames ( ) const

inlineinherited

◆ GetNumberOfFrames() [2/2]

size_type FrameCPP::Common::IFrameStream::GetNumberOfFrames ( ) const

inherited

◆ GetTOC() [1/2]

const FrTOC* FrameCPP::Common::IFrameStream::GetTOC ( ) const

inherited

◆ GetTOC() [2/2]

const FrTOC * IFrameStream::GetTOC ( ) const

inlineinherited

◆ getTOC() [1/2]

toc_type FrameCPP::Common::IFrameStream::getTOC ( ) const

protectedinherited

◆ getTOC() [2/2]

IFrameStream::toc_type IFrameStream::getTOC ( ) const

inlineprotectedinherited

◆ LibraryRevision() [1/2]

FrameStream::library_revision_type FrameStream::LibraryRevision ( ) const

inlineinherited

◆ LibraryRevision() [2/2]

library_revision_type FrameCPP::Common::FrameStream::LibraryRevision ( ) const

inherited

◆ libraryRevision() [1/2]

void FrameStream::libraryRevision ( library_revision_type LibraryRevision )

inlineprotectedinherited

◆ libraryRevision() [2/2]

void FrameCPP::Common::FrameStream::libraryRevision ( library_revision_type LibraryRevision )

protectedinherited

◆ memoryVersion() [1/2]

version_type FrameCPP::Common::FrameStream::memoryVersion ( ) const

protectedinherited

◆ memoryVersion() [2/2]

FrameStream::version_type FrameStream::memoryVersion ( ) const

inlineprotectedinherited

◆ Next() [1/11]

IStream::ptr_struct_base_type FrameCPP::Common::IStream::Next

protectedinherited

◆ Next() [2/11]

IStream::ptr_struct_base_type FrameCPP::Common::IStream::Next

protectedinherited

◆ Next() [3/11]

virtual ptr_struct_base_type FrameCPP::Common::IStream::Next

protectedinherited

◆ Next() [4/11]

virtual ptr_struct_base_type FrameCPP::Common::IStream::Next

protectedinherited

◆ Next() [5/11]

IStream::ptr_struct_base_type FrameCPP::Common::IStream::Next

protectedinherited

◆ Next() [6/11]

IStream::ptr_struct_base_type FrameCPP::Common::IStream::Next

protectedinherited

◆ Next() [7/11]

virtual ptr_struct_base_type FrameCPP::Common::IStream::Next

protectedinherited

◆ Next() [8/11]

virtual ptr_struct_base_type FrameCPP::Common::IStream::Next

protectedinherited

◆ Next() [9/11]

IFrameStream::ptr_struct_base_type IFrameStream::Next ( object_type::element_type * Obj )

protectedvirtualinherited

Reimplemented from FrameCPP::Common::IStream.

◆ Next() [10/11]

virtual ptr_struct_base_type FrameCPP::Common::IFrameStream::Next ( object_type::element_type * Obj )

protectedvirtualinherited

Reimplemented from FrameCPP::Common::IStream.

◆ Next() [11/11]

IStream::ptr_struct_base_type FrameCPP::Common::IStream::Next ( object_type Obj )

virtualinherited

◆ NextLookup() [1/2]

Dictionary::ptr_struct_key_type FrameCPP::Common::IStream::NextLookup ( object_type Obj ) const

inlineinherited

◆ NextLookup() [2/2]

Dictionary::ptr_struct_key_type FrameCPP::Common::IStream::NextLookup ( object_type Obj ) const

inherited

◆ nextReplace() [1/2]

void FrameCPP::Common::IStream::nextReplace	(	object_type	OldObj,
		object_type	NewObj
	)

inlineprotectedinherited

◆ nextReplace() [2/2]

void FrameCPP::Common::IStream::nextReplace	(	object_type	OldObj,
		object_type	NewObj
	)

protectedinherited

◆ objectLookup() [1/2]

IStream::object_type FrameCPP::Common::IStream::objectLookup ( object_type::element_type * Pointer )

inlineprotectedinherited

◆ objectLookup() [2/2]

object_type FrameCPP::Common::IStream::objectLookup ( object_type::element_type * Pointer )

protectedinherited

◆ operator>>() [1/19]

template<typename T >

IStream & FrameCPP::Common::IStream::operator>> ( boost::shared_ptr< T > * Data )

inlineinherited

◆ operator>>() [2/19]

template<typename T >

IStream& FrameCPP::Common::IStream::operator>> ( boost::shared_ptr< T > * Data )

inherited

◆ operator>>() [3/19]

template<typename T , const std::string &(T::*)() const F>

IStream & FrameCPP::Common::IStream::operator>> ( SearchContainer< T, F > & SC )

inlineinherited

◆ operator>>() [4/19]

template<typename T , const std::string &(T::*)() const F>

IStream& FrameCPP::Common::IStream::operator>> ( SearchContainer< T, F > & SC )

inherited

◆ operator>>() [5/19]

template<typename T >

IStream & FrameCPP::Common::IStream::operator>> ( Container< T > & C )

inlineinherited

◆ operator>>() [6/19]

template<typename T >

IStream& FrameCPP::Common::IStream::operator>> ( Container< T > & C )

inherited

◆ operator>>() [7/19]

template<typename L >

IStream & FrameCPP::Common::IStream::operator>> ( STRING< L > & String )

inlineinherited

◆ operator>>() [8/19]

template<typename L >

IStream& FrameCPP::Common::IStream::operator>> ( STRING< L > & String )

inherited

◆ operator>>() [9/19]

template<typename L >

IStream& FrameCPP::Common::IStream::operator>> ( STRING_SHADOW< L > & String )

inherited

◆ operator>>() [10/19]

template<typename L >

IStream & FrameCPP::Common::IStream::operator>> ( STRING_SHADOW< L > & String )

inlineinherited

◆ operator>>() [11/19]

template<typename L >

IStream& FrameCPP::Common::IStream::operator>> ( std::vector< STRING< L > > & String )

inherited

◆ operator>>() [12/19]

template<typename L >

IStream & FrameCPP::Common::IStream::operator>> ( std::vector< STRING< L > > & String )

inlineinherited

◆ operator>>() [13/19]

template<typename DT >

IStream & FrameCPP::Common::IStream::operator>> ( std::vector< DT > & Data )

inlineinherited

◆ operator>>() [14/19]

template<typename DT >

IStream& FrameCPP::Common::IStream::operator>> ( std::vector< DT > & Data )

inherited

◆ operator>>() [15/19]

template<typename DT >

IStream & FrameCPP::Common::IStream::operator>> ( DT & Data )

inlineinherited

◆ operator>>() [16/19]

template<typename DT >

IStream& FrameCPP::Common::IStream::operator>> ( DT & Data )

inherited

◆ operator>>() [17/19]

template<typename T , typename S >

IStream& FrameCPP::Common::IStream::operator>> ( IStream::Resizer< T, S > Value )

inherited

◆ operator>>() [18/19]

template<typename T , typename S>

IStream & FrameCPP::Common::IStream::operator>> ( IStream::Resizer< T, S > Value )

inlineinherited

◆ operator>>() [19/19]

IStream & FrameCPP::Common::IStream::operator>> ( LDASTools::AL::GPSTime & Data )

inlineinherited

◆ PtrStructBytes() [1/2]

cmn_streamsize_type FrameCPP::Common::StreamBase::PtrStructBytes ( ) const

inlineinherited

◆ PtrStructBytes() [2/2]

cmn_streamsize_type FrameCPP::Common::StreamBase::PtrStructBytes ( ) const

inherited

◆ PushPtr() [1/2]

template<typename T >

void FrameCPP::Common::IStream::PushPtr ( boost::shared_ptr< T > * Obj )

inlineinherited

◆ PushPtr() [2/2]

template<typename T >

void FrameCPP::Common::IStream::PushPtr ( boost::shared_ptr< T > * Obj )

inherited

◆ PushRef() [1/2]

template<typename T >

void FrameCPP::Common::IStream::PushRef ( Container< T > & C )

inlineinherited

◆ PushRef() [2/2]

template<typename T >

void FrameCPP::Common::IStream::PushRef ( Container< T > & C )

inherited

◆ pushResolver() [1/2]

void IFrameStream::pushResolver ( resolver_type Resolver )

protectedvirtualinherited

Reimplemented from FrameCPP::Common::IStream.

◆ pushResolver() [2/2]

virtual void FrameCPP::Common::IFrameStream::pushResolver ( resolver_type Resolver )

protectedvirtualinherited

Reimplemented from FrameCPP::Common::IStream.

◆ rdbuf() [1/2]

IStream::buffer_type * FrameCPP::Common::IStream::rdbuf ( ) const

inlineinherited

◆ rdbuf() [2/2]

FrameBufferInterface* FrameCPP::Common::IStream::rdbuf ( ) const

inherited

◆ Read() [1/2]

object_type FrameCPP::Common::IFrameStream::Read ( )

inherited

◆ Read() [2/2]

IFrameStream::object_type IFrameStream::Read ( )

inherited

Todo:: Check if read goes beyond the end of the file

◆ read() [1/2]

IStream& FrameCPP::Common::IStream::read	(	char_type *	S,
		std::streamsize	N
	)

inherited

◆ read() [2/2]

IStream & FrameCPP::Common::IStream::read	(	char_type *	S,
		std::streamsize	N
	)

inlineinherited

◆ 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]

IFrameStream::object_type IFrameStream::readFrAdcData	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrAdcData() [2/4]

object_type FrameCPP::Common::IFrameStream::readFrAdcData	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrAdcData() [3/4]

IFrameStream::object_type IFrameStream::readFrAdcData	(	INT_4U	Frame,
		INT_4U	Channel
	)

protectedinherited

◆ readFrAdcData() [4/4]

object_type FrameCPP::Common::IFrameStream::readFrAdcData	(	INT_4U	Frame,
		INT_4U	Channel
	)

protectedinherited

◆ readFrAdcStruct() [1/4]

IFrameStream::object_type IFrameStream::readFrAdcStruct	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrAdcStruct() [2/4]

object_type FrameCPP::Common::IFrameStream::readFrAdcStruct	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrAdcStruct() [3/4]

IFrameStream::object_type IFrameStream::readFrAdcStruct	(	INT_4U	Frame,
		INT_4U	Channel
	)

protectedinherited

◆ readFrAdcStruct() [4/4]

object_type FrameCPP::Common::IFrameStream::readFrAdcStruct	(	INT_4U	Frame,
		INT_4U	Channel
	)

protectedinherited

◆ ReadFrame() [1/2]

IFrameStream::object_type IFrameStream::ReadFrame ( bool Decompress = false )

inlineinherited

◆ ReadFrame() [2/2]

object_type FrameCPP::Common::IFrameStream::ReadFrame ( bool Decompress = false )

inherited

◆ readFrameHSubset() [1/2]

object_type FrameCPP::Common::IFrameStream::readFrameHSubset	(	INT_4U	Frame,
		INT_4U	ElementMask
	)

protectedinherited

◆ readFrameHSubset() [2/2]

IFrameStream::object_type IFrameStream::readFrameHSubset	(	INT_4U	Frame,
		INT_4U	ElementMask
	)

protectedinherited

◆ ReadFrameN() [1/2]

IFrameStream::object_type IFrameStream::ReadFrameN	(	INT_4U	FrameIndex,
		bool	Decompress = `false`
	)

inherited

◆ ReadFrameN() [2/2]

object_type FrameCPP::Common::IFrameStream::ReadFrameN	(	INT_4U	FrameIndex,
		bool	Decompress = `false`
	)

inherited

◆ ReadFrameNSubset() [1/2]

object_type FrameCPP::Common::IFrameStream::ReadFrameNSubset	(	INT_4U	FrameIndex,
		INT_4U	ElementMask
	)

inherited

◆ ReadFrameNSubset() [2/2]

IFrameStream::object_type IFrameStream::ReadFrameNSubset	(	INT_4U	FrameIndex,
		INT_4U	ElementMask
	)

inlineinherited

◆ readFrEndOfFile() [1/2]

std::unique_ptr< FrEndOfFile > IFrameStream::readFrEndOfFile ( )

protectedinherited

◆ readFrEndOfFile() [2/2]

std::unique_ptr< FrEndOfFile > FrameCPP::Common::IFrameStream::readFrEndOfFile ( )

protectedinherited

◆ readFrEvent() [1/4]

IFrameStream::object_type IFrameStream::readFrEvent	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrEvent() [2/4]

object_type FrameCPP::Common::IFrameStream::readFrEvent	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrEvent() [3/4]

IFrameStream::object_type IFrameStream::readFrEvent	(	const std::string &	EventType,
		fr_event_offset_type	Offset
	)

protectedinherited

◆ readFrEvent() [4/4]

object_type FrameCPP::Common::IFrameStream::readFrEvent	(	const std::string &	EventType,
		fr_event_offset_type	Offset
	)

protectedinherited

◆ readFrEventStruct() [1/2]

IFrameStream::object_type IFrameStream::readFrEventStruct	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrEventStruct() [2/2]

object_type FrameCPP::Common::IFrameStream::readFrEventStruct	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrProcData() [1/4]

IFrameStream::object_type IFrameStream::readFrProcData	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrProcData() [2/4]

object_type FrameCPP::Common::IFrameStream::readFrProcData	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrProcData() [3/4]

IFrameStream::object_type IFrameStream::readFrProcData	(	INT_4U	Frame,
		INT_4U	Channel
	)

protectedinherited

◆ readFrProcData() [4/4]

object_type FrameCPP::Common::IFrameStream::readFrProcData	(	INT_4U	Frame,
		INT_4U	Channel
	)

protectedinherited

◆ readFrProcStruct() [1/4]

IFrameStream::object_type IFrameStream::readFrProcStruct	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrProcStruct() [2/4]

object_type FrameCPP::Common::IFrameStream::readFrProcStruct	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrProcStruct() [3/4]

IFrameStream::object_type IFrameStream::readFrProcStruct	(	INT_4U	Frame,
		INT_4U	Channel
	)

protectedinherited

◆ readFrProcStruct() [4/4]

object_type FrameCPP::Common::IFrameStream::readFrProcStruct	(	INT_4U	Frame,
		INT_4U	Channel
	)

protectedinherited

◆ readFrRawData() [1/2]

object_type FrameCPP::Common::IFrameStream::readFrRawData ( INT_4U Frame )

protectedinherited

◆ readFrRawData() [2/2]

object_type FrameCPP::Common::IFrameStream::readFrRawData ( INT_4U Frame )

protectedinherited

◆ readFrSerData() [1/2]

IFrameStream::object_type IFrameStream::readFrSerData	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrSerData() [2/2]

object_type FrameCPP::Common::IFrameStream::readFrSerData	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrSerStruct() [1/2]

IFrameStream::object_type IFrameStream::readFrSerStruct	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrSerStruct() [2/2]

object_type FrameCPP::Common::IFrameStream::readFrSerStruct	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrSimData() [1/2]

IFrameStream::object_type IFrameStream::readFrSimData	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrSimData() [2/2]

object_type FrameCPP::Common::IFrameStream::readFrSimData	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrSimEvent() [1/4]

IFrameStream::object_type IFrameStream::readFrSimEvent	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrSimEvent() [2/4]

object_type FrameCPP::Common::IFrameStream::readFrSimEvent	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrSimEvent() [3/4]

IFrameStream::object_type IFrameStream::readFrSimEvent	(	const std::string &	SimEventType,
		fr_sim_event_offset_type	Offset
	)

protectedinherited

◆ readFrSimEvent() [4/4]

object_type FrameCPP::Common::IFrameStream::readFrSimEvent	(	const std::string &	SimEventType,
		fr_sim_event_offset_type	Offset
	)

protectedinherited

◆ readFrSimEventStruct() [1/2]

object_type FrameCPP::Common::IFrameStream::readFrSimEventStruct	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrSimEventStruct() [2/2]

IFrameStream::object_type IFrameStream::readFrSimEventStruct	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrSimStruct() [1/2]

IFrameStream::object_type IFrameStream::readFrSimStruct	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ readFrSimStruct() [2/2]

object_type FrameCPP::Common::IFrameStream::readFrSimStruct	(	INT_4U	Frame,
		const std::string &	Channel
	)

protectedinherited

◆ ReadFrStatData() [1/4]

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

◆ ReadFrStatData() [2/4]

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() [3/4]

INT_4U IFrameStream::ReadFrStatData	(	const std::string &	NamePattern,
		const std::string &	DetectorPattern,
		const LDASTools::AL::GPSTime &	StartTime,
		const LDASTools::AL::GPSTime &	EndTime,
		const INT_4U	Version,
		FrStatData::Query &	QueryResults
	)

inherited

◆ ReadFrStatData() [4/4]

INT_4U FrameCPP::Common::IFrameStream::ReadFrStatData	(	const std::string &	NamePattern,
		const std::string &	DetectorPattern,
		const LDASTools::AL::GPSTime &	StartTime,
		const LDASTools::AL::GPSTime &	EndTime,
		const INT_4U	Version,
		FrStatData::Query &	QueryResults
	)

inherited

◆ readFrTOCHeader() [1/2]

std::unique_ptr< FrTOC > FrameCPP::Common::IFrameStream::readFrTOCHeader ( FrEndOfFile::seekTOC_cmn_type Offset )

protectedinherited

◆ readFrTOCHeader() [2/2]

std::unique_ptr< FrTOC > IFrameStream::readFrTOCHeader ( FrEndOfFile::seekTOC_cmn_type Offset )

protectedinherited

◆ readNextFrame() [1/2]

object_type FrameCPP::Common::IFrameStream::readNextFrame ( )

protectedinherited

◆ readNextFrame() [2/2]

IFrameStream::object_type IFrameStream::readNextFrame ( )

protectedinherited

◆ ReadNextFrameAsObject() [1/2]

object_type FrameCPP::Common::IFrameStream::ReadNextFrameAsObject ( )

inherited

◆ ReadNextFrameAsObject() [2/2]

IFrameStream::object_type IFrameStream::ReadNextFrameAsObject ( )

inlineinherited

◆ readObject() [1/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.

◆ readObject() [2/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.

◆ ReadPtrStruct() [1/2]

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

inherited

◆ ReadPtrStruct() [2/2]

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.

◆ readRecursive() [1/2]

void IFrameStream::readRecursive	(	INT_4U	StopOnClassId,
		bool	Decompress = `false`
	)

protectedinherited

◆ readRecursive() [2/2]

void FrameCPP::Common::IFrameStream::readRecursive	(	INT_4U	StopOnClassId,
		bool	Decompress = `false`
	)

protectedinherited

◆ readStreamRef() [1/2]

boost::shared_ptr< StreamRefInterface > IFrameStream::readStreamRef ( )

protectedinherited

◆ readStreamRef() [2/2]

boost::shared_ptr< StreamRefInterface > FrameCPP::Common::IFrameStream::readStreamRef ( )

protectedinherited

◆ readTOC() [1/2]

void FrameCPP::Common::IFrameStream::readTOC ( )

protectedinherited

◆ readTOC() [2/2]

void FrameCPP::Common::IFrameStream::readTOC ( )

protectedinherited

◆ ReferenceStreamRef() [1/2]

const_stream_ref_ptr_type FrameCPP::Common::StreamBase::ReferenceStreamRef ( ) const

inherited

◆ ReferenceStreamRef() [2/2]

StreamBase::const_stream_ref_ptr_type FrameCPP::Common::StreamBase::ReferenceStreamRef ( ) const

inherited

◆ removeRecursiveDependant() [1/2]

bool IFrameStream::removeRecursiveDependant ( const StreamRefInterface * StreamRef )

protectedinherited

◆ removeRecursiveDependant() [2/2]

bool FrameCPP::Common::IFrameStream::removeRecursiveDependant ( const StreamRefInterface * StreamRef )

protectedinherited

◆ RemoveResolver() [1/2]

void FrameCPP::Common::IStream::RemoveResolver	(	const void *	Old,
		int	MaxDepth
	)

inlineinherited

◆ RemoveResolver() [2/2]

void FrameCPP::Common::IStream::RemoveResolver	(	const void *	Old,
		int	MaxDepth
	)

inherited

◆ ReplacePtr() [1/2]

template<typename T_NEW , typename T_OLD >

void FrameCPP::Common::IStream::ReplacePtr	(	boost::shared_ptr< T_NEW > *	Obj,
		boost::shared_ptr< T_OLD > *	OldPtr,
		const int	MaxDepth
	)

inlineinherited

◆ ReplacePtr() [2/2]

template<typename T_NEW , typename T_OLD >

void FrameCPP::Common::IStream::ReplacePtr	(	boost::shared_ptr< T_NEW > *	Obj,
		boost::shared_ptr< T_OLD > *	OldPtr,
		const int	MaxDepth
	)

inherited

◆ ReplaceRef() [1/2]

template<typename T , typename OT >

void FrameCPP::Common::IStream::ReplaceRef	(	Container< T > &	C,
		const Container< OT > &	Old,
		const int	MaxDepth
	)

inherited

◆ ReplaceRef() [2/2]

template<typename T , typename OT >

void FrameCPP::Common::IStream::ReplaceRef	(	Container< T > &	C,
		const Container< OT > &	Old,
		const int	MaxDepth
	)

inlineinherited

◆ reset() [1/2]

void IFrameStream::reset ( )

protectedvirtualinherited

Reimplemented from FrameCPP::Common::FrameStream.

◆ reset() [2/2]

virtual void FrameCPP::Common::IFrameStream::reset ( )

protectedvirtualinherited

Reimplemented from FrameCPP::Common::FrameStream.

◆ Resolve() [1/2]

void FrameCPP::Common::IStream::Resolve ( )

inherited

Method to resolve links.

◆ Resolve() [2/2]

void FrameCPP::Common::IStream::Resolve ( )

inherited

◆ resolverContainer() [1/4]

const resolver_container_type& FrameCPP::Common::IStream::resolverContainer ( ) const

protectedinherited

◆ resolverContainer() [2/4]

const IStream::resolver_container_type & FrameCPP::Common::IStream::resolverContainer ( ) const

inlineprotectedinherited

◆ resolverContainer() [3/4]

resolver_container_type& FrameCPP::Common::IStream::resolverContainer ( )

protectedinherited

◆ resolverContainer() [4/4]

IStream::resolver_container_type & FrameCPP::Common::IStream::resolverContainer ( )

inlineprotectedinherited

◆ seedTOCInfo() [1/2]

void IFrameStream::seedTOCInfo ( const IFrameStream & Source )

inlineprotectedinherited

◆ seedTOCInfo() [2/2]

void FrameCPP::Common::IFrameStream::seedTOCInfo ( const IFrameStream & Source )

protectedinherited

◆ SetAutoDeleteBuffer() [1/2]

void IFrameStream::SetAutoDeleteBuffer ( const bool AutoDelete )

inlineinherited

◆ SetAutoDeleteBuffer() [2/2]

void FrameCPP::Common::IFrameStream::SetAutoDeleteBuffer ( const bool AutoDelete )

inherited

◆ setAutoDeleteBuffer() [1/2]

void FrameCPP::Common::IStream::setAutoDeleteBuffer ( const bool Value )

protectedinherited

◆ setAutoDeleteBuffer() [2/2]

void FrameCPP::Common::IStream::setAutoDeleteBuffer ( const bool Value )

inlineprotectedinherited

◆ SetCheckSumFile() [1/2]

void IFrameStream::SetCheckSumFile ( const CheckSum::kind_type Type )

inlineinherited

◆ SetCheckSumFile() [2/2]

void FrameCPP::Common::IFrameStream::SetCheckSumFile ( const CheckSum::kind_type Type )

inherited

◆ SetCheckSumFrame() [1/5]

void FrameCPP::Common::IStream::SetCheckSumFrame

inherited

◆ SetCheckSumFrame() [2/5]

void FrameCPP::Common::IStream::SetCheckSumFrame

inlineinherited

◆ SetCheckSumFrame() [3/5]

void FrameCPP::Common::IStream::SetCheckSumFrame

inlineinherited

◆ SetCheckSumFrame() [4/5]

void FrameCPP::Common::IStream::SetCheckSumFrame

inherited

◆ SetCheckSumFrame() [5/5]

void FrameCPP::Common::IStream::SetCheckSumFrame ( const CheckSum::kind_type Type )

inlineinherited

◆ SetCheckSumObject() [1/5]

void FrameCPP::Common::IStream::SetCheckSumObject

inlineinherited

◆ SetCheckSumObject() [2/5]

void FrameCPP::Common::IStream::SetCheckSumObject

inherited

◆ SetCheckSumObject() [3/5]

void FrameCPP::Common::IStream::SetCheckSumObject

inherited

◆ SetCheckSumObject() [4/5]

void FrameCPP::Common::IStream::SetCheckSumObject

inlineinherited

◆ SetCheckSumObject() [5/5]

void FrameCPP::Common::IStream::SetCheckSumObject ( const CheckSum::kind_type Type )

inlineinherited

◆ setLastError() [1/2]

void FrameStream::setLastError ( const std::string & Message )

inlineprotectedinherited

◆ setLastError() [2/2]

void FrameCPP::Common::FrameStream::setLastError ( const std::string & Message )

protectedinherited

◆ SetMD5Sum() [1/2]

void IFrameStream::SetMD5Sum ( bool Value )

inlineinherited

◆ SetMD5Sum() [2/2]

void FrameCPP::Common::IFrameStream::SetMD5Sum ( bool Value )

inherited

◆ setTOC() [1/2]

void FrameCPP::Common::FrameStream::setTOC ( )

protectedinherited

◆ setTOC() [2/2]

void FrameCPP::Common::FrameStream::setTOC ( )

protectedinherited

◆ 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

◆ streamRef() [1/2]

const StreamRefInterface & FrameStream::streamRef ( ) const

inlineprotectedinherited

◆ streamRef() [2/2]

const StreamRefInterface& FrameCPP::Common::FrameStream::streamRef ( ) const

protectedinherited

◆ streamVersion() [1/2]

FrameStream::version_type FrameStream::streamVersion ( ) const

inlineprotectedinherited

◆ streamVersion() [2/2]

version_type FrameCPP::Common::FrameStream::streamVersion ( ) const

protectedinherited

◆ VerificationFunc() [1/2]

FrameSpec::Info::verification_func_type IFrameStream::VerificationFunc ( ) const

inlineinherited

◆ VerificationFunc() [2/2]

FrameSpec::Info::verification_func_type FrameCPP::Common::IFrameStream::VerificationFunc ( ) const

inherited

◆ VerifyHeader() [1/2]

void IFrameStream::VerifyHeader ( Verify & Verifier )

inherited

◆ VerifyHeader() [2/2]

void FrameCPP::Common::IFrameStream::VerifyHeader ( Verify & Verifier )

inherited

◆ Version() [1/2]

version_type FrameCPP::Common::FrameStream::Version ( ) const

inherited

◆ Version() [2/2]

FrameStream::version_type FrameStream::Version ( ) const

inlineinherited

◆ version_stream() [1/2]

void FrameStream::version_stream ( version_type Version )

inlineprotectedinherited

◆ version_stream() [2/2]

void FrameCPP::Common::FrameStream::version_stream ( version_type Version )

protectedinherited

Member Data Documentation

◆ m_closed_state

bool FrameStream::m_closed_state

protectedinherited

◆ m_dictionary

Dictionary FrameCPP::Common::StreamBase::m_dictionary

protectedinherited

◆ m_file_checksum

checksum_filter_type FrameCPP::Common::StreamBase::m_file_checksum

protectedinherited

Checksum for file.

◆ m_file_md5sum

md5sum_filter_type FrameCPP::Common::StreamBase::m_file_md5sum

protectedinherited

MD5Sum value for the files.

◆ m_frame_checksum

checksum_filter_type FrameCPP::Common::StreamBase::m_frame_checksum

protectedinherited

Checksum for frame.

◆ m_logNextPtr

bool FrameCPP::Common::IStream::m_logNextPtr

protectedinherited

◆ m_md5sumFilter

std::unique_ptr< MD5SumFilter > FrameStream::m_md5sumFilter

protectedinherited

◆ m_null_stream_ref

object_type FrameCPP::Common::StreamBase::m_null_stream_ref

protectedinherited

◆ m_obj_checksum

checksum_filter_type FrameCPP::Common::StreamBase::m_obj_checksum

protectedinherited

Checksum for object.

◆ m_ptr_struct_object

ptr_struct_base_type FrameCPP::Common::StreamBase::m_ptr_struct_object

protectedinherited

◆ m_stream_id_to_fsi_id

streamid_to_fsiid_type FrameCPP::Common::StreamBase::m_stream_id_to_fsi_id

mutableprotectedinherited

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

/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-2.7.0/test/FrVerifyChecksums.cc

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ buffer_type [1/2]

◆ buffer_type [2/2]

◆ char_type [1/2]

◆ char_type [2/2]

◆ checksum_filter_type [1/2]

◆ checksum_filter_type [2/2]

◆ const_stream_ref_ptr_type [1/2]

◆ const_stream_ref_ptr_type [2/2]

◆ fr_event_offset_type [1/2]

◆ fr_event_offset_type [2/2]

◆ fr_sim_event_offset_type [1/2]

◆ fr_sim_event_offset_type [2/2]

◆ frame_library_type [1/2]

◆ frame_library_type [2/2]

◆ istream_type [1/2]

◆ istream_type [2/2]

◆ library_revision_type [1/2]

◆ library_revision_type [2/2]

◆ md5sum_filter_type [1/2]

◆ md5sum_filter_type [2/2]

◆ object_type [1/4]

◆ object_type [2/4]

◆ object_type [3/4]

◆ object_type [4/4]

◆ ptr_struct_base_type [1/2]

◆ ptr_struct_base_type [2/2]

◆ resolver_container_type [1/2]

◆ resolver_container_type [2/2]

◆ resolver_type [1/2]

◆ resolver_type [2/2]

◆ size_type [1/2]

◆ size_type [2/2]

◆ streamid_to_fsiid_type [1/2]

◆ streamid_to_fsiid_type [2/2]

◆ streamref_interface_type [1/2]

◆ streamref_interface_type [2/2]

◆ streamref_type [1/2]

◆ streamref_type [2/2]

◆ toc_type [1/2]

◆ toc_type [2/2]

◆ version_type [1/2]

◆ version_type [2/2]

Constructor & Destructor Documentation

◆ IFrameStream()

Member Function Documentation

◆ addRecursiveDependant() [1/4]

◆ addRecursiveDependant() [2/4]

◆ addRecursiveDependant() [3/4]

◆ addRecursiveDependant() [4/4]

◆ advanceToFrame() [1/2]

◆ advanceToFrame() [2/2]

◆ ByteSwapping() [1/2]

◆ ByteSwapping() [2/2]

◆ byteSwapping() [1/2]

◆ byteSwapping() [2/2]

◆ Cleanup() [1/2]

◆ Cleanup() [2/2]

◆ FrameLibrary() [1/2]

◆ FrameLibrary() [2/2]

◆ frameLibrary() [1/2]

◆ frameLibrary() [2/2]

◆ frameSpecInfo() [1/11]

◆ frameSpecInfo() [2/11]

◆ frameSpecInfo() [3/11]

◆ frameSpecInfo() [4/11]

◆ frameSpecInfo() [5/11]

◆ frameSpecInfo() [6/11]

◆ frameSpecInfo() [7/11]

◆ frameSpecInfo() [8/11]

◆ frameSpecInfo() [9/11]

◆ frameSpecInfo() [10/11]

◆ frameSpecInfo() [11/11]

◆ GetCheckSumFile() [1/5]

◆ GetCheckSumFile() [2/5]