ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
IFrameStream Class Reference
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::Objectobject_type
typedef const Dictionary::streamref_type::element_type * const_stream_ref_ptr_type
typedef Dictionary::streamref_type streamref_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

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.
size_type GetCurrentFrameOffset () const
 Retrieve the current frame.
virtual const FrHeaderGetFrHeader () const
virtual const FrHeaderGetFrHeader () const
const FrTOCGetTOC () const
const FrTOCGetTOC () 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.
object_type ReadDetector (const std::string &Name)
 Read the detector via the table of contents.
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.
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.
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)
CheckSumFilterGetCheckSumFile () const
CheckSumFilterGetCheckSumFrame () const
CheckSumFilterGetCheckSumObject () const
void SetCheckSumFrame (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 MD5SumGetMD5Sum () const
const MD5SumGetMD5Sum () const
INT_2U GetClassId (const std::string &ClassName) const
INT_2U GetFSIId (INT_2U StreamId) const
cmn_streamsize_type PtrStructBytes () const
const_stream_ref_ptr_type ReferenceStreamRef () const
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
IStreamread (char_type *S, std::streamsize N)
IStreamread (char_type *S, std::streamsize N)
ptr_struct_base_type ReadPtrStruct ()
ptr_struct_base_type ReadPtrStruct ()
void Resolve ()
 Method to resolve links.
void Resolve ()
cmn_streamsize_type Size ()
 Return the size of the stream.
cmn_streamsize_type Size ()
 Return the size of the stream.
template<typename T>
IStreamoperator>> (boost::shared_ptr< T > *Data)
template<typename T, const std::string &(T::*)() const F>
IStreamoperator>> (SearchContainer< T, F > &SC)
template<typename T>
IStreamoperator>> (Container< T > &C)
template<typename L>
IStreamoperator>> (STRING< L > &String)
template<typename L>
IStreamoperator>> (STRING_SHADOW< L > &String)
template<typename L>
IStreamoperator>> (std::vector< STRING< L > > &String)
template<typename DT>
IStreamoperator>> (std::vector< DT > &Data)
template<typename DT>
IStreamoperator>> (DT &Data)
template<typename T, typename S>
IStreamoperator>> (IStream::Resizer< T, S > Value)
template<typename T>
IStreamoperator>> (boost::shared_ptr< T > *Data)
template<typename T, const std::string &(T::*)() const F>
IStreamoperator>> (SearchContainer< T, F > &SC)
template<typename T>
IStreamoperator>> (Container< T > &C)
template<typename L>
IStreamoperator>> (STRING< L > &String)
template<typename L>
IStreamoperator>> (STRING_SHADOW< L > &String)
template<typename L>
IStreamoperator>> (std::vector< STRING< L > > &String)
template<typename DT>
IStreamoperator>> (std::vector< DT > &Data)
template<typename DT>
IStreamoperator>> (DT &Data)
template<typename T, typename S>
IStreamoperator>> (IStream::Resizer< T, S > Value)
template<>
IStreamoperator>> (LDASTools::AL::GPSTime &Data)
template<>
IStreamoperator>> (LDASTools::AL::GPSTime &Data)
bool ByteSwapping () const
bool ByteSwapping () const

Protected Types

typedef boost::shared_ptr< FrTOCtoc_type
typedef boost::shared_ptr< FrTOCtoc_type
typedef std::unique_ptr< CheckSumFilterchecksum_filter_type
typedef std::unique_ptr< MD5SumFilter > md5sum_filter_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< resolverresolver_type
typedef boost::shared_ptr< resolverresolver_type
typedef std::list< resolver_typeresolver_container_type
typedef std::list< resolver_typeresolver_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)
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< FrTOCreadFrTOCHeader (FrEndOfFile::seekTOC_cmn_type Offset)
std::unique_ptr< FrTOCreadFrTOCHeader (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.
object_type readObject (const StreamRefInterface *StreamRef)
 Read an Object referenced in the stream.
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)
virtual void frameSpecInfo (const FrameSpec::Info *Spec)
virtual void frameSpecInfo (const FrameSpec::Info *Spec)
const FrameSpec::InfoframeSpecInfo () const
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.
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
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_typeresolverContainer () const
resolver_container_typeresolverContainer ()
const resolver_container_typeresolverContainer () const
resolver_container_typeresolverContainer ()
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.
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.
bool m_logNextPtr

Private Types

typedef std::map< INT_8U, detector_info_typedetector_pos_type
typedef std::map< INT_8U, detector_info_typedetector_pos_type
typedef LDASTools::AL::unordered_map< object_type, Dictionary::ptr_struct_key_type, smart_pointer_hash< object_type > > next_container_type
 Maintains information to reconstruct linked lists.
typedef LDASTools::AL::unordered_map< object_type, Dictionary::ptr_struct_key_type, smart_pointer_hash< object_type > > next_container_type
 Maintains information to reconstruct linked lists.
typedef LDASTools::AL::unordered_map< object_type::element_type *, object_type, LDASTools::AL::hash_pointer< object_type::element_type > > object_container_type
typedef LDASTools::AL::unordered_map< object_type::element_type *, object_type, LDASTools::AL::hash_pointer< object_type::element_type > > object_container_type
typedef std::unique_ptr< buffer_typebuffer_ptr_type
typedef std::unique_ptr< buffer_typebuffer_ptr_type

Private Member Functions

void init ()
void init ()
void load_toc ()
 Load table of contents from stream.
void load_toc ()
 Load table of contents from stream.
template<INT_4U ClassType, typename ChannelType>
object_type read_fr_struct (INT_4U Frame, ChannelType Channel, bool Recursively)
template<INT_4U ClassType, typename ChannelType>
object_type read_fr_struct (INT_4U Frame, ChannelType Channel, bool Recursively)
template<INT_4U ClassType, typename ChannelType>
object_type read_indexed_fr_struct (ChannelType Channel, INT_4U Index, bool Recursively)
template<INT_4U ClassType, typename ChannelType>
object_type read_indexed_fr_struct (ChannelType Channel, INT_4U Index, bool Recursively)
template<INT_4U ClassType, typename ChannelType>
object_type advance_to_fr_struct (INT_4U FrameIndex, ChannelType Channel)
template<INT_4U ClassType, typename ChannelType>
object_type advance_to_fr_struct (INT_4U FrameIndex, ChannelType Channel)
template<INT_4U ClassType, typename ChannelType>
object_type advance_to_indexed_fr_struct (ChannelType Channel, INT_4U Index)
template<INT_4U ClassType, typename ChannelType>
object_type advance_to_indexed_fr_struct (ChannelType Channel, INT_4U Index)
template<INT_4U ClassType, typename ChannelType>
INT_8U position (const FrTOC *TOC, INT_4U Frame, const ChannelType &Channel) const
template<INT_4U ClassType, typename ChannelType>
INT_8U position (const FrTOC *TOC, INT_4U Frame, const ChannelType &Channel) const
template<INT_4U ClassType, typename ChannelType>
INT_8U position_index (const FrTOC *TOC, const ChannelType &Channel, INT_4U Index) const
template<INT_4U ClassType, typename ChannelType>
INT_8U position_index (const FrTOC *TOC, const ChannelType &Channel, INT_4U Index) const

Private Attributes

boost::shared_ptr< FrHeaderm_file_header
toc_type m_toc
bool m_toc_loaded
bool m_reading_frame_subset
 state variable for reading frame subset.
std::set< INT_8U > m_to_be_resolved
bool m_log_recursive_dependants
INT_4U m_next_frame_index
 Current frame index.
detector_pos_type m_detector_pos
frame_library_type m_frame_library
library_revision_type m_library_revision
version_type m_memory_version
 Version number to use for frames in memory.
version_type m_stream_version
 Version number to use for frames in stream.
streamref_interface_type m_stream_ref
std::string m_last_error_message
bool stream_length_valid
cmn_streamsize_type stream_length
buffer_ptr_type m_buffer
bool m_buffer_auto_delete
bool m_filter_internally
next_container_type m_next_container
bool m_byte_swapping
resolver_container_type m_resolver_container
object_container_type m_objects

Member Typedef Documentation

◆ buffer_ptr_type [1/2]

typedef std::unique_ptr< buffer_type > FrameCPP::Common::IStream::buffer_ptr_type
privateinherited

◆ buffer_ptr_type [2/2]

typedef std::unique_ptr< buffer_type > FrameCPP::Common::IStream::buffer_ptr_type
privateinherited

◆ 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

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

◆ const_stream_ref_ptr_type

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

◆ detector_pos_type [1/2]

typedef std::map< INT_8U, detector_info_type > FrameCPP::Common::IFrameStream::detector_pos_type
privateinherited

◆ detector_pos_type [2/2]

typedef std::map< INT_8U, detector_info_type > FrameCPP::Common::IFrameStream::detector_pos_type
privateinherited

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

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

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

◆ next_container_type [1/2]

typedef LDASTools::AL::unordered_map< object_type, Dictionary::ptr_struct_key_type, smart_pointer_hash< object_type > > FrameCPP::Common::IStream::next_container_type
privateinherited

Maintains information to reconstruct linked lists.

◆ next_container_type [2/2]

typedef LDASTools::AL::unordered_map< object_type, Dictionary::ptr_struct_key_type, smart_pointer_hash< object_type > > FrameCPP::Common::IStream::next_container_type
privateinherited

Maintains information to reconstruct linked lists.

◆ object_container_type [1/2]

typedef LDASTools::AL::unordered_map< object_type::element_type*, object_type, LDASTools::AL::hash_pointer< object_type::element_type > > FrameCPP::Common::IStream::object_container_type
privateinherited

◆ object_container_type [2/2]

typedef LDASTools::AL::unordered_map< object_type::element_type*, object_type, LDASTools::AL::hash_pointer< object_type::element_type > > FrameCPP::Common::IStream::object_container_type
privateinherited

◆ object_type

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

◆ ptr_struct_base_type

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

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

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]

◆ version_type [2/2]

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 ( const StreamRefInterface * StreamRef)
protectedinherited

◆ addRecursiveDependant() [2/4]

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

◆ addRecursiveDependant() [3/4]

void IFrameStream::addRecursiveDependant ( ptr_struct_base_type Ref)
protectedvirtualinherited

◆ addRecursiveDependant() [4/4]

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

◆ advance_to_fr_struct() [1/2]

template<INT_4U ClassType, typename ChannelType>
IFrameStream::object_type IFrameStream::advance_to_fr_struct ( INT_4U FrameIndex,
ChannelType Channel )
privateinherited

◆ advance_to_fr_struct() [2/2]

template<INT_4U ClassType, typename ChannelType>
object_type FrameCPP::Common::IFrameStream::advance_to_fr_struct ( INT_4U FrameIndex,
ChannelType Channel )
privateinherited

◆ advance_to_indexed_fr_struct() [1/2]

template<INT_4U ClassType, typename ChannelType>
IFrameStream::object_type IFrameStream::advance_to_indexed_fr_struct ( ChannelType Channel,
INT_4U Index )
privateinherited

◆ advance_to_indexed_fr_struct() [2/2]

template<INT_4U ClassType, typename ChannelType>
object_type FrameCPP::Common::IFrameStream::advance_to_indexed_fr_struct ( ChannelType Channel,
INT_4U Index )
privateinherited

◆ 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 IStream::ByteSwapping ( ) const
inlineinherited

◆ ByteSwapping() [2/2]

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

◆ byteSwapping() [1/2]

void IStream::byteSwapping ( bool Value)
inlineprotectedinherited

◆ byteSwapping() [2/2]

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

◆ Cleanup() [1/2]

void IFrameStream::Cleanup ( )
virtualinherited

Reimplemented from FrameCPP::Common::StreamBase.

◆ Cleanup() [2/2]

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

Reimplemented from FrameCPP::Common::StreamBase.

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

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

◆ frameSpecInfo() [2/3]

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

Reimplemented from FrameCPP::Common::StreamBase.

◆ frameSpecInfo() [3/3]

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

Reimplemented from FrameCPP::Common::StreamBase.

◆ GetCheckSumFile()

CheckSumFilter * IStream::GetCheckSumFile ( ) const
inlineinherited

◆ GetCheckSumFrame()

CheckSumFilter * IStream::GetCheckSumFrame ( ) const
inlineinherited

◆ GetCheckSumObject()

CheckSumFilter * IStream::GetCheckSumObject ( ) const
inlineinherited

◆ GetClassId()

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

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

◆ GetDictionary() [1/2]

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

◆ GetDictionary() [2/2]

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

◆ 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()

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

◆ 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 * IFrameStream::GetTOC ( ) const
inlineinherited

◆ GetTOC() [2/2]

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

◆ getTOC() [1/2]

IFrameStream::toc_type IFrameStream::getTOC ( ) const
inlineprotectedinherited

◆ getTOC() [2/2]

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

◆ init() [1/2]

void IFrameStream::init ( )
privateinherited

◆ init() [2/2]

void FrameCPP::Common::IFrameStream::init ( )
privateinherited

◆ 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

◆ load_toc() [1/2]

void IFrameStream::load_toc ( )
privateinherited

Load table of contents from stream.

If possible, this method will load the table of contents from the stream. One example of not being able to load the table of contents is the case where the stream does not have a table of contents structure.

◆ load_toc() [2/2]

void FrameCPP::Common::IFrameStream::load_toc ( )
privateinherited

Load table of contents from stream.

◆ memoryVersion() [1/2]

FrameStream::version_type FrameStream::memoryVersion ( ) const
inlineprotectedinherited

◆ memoryVersion() [2/2]

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

◆ morph() [1/2]

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

Modify an object so it is appropriate for the stream.

Parameters
[in]ObjThe 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]ObjThe object that should be transformed.
Returns
A pointer to the object appropriately converted. If no conversion was necessary, the same pointer is returned.

◆ Next() [1/3]

IStream::ptr_struct_base_type IStream::Next ( object_type Obj)
protectedvirtualinherited

Reimplemented from FrameCPP::Common::IStream.

◆ Next() [2/3]

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

Reimplemented from FrameCPP::Common::IStream.

◆ Next() [3/3]

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

Reimplemented from FrameCPP::Common::IStream.

◆ NextLookup() [1/2]

Dictionary::ptr_struct_key_type 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 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 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/20]

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

◆ operator>>() [2/20]

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

◆ operator>>() [3/20]

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

◆ operator>>() [4/20]

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

◆ operator>>() [5/20]

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

◆ operator>>() [6/20]

template<typename DT>
IStream & FrameCPP::Common::IStream::operator>> ( DT & Data)
inherited

◆ operator>>() [7/20]

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

◆ operator>>() [8/20]

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

◆ operator>>() [9/20]

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

◆ operator>>() [10/20]

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

◆ operator>>() [11/20]

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

◆ operator>>() [12/20]

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

◆ operator>>() [13/20]

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

◆ operator>>() [14/20]

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

◆ operator>>() [15/20]

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

◆ operator>>() [16/20]

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

◆ operator>>() [17/20]

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

◆ operator>>() [18/20]

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

◆ operator>>() [19/20]

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

◆ operator>>() [20/20]

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

◆ position() [1/2]

template<INT_4U ClassType, typename ChannelType>
INT_8U FrameCPP::Common::IFrameStream::position ( const FrTOC * TOC,
INT_4U Frame,
const ChannelType & Channel ) const
privateinherited

◆ position() [2/2]

template<INT_4U ClassType, typename ChannelType>
INT_8U FrameCPP::Common::IFrameStream::position ( const FrTOC * TOC,
INT_4U Frame,
const ChannelType & Channel ) const
privateinherited

◆ position_index() [1/2]

template<INT_4U ClassType, typename ChannelType>
INT_8U FrameCPP::Common::IFrameStream::position_index ( const FrTOC * TOC,
const ChannelType & Channel,
INT_4U Index ) const
privateinherited

◆ position_index() [2/2]

template<INT_4U ClassType, typename ChannelType>
INT_8U FrameCPP::Common::IFrameStream::position_index ( const FrTOC * TOC,
const ChannelType & Channel,
INT_4U Index ) const
privateinherited

◆ PtrStructBytes()

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

◆ PushPtr() [1/2]

template<typename T>
void 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 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 * IStream::rdbuf ( ) const
inlineinherited

◆ rdbuf() [2/2]

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

◆ Read() [1/2]

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

◆ Read() [2/2]

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

◆ read() [1/2]

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

◆ read() [2/2]

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

◆ read_fr_struct() [1/2]

template<INT_4U ClassType, typename ChannelType>
IFrameStream::object_type IFrameStream::read_fr_struct ( INT_4U Frame,
ChannelType Channel,
bool Recursively )
privateinherited

◆ read_fr_struct() [2/2]

template<INT_4U ClassType, typename ChannelType>
object_type FrameCPP::Common::IFrameStream::read_fr_struct ( INT_4U Frame,
ChannelType Channel,
bool Recursively )
privateinherited

◆ read_indexed_fr_struct() [1/2]

template<INT_4U ClassType, typename ChannelType>
IFrameStream::object_type IFrameStream::read_indexed_fr_struct ( ChannelType Channel,
INT_4U Index,
bool Recursively )
privateinherited

◆ read_indexed_fr_struct() [2/2]

template<INT_4U ClassType, typename ChannelType>
object_type FrameCPP::Common::IFrameStream::read_indexed_fr_struct ( ChannelType Channel,
INT_4U Index,
bool Recursively )
privateinherited

◆ ReadDetector() [1/2]

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

Read the detector via the table of contents.

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

◆ ReadDetector() [2/2]

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

Read the detector via the table of contents.

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

◆ readFrAdcData() [1/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]

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

◆ readFrameHSubset() [2/2]

object_type FrameCPP::Common::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]

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

◆ ReadFrameNSubset() [2/2]

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

◆ 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 ( const std::string & EventType,
fr_event_offset_type Offset )
protectedinherited

◆ readFrEvent() [2/4]

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

◆ readFrEvent() [3/4]

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

◆ readFrEvent() [4/4]

object_type FrameCPP::Common::IFrameStream::readFrEvent ( INT_4U Frame,
const std::string & Channel )
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 ( const std::string & SimEventType,
fr_sim_event_offset_type Offset )
protectedinherited

◆ readFrSimEvent() [2/4]

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

◆ readFrSimEvent() [3/4]

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

◆ readFrSimEvent() [4/4]

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

◆ readFrSimEventStruct() [1/2]

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

◆ readFrSimEventStruct() [2/2]

object_type FrameCPP::Common::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]

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

◆ ReadFrStatData() [3/4]

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

Read FrStatData at a given postion in the stream.

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

◆ ReadFrStatData() [4/4]

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

Read FrStatData at a given postion in the stream.

Parameters
PositionOffset of the FrStatData in the stream

◆ readFrTOCHeader() [1/2]

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

◆ readFrTOCHeader() [2/2]

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

◆ readNextFrame() [1/2]

IFrameStream::object_type IFrameStream::readNextFrame ( )
protectedinherited

◆ readNextFrame() [2/2]

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

◆ ReadNextFrameAsObject() [1/2]

IFrameStream::object_type IFrameStream::ReadNextFrameAsObject ( )
inlineinherited

◆ ReadNextFrameAsObject() [2/2]

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

◆ readObject() [1/2]

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

Read an Object referenced in the stream.

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

◆ readObject() [2/2]

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

Read an Object referenced in the stream.

Parameters
StreamRefStream reference information for the requested object.

◆ ReadPtrStruct() [1/2]

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.

◆ ReadPtrStruct() [2/2]

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

◆ 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()

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 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 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 IStream::ReplaceRef ( Container< T > & C,
const Container< OT > & Old,
const int MaxDepth )
inlineinherited

◆ ReplaceRef() [2/2]

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

◆ 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 IStream::Resolve ( )
inherited

Method to resolve links.

◆ Resolve() [2/2]

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

◆ resolverContainer() [1/4]

IStream::resolver_container_type & IStream::resolverContainer ( )
inlineprotectedinherited

◆ resolverContainer() [2/4]

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

◆ resolverContainer() [3/4]

const IStream::resolver_container_type & IStream::resolverContainer ( ) const
inlineprotectedinherited

◆ resolverContainer() [4/4]

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

◆ 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 IStream::setAutoDeleteBuffer ( const bool Value)
inlineprotectedinherited

◆ setAutoDeleteBuffer() [2/2]

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

◆ 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()

void IStream::SetCheckSumFrame ( const CheckSum::kind_type Type)
inlineinherited

◆ SetCheckSumObject()

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

FrameStream::version_type FrameStream::Version ( ) const
inlineinherited

◆ Version() [2/2]

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

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

buffer_ptr_type IStream::m_buffer
privateinherited

◆ m_buffer_auto_delete

bool IStream::m_buffer_auto_delete
privateinherited

◆ m_byte_swapping

bool IStream::m_byte_swapping
privateinherited

◆ m_closed_state

bool FrameStream::m_closed_state
protectedinherited

◆ m_detector_pos

detector_pos_type IFrameStream::m_detector_pos
privateinherited

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

boost::shared_ptr< FrHeader > IFrameStream::m_file_header
privateinherited

◆ m_file_md5sum

md5sum_filter_type FrameCPP::Common::StreamBase::m_file_md5sum
protectedinherited

MD5Sum value for the files.

◆ m_filter_internally

bool IStream::m_filter_internally
privateinherited

◆ m_frame_checksum

checksum_filter_type FrameCPP::Common::StreamBase::m_frame_checksum
protectedinherited

Checksum for frame.

◆ m_frame_library

frame_library_type FrameStream::m_frame_library
privateinherited

◆ m_last_error_message

std::string FrameStream::m_last_error_message
privateinherited

◆ m_library_revision

library_revision_type FrameStream::m_library_revision
privateinherited

◆ m_log_recursive_dependants

bool IFrameStream::m_log_recursive_dependants
privateinherited

◆ m_logNextPtr

bool IStream::m_logNextPtr
protectedinherited

◆ m_md5sumFilter

std::unique_ptr< MD5SumFilter > FrameStream::m_md5sumFilter
protectedinherited

◆ m_memory_version

version_type FrameStream::m_memory_version
privateinherited

Version number to use for frames in memory.

◆ m_next_container

next_container_type IStream::m_next_container
privateinherited

◆ m_next_frame_index

INT_4U IFrameStream::m_next_frame_index
privateinherited

Current frame index.

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

object_container_type IStream::m_objects
privateinherited

◆ m_ptr_struct_object

ptr_struct_base_type FrameCPP::Common::StreamBase::m_ptr_struct_object
protectedinherited

◆ m_reading_frame_subset

bool IFrameStream::m_reading_frame_subset
privateinherited

state variable for reading frame subset.

◆ m_resolver_container

resolver_container_type IStream::m_resolver_container
privateinherited

◆ m_stream_id_to_fsi_id

streamid_to_fsiid_type FrameCPP::Common::StreamBase::m_stream_id_to_fsi_id
mutableprotectedinherited

◆ m_stream_ref

streamref_interface_type FrameStream::m_stream_ref
privateinherited

◆ m_stream_version

version_type FrameStream::m_stream_version
privateinherited

Version number to use for frames in stream.

◆ m_to_be_resolved

std::set< INT_8U > IFrameStream::m_to_be_resolved
privateinherited

Set of references which need to resolved. Used by recursive reading function.

◆ m_toc

toc_type IFrameStream::m_toc
privateinherited

◆ m_toc_loaded

bool IFrameStream::m_toc_loaded
privateinherited

◆ stream_length

cmn_streamsize_type IStream::stream_length
privateinherited

◆ stream_length_valid

bool IStream::stream_length_valid
privateinherited

The documentation for this class was generated from the following file:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/test/FrVerifyChecksums.cc