ldas-tools-framecpp  2.5.8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Common::IFrameStreamPlanWrapper< DECL > Class Template Reference

Frame Reading FrameStreamPlanWrapper. More...

#include <FrameStreamPlanWrapper.hh>

Inheritance diagram for FrameCPP::Common::IFrameStreamPlanWrapper< DECL >:
FrameCPP::Common::IFrameStreamWrapper< DECL_PARAMS > FrameCPP::Common::IFrameStream FrameCPP::Common::FrameStream FrameCPP::Common::IStream FrameCPP::Common::StreamBase FrameCPP::Common::StreamBase

Public Types

typedef IFrameStreamWrapper
< DECL_PARAMS
base_type
 
typedef base_type::buffer_type buffer_type
 
typedef
base_type::frame_offset_type 
frame_offset_type
 
typedef base_type::fr_adc_data_type fr_adc_data_type
 
typedef base_type::fr_event_type fr_event_type
 
typedef INT_4U fr_event_offset_type
 
typedef
base_type::fr_proc_data_type 
fr_proc_data_type
 
typedef base_type::fr_ser_data_type fr_ser_data_type
 
typedef base_type::fr_sim_data_type fr_sim_data_type
 
typedef
base_type::fr_sim_event_type 
fr_sim_event_type
 
typedef INT_4U fr_sim_event_offset_type
 
typedef
IFrameStreamPlanWrapper
< DECL_PARAMS
plan_type
 
typedef
LDASTools::AL::SharedPtr
< FrameH
frame_h_type
 
typedef
LDASTools::AL::SharedPtr
< RawData > 
fr_raw_data_type
 
typedef INT_4U size_type
 
typedef
FrHeader::frame_library_type 
frame_library_type
 
typedef
FrHeader::library_revision_type 
library_revision_type
 
typedef FrameSpec::version_type version_type
 
typedef const StreamRefInterfacestreamref_interface_type
 
typedef
LDASTools::AL::SharedPtr
< FrameSpec::Object
object_type
 

Public Member Functions

 IFrameStreamPlanWrapper (buffer_type *Stream, plan_type *master=0)
 
 ~IFrameStreamPlanWrapper ()
 
fr_adc_data_type ReadFrAdcData (frame_offset_type Frame, INT_4U Channel)
 Extract the requested FrAdcData structure from the stream. More...
 
fr_adc_data_type ReadFrAdcData (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrAdcData structure from the stream. More...
 
fr_event_type ReadFrEvent (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrEvent structure from the stream. More...
 
fr_event_type ReadFrEvent (const std::string &EventType, fr_event_offset_type Offset)
 Extract the requested FrEvent structure from the stream. More...
 
fr_proc_data_type ReadFrProcData (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrProcData structure from the stream. More...
 
fr_ser_data_type ReadFrSerData (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSerData structure from the stream. More...
 
fr_sim_data_type ReadFrSimData (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSimData structure from the stream. More...
 
fr_sim_event_type ReadFrSimEvent (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSimEvent structure from the stream. More...
 
fr_sim_event_type ReadFrSimEvent (const std::string &SimEventType, fr_event_offset_type Offset)
 Extract the requested FrSimEvent structure from the stream. More...
 
std::string FrameLibraryName () const
 
frame_h_type ReadFrameH (frame_offset_type Frame, INT_4U ContainerSet)
 Extract the requested FrameH structure from the stream. More...
 
fr_adc_data_type ReadFrAdcStruct (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrAdcData structure from the stream. More...
 
fr_adc_data_type ReadFrAdcStruct (frame_offset_type Frame, INT_4U Channel)
 Extract the requested FrAdcData structure from the stream. More...
 
fr_event_type ReadFrEventStruct (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrEvent structure from the stream. More...
 
fr_proc_data_type ReadFrProcData (frame_offset_type Frame, INT_4U Channel)
 Extract the requested FrProcData structure from the stream. More...
 
fr_proc_data_type ReadFrProcStruct (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrProcData structure from the stream. More...
 
fr_proc_data_type ReadFrProcStruct (frame_offset_type Frame, INT_4U Channel)
 Extract the requested FrProcData structure from the stream. More...
 
fr_raw_data_type ReadFrRawData (frame_offset_type Frame)
 Extract the requested FrRawData structure from the stream. More...
 
fr_ser_data_type ReadFrSerStruct (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSerData structure from the stream. More...
 
fr_sim_event_type ReadFrSimEventStruct (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSimEvent structure from the stream. More...
 
fr_sim_data_type ReadFrSimStruct (frame_offset_type Frame, const std::string &Channel)
 Extract the requested FrSerData structure from the stream. More...
 
frame_h_type ReadNextFrame ()
 Extract the next FrameH structure from the stream. More...
 
virtual void Cleanup ()
 
size_type GetCurrentFrameOffset () const
 Retrieve the current frame. More...
 
virtual const FrHeaderGetFrHeader () const
 
const FrTOCGetTOC () const
 
size_type GetNumberOfFrames () const
 
FrameSpec::Info::verification_func_type VerificationFunc () const
 
object_type Read ()
 
object_type ReadNextFrameAsObject ()
 
object_type ReadDetector (const std::string &Name)
 Read the detector via the table of contents. More...
 
object_type ReadFrame (bool Decompress=false)
 
object_type ReadFrameN (INT_4U FrameIndex, bool Decompress=false)
 
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)
 
void SetAutoDeleteBuffer (const bool AutoDelete)
 
void SetCheckSumFile (const CheckSum::kind_type Type)
 
void SetMD5Sum (bool Value)
 
void VerifyHeader (Verify &Verifier)
 
frame_library_type FrameLibrary () const
 
library_revision_type LibraryRevision () const
 
version_type Version () const
 
const std::string & GetLastError () const
 
const MD5SumGetMD5Sum () const
 

Protected Types

typedef
LDASTools::AL::SharedPtr
< FrTOC
toc_type
 
typedef const
Dictionary::streamref_type::element_type * 
const_stream_ref_ptr_type
 
typedef Dictionary::streamref_type streamref_type
 
typedef std::unique_ptr
< CheckSumFilter
checksum_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::SharedPtr
< PTR_STRUCT_BASE
ptr_struct_base_type
 
typedef std::istream::char_type char_type
 
typedef std::istream istream_type
 
typedef
LDASTools::AL::SharedPtr
< resolver
resolver_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 Obj)
 
object_type advanceToFrame (INT_4U Frame)
 
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 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 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 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 readFrSerData (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 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 readFrSimEventStruct (INT_4U Frame, const std::string &Channel)
 
object_type readNextFrame ()
 
LDASTools::AL::SharedPtr
< StreamRefInterface
readStreamRef ()
 
void readTOC ()
 
virtual void reset ()
 
object_type readObject (const StreamRefInterface *StreamRef)
 Read an Object referenced in the stream. More...
 
void readRecursive (INT_4U StopOnClassId, bool Decompress=false)
 
bool removeRecursiveDependant (const StreamRefInterface *StreamRef)
 
virtual void addRecursiveDependant (ptr_struct_base_type Ref)
 
void addRecursiveDependant (const StreamRefInterface *StreamRef)
 
toc_type getTOC ()
 
virtual void pushResolver (resolver_type Resolver)
 
void seedTOCInfo (const IFrameStream &Source)
 
virtual void frameSpecInfo (const FrameSpec::Info *Spec)
 
const FrameSpec::InfoframeSpecInfo () const
 
void setLastError (const std::string &Message)
 
void setTOC ()
 
const StreamRefInterfacestreamRef () const
 
void version_stream (version_type Version)
 
void frameLibrary (frame_library_type FrameLibrary)
 
void libraryRevision (library_revision_type LibraryRevision)
 
version_type memoryVersion () const
 
version_type streamVersion () 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 DictionaryGetDictionary () const
 
DictionaryGetDictionary ()
 
CheckSumFilterGetCheckSumFile () const
 
CheckSumFilterGetCheckSumFrame () const
 
void SetCheckSumFrame (const CheckSum::kind_type Type)
 
CheckSumFilterGetCheckSumObject () const
 
void SetCheckSumObject (const CheckSum::kind_type Type)
 
Dictionary::ptr_struct_key_type NextLookup (object_type Obj) const
 
void RemoveResolver (const void *Old, int MaxDepth)
 
template<typename T >
void PushPtr (LDASTools::AL::SharedPtr< T > *Obj)
 
template<typename T_NEW , typename T_OLD >
void ReplacePtr (LDASTools::AL::SharedPtr< T_NEW > *Obj, LDASTools::AL::SharedPtr< T_OLD > *OldPtr, const int MaxDepth)
 
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)
 
FrameBufferInterfacerdbuf () const
 
IStreamread (char_type *S, std::streamsize N)
 
ptr_struct_base_type ReadPtrStruct ()
 
void Resolve ()
 Method to resolve links. More...
 
cmn_streamsize_type Size ()
 Return the size of the stream. More...
 
template<typename T >
IStreamoperator>> (LDASTools::AL::SharedPtr< 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)
 
bool ByteSwapping () const
 
void nextReplace (object_type OldObj, object_type NewObj)
 
void byteSwapping (bool Value)
 
object_type objectLookup (object_type::element_type *Pointer)
 
const resolver_container_typeresolverContainer () const
 
resolver_container_typeresolverContainer ()
 
void setAutoDeleteBuffer (const bool Value)
 

Protected Attributes

bool m_closed_state
 
std::unique_ptr< MD5SumFilterm_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
 

Detailed Description

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

Frame Reading FrameStreamPlanWrapper.

Member Typedef Documentation

typedef std::istream::char_type FrameCPP::Common::IStream::char_type
inherited
typedef std::unique_ptr<CheckSumFilter> FrameCPP::Common::StreamBase::checksum_filter_type
protectedinherited
typedef const Dictionary::streamref_type::element_type* FrameCPP::Common::StreamBase::const_stream_ref_ptr_type
inherited
typedef LDASTools::AL::SharedPtr< RawData > FrameCPP::Common::IFrameStreamWrapper< DECL >::fr_raw_data_type
inherited
typedef LDASTools::AL::SharedPtr< FrameH > FrameCPP::Common::IFrameStreamWrapper< DECL >::frame_h_type
inherited
typedef FrHeader::frame_library_type FrameCPP::Common::FrameStream::frame_library_type
inherited
typedef std::istream FrameCPP::Common::IStream::istream_type
inherited
typedef FrHeader::library_revision_type FrameCPP::Common::FrameStream::library_revision_type
inherited
typedef std::unique_ptr< MD5SumFilter > FrameCPP::Common::StreamBase::md5sum_filter_type
protectedinherited
typedef LDASTools::AL::SharedPtr< FrameSpec::Object > FrameCPP::Common::StreamBase::object_type
inherited
typedef LDASTools::AL::SharedPtr< PTR_STRUCT_BASE > FrameCPP::Common::StreamBase::ptr_struct_base_type
protectedinherited
typedef std::list< resolver_type > FrameCPP::Common::IStream::resolver_container_type
protectedinherited
typedef LDASTools::AL::SharedPtr< resolver > FrameCPP::Common::IStream::resolver_type
protectedinherited
typedef LDASTools::AL::unordered_map< INT_2U, INT_2U > FrameCPP::Common::StreamBase::streamid_to_fsiid_type
protectedinherited
typedef LDASTools::AL::SharedPtr< FrTOC > FrameCPP::Common::IFrameStream::toc_type
protectedinherited

Constructor & Destructor Documentation

template<DECL >
FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::IFrameStreamPlanWrapper ( buffer_type Stream,
plan_type master = 0 
)
inline

Member Function Documentation

void FrameCPP::Common::IFrameStream::addRecursiveDependant ( ptr_struct_base_type  Ref)
protectedvirtualinherited
void FrameCPP::Common::IFrameStream::addRecursiveDependant ( const StreamRefInterface StreamRef)
protectedinherited
IFrameStream::object_type FrameCPP::Common::IFrameStream::advanceToFrame ( INT_4U  Frame)
protectedinherited
bool FrameCPP::Common::IStream::ByteSwapping ( ) const
inlineinherited
void FrameCPP::Common::IStream::byteSwapping ( bool  Value)
inlineprotectedinherited
void FrameCPP::Common::IFrameStream::Cleanup ( )
virtualinherited

Reimplemented from FrameCPP::Common::IStream.

FrameStream::frame_library_type FrameCPP::Common::FrameStream::FrameLibrary ( ) const
inlineinherited
void FrameCPP::Common::FrameStream::frameLibrary ( frame_library_type  FrameLibrary)
inlineprotectedinherited
std::string FrameCPP::Common::IFrameStreamWrapper< DECL >::FrameLibraryName ( ) const
inherited
void FrameCPP::Common::FrameStream::frameSpecInfo ( const FrameSpec::Info Spec)
protectedvirtualinherited

Reimplemented from FrameCPP::Common::StreamBase.

const FrameSpec::Info & FrameCPP::Common::StreamBase::frameSpecInfo ( ) const
inlineprotectedinherited
CheckSumFilter * FrameCPP::Common::IStream::GetCheckSumFile ( ) const
inlineinherited
CheckSumFilter * FrameCPP::Common::IStream::GetCheckSumFrame ( ) const
inlineinherited
CheckSumFilter * FrameCPP::Common::IStream::GetCheckSumObject ( ) const
inlineinherited
INT_2U FrameCPP::Common::StreamBase::GetClassId ( const std::string &  ClassName) const
inherited
IFrameStream::size_type FrameCPP::Common::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.
const Dictionary & FrameCPP::Common::StreamBase::GetDictionary ( ) const
inlineinherited
Dictionary & FrameCPP::Common::StreamBase::GetDictionary ( )
inlineinherited
const FrHeader & FrameCPP::Common::IFrameStream::GetFrHeader ( ) const
inlinevirtualinherited

Reimplemented from FrameCPP::Common::IStream.

INT_2U FrameCPP::Common::StreamBase::GetFSIId ( INT_2U  StreamId) const
inlineinherited
const std::string & FrameCPP::Common::FrameStream::GetLastError ( ) const
inlineinherited
const MD5Sum & FrameCPP::Common::FrameStream::GetMD5Sum ( ) const
inlineinherited
INT_4U FrameCPP::Common::IFrameStream::GetNumberOfFrames ( ) const
inlineinherited
const FrTOC * FrameCPP::Common::IFrameStream::GetTOC ( ) const
inlineinherited
IFrameStream::toc_type FrameCPP::Common::IFrameStream::getTOC ( )
inlineprotectedinherited
FrameStream::library_revision_type FrameCPP::Common::FrameStream::LibraryRevision ( ) const
inlineinherited
void FrameCPP::Common::FrameStream::libraryRevision ( library_revision_type  LibraryRevision)
inlineprotectedinherited
FrameStream::version_type FrameCPP::Common::FrameStream::memoryVersion ( ) const
inlineprotectedinherited
IFrameStream::ptr_struct_base_type FrameCPP::Common::IFrameStream::Next ( object_type::element_type *  Obj)
protectedvirtualinherited

Reimplemented from FrameCPP::Common::IStream.

IStream::ptr_struct_base_type FrameCPP::Common::IStream::Next ( object_type  Obj)
virtualinherited
Dictionary::ptr_struct_key_type FrameCPP::Common::IStream::NextLookup ( object_type  Obj) const
inlineinherited
void FrameCPP::Common::IStream::nextReplace ( object_type  OldObj,
object_type  NewObj 
)
inlineprotectedinherited
IStream::object_type FrameCPP::Common::IStream::objectLookup ( object_type::element_type *  Pointer)
inlineprotectedinherited
template<typename T >
IStream & FrameCPP::Common::IStream::operator>> ( LDASTools::AL::SharedPtr< T > *  Data)
inlineinherited
template<typename T , const std::string &(T::*)() const F>
IStream & FrameCPP::Common::IStream::operator>> ( SearchContainer< T, F > &  SC)
inlineinherited
template<typename T >
IStream & FrameCPP::Common::IStream::operator>> ( Container< T > &  C)
inlineinherited
template<typename L >
IStream & FrameCPP::Common::IStream::operator>> ( STRING< L > &  String)
inlineinherited
template<typename L >
IStream & FrameCPP::Common::IStream::operator>> ( STRING_SHADOW< L > &  String)
inlineinherited
template<typename L >
IStream & FrameCPP::Common::IStream::operator>> ( std::vector< STRING< L > > &  String)
inlineinherited
template<typename DT >
IStream & FrameCPP::Common::IStream::operator>> ( std::vector< DT > &  Data)
inlineinherited
template<typename DT >
IStream & FrameCPP::Common::IStream::operator>> ( DT &  Data)
inlineinherited
template<typename T , typename S>
IStream & FrameCPP::Common::IStream::operator>> ( IStream::Resizer< T, S >  Value)
inlineinherited
template<>
IStream& FrameCPP::Common::IStream::operator>> ( LDASTools::AL::GPSTime &  Data)
inlineinherited
cmn_streamsize_type FrameCPP::Common::StreamBase::PtrStructBytes ( ) const
inlineinherited
template<typename T >
void FrameCPP::Common::IStream::PushPtr ( LDASTools::AL::SharedPtr< T > *  Obj)
inlineinherited
template<typename T >
void FrameCPP::Common::IStream::PushRef ( Container< T > &  C)
inlineinherited
void FrameCPP::Common::IFrameStream::pushResolver ( resolver_type  Resolver)
protectedvirtualinherited

Reimplemented from FrameCPP::Common::IStream.

IStream::buffer_type * FrameCPP::Common::IStream::rdbuf ( ) const
inlineinherited
IFrameStream::object_type FrameCPP::Common::IFrameStream::Read ( )
inherited
Todo:
Check if read goes beyond the end of the file
IStream & FrameCPP::Common::IStream::read ( char_type S,
std::streamsize  N 
)
inlineinherited
IFrameStream::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.
template<DECL >
IFrameStreamPlanWrapper< DECL_PARAMS >::fr_adc_data_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrAdcData ( frame_offset_type  Frame,
INT_4U  Channel 
)
inline

Extract the requested FrAdcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelZero based index of channel being requested.
Returns
Upon success, a non-NULL pointer to the FrAdcData is returned. Upon failure, either an exception is thrown
template<DECL >
IFrameStreamPlanWrapper< DECL_PARAMS >::fr_adc_data_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrAdcData ( frame_offset_type  Frame,
const std::string &  Channel 
)
inline

Extract the requested FrAdcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrAdcData is returned. Upon failure, either an exception is thrown
IFrameStream::object_type FrameCPP::Common::IFrameStream::readFrAdcData ( INT_4U  Frame,
const std::string &  Channel 
)
protectedinherited
IFrameStream::object_type FrameCPP::Common::IFrameStream::readFrAdcData ( INT_4U  Frame,
INT_4U  Channel 
)
protectedinherited
fr_adc_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrAdcStruct ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrAdcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrAdcData is returned. Upon failure, either an exception is thrown
fr_adc_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrAdcStruct ( frame_offset_type  Frame,
INT_4U  Channel 
)
inherited

Extract the requested FrAdcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelZero based index of channel being requested.
Returns
Upon success, a non-NULL pointer to the FrAdcData is returned. Upon failure, either an exception is thrown
IFrameStream::object_type FrameCPP::Common::IFrameStream::readFrAdcStruct ( INT_4U  Frame,
const std::string &  Channel 
)
protectedinherited
IFrameStream::object_type FrameCPP::Common::IFrameStream::readFrAdcStruct ( INT_4U  Frame,
INT_4U  Channel 
)
protectedinherited
IFrameStream::object_type FrameCPP::Common::IFrameStream::ReadFrame ( bool  Decompress = false)
inlineinherited
frame_h_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrameH ( frame_offset_type  Frame,
INT_4U  ContainerSet 
)
inherited

Extract the requested FrameH structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ContainerSetBit map of components to included.
Returns
Upon successful completion, the address of the FrameH structure linked with all requested subcomponents by ContainerSet.
IFrameStream::object_type FrameCPP::Common::IFrameStream::readFrameHSubset ( INT_4U  Frame,
INT_4U  ElementMask 
)
protectedinherited
IFrameStream::object_type FrameCPP::Common::IFrameStream::ReadFrameN ( INT_4U  FrameIndex,
bool  Decompress = false 
)
inherited
IFrameStream::object_type FrameCPP::Common::IFrameStream::ReadFrameNSubset ( INT_4U  FrameIndex,
INT_4U  ElementMask 
)
inlineinherited
template<DECL >
IFrameStreamPlanWrapper< DECL_PARAMS >::fr_event_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrEvent ( frame_offset_type  Frame,
const std::string &  Channel 
)
inline

Extract the requested FrEvent structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrEvent is returned. Upon failure, either an exception is thrown
template<DECL >
IFrameStreamPlanWrapper< DECL_PARAMS >::fr_event_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrEvent ( const std::string &  EventType,
fr_event_offset_type  Offset 
)
inline

Extract the requested FrEvent structure from the stream.

Parameters
[in]EventTypeName of the event type being requested.
[in]OffsetIndex into the Event array for the Event type
Returns
Upon success, a non-NULL pointer to the FrEvent is returned. Upon failure, either an exception is thrown
IFrameStream::object_type FrameCPP::Common::IFrameStream::readFrEvent ( INT_4U  Frame,
const std::string &  Channel 
)
protectedinherited
IFrameStream::object_type FrameCPP::Common::IFrameStream::readFrEvent ( const std::string &  EventType,
fr_event_offset_type  Offset 
)
protectedinherited
fr_event_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrEventStruct ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrEvent structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrEvent is returned. Upon failure, either an exception is thrown
IFrameStream::object_type FrameCPP::Common::IFrameStream::readFrEventStruct ( INT_4U  Frame,
const std::string &  Channel 
)
protectedinherited
template<DECL >
IFrameStreamPlanWrapper< DECL_PARAMS >::fr_proc_data_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrProcData ( frame_offset_type  Frame,
const std::string &  Channel 
)
inline

Extract the requested FrProcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrProcData is returned. Upon failure, either an exception is thrown
fr_proc_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrProcData ( frame_offset_type  Frame,
INT_4U  Channel 
)
inherited

Extract the requested FrProcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelZero based index of channel being requested.
Returns
Upon success, a non-NULL pointer to the FrProcData is returned. Upon failure, either an exception is thrown
IFrameStream::object_type FrameCPP::Common::IFrameStream::readFrProcData ( INT_4U  Frame,
const std::string &  Channel 
)
protectedinherited
IFrameStream::object_type FrameCPP::Common::IFrameStream::readFrProcData ( INT_4U  Frame,
INT_4U  Channel 
)
protectedinherited
fr_proc_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrProcStruct ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrProcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrProcData is returned. Upon failure, either an exception is thrown
fr_proc_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrProcStruct ( frame_offset_type  Frame,
INT_4U  Channel 
)
inherited

Extract the requested FrProcData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelZero based index of channel being requested.
Returns
Upon success, a non-NULL pointer to the FrProcData is returned. Upon failure, either an exception is thrown
IFrameStream::object_type FrameCPP::Common::IFrameStream::readFrProcStruct ( INT_4U  Frame,
const std::string &  Channel 
)
protectedinherited
IFrameStream::object_type FrameCPP::Common::IFrameStream::readFrProcStruct ( INT_4U  Frame,
INT_4U  Channel 
)
protectedinherited

Extract the requested FrRawData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
Returns
Upon success, a non-NULL pointer to the FrRawData is returned. Upon failure, either an exception is thrown
object_type FrameCPP::Common::IFrameStream::readFrRawData ( INT_4U  Frame)
protectedinherited
template<DECL >
IFrameStreamPlanWrapper< DECL_PARAMS >::fr_ser_data_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrSerData ( frame_offset_type  Frame,
const std::string &  Channel 
)
inline

Extract the requested FrSerData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSerData is returned. Upon failure, either an exception is thrown
IFrameStream::object_type FrameCPP::Common::IFrameStream::readFrSerData ( INT_4U  Frame,
const std::string &  Channel 
)
protectedinherited
fr_ser_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrSerStruct ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrSerData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSerData is returned. Upon failure, either an exception is thrown
IFrameStream::object_type FrameCPP::Common::IFrameStream::readFrSerStruct ( INT_4U  Frame,
const std::string &  Channel 
)
protectedinherited
template<DECL >
IFrameStreamPlanWrapper< DECL_PARAMS >::fr_sim_data_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrSimData ( frame_offset_type  Frame,
const std::string &  Channel 
)
inline

Extract the requested FrSimData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSimData is returned. Upon failure, either an exception is thrown
IFrameStream::object_type FrameCPP::Common::IFrameStream::readFrSimData ( INT_4U  Frame,
const std::string &  Channel 
)
protectedinherited
template<DECL >
IFrameStreamPlanWrapper< DECL_PARAMS >::fr_sim_event_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrSimEvent ( frame_offset_type  Frame,
const std::string &  Channel 
)
inline

Extract the requested FrSimEvent structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSimEvent is returned. Upon failure, either an exception is thrown
template<DECL >
IFrameStreamPlanWrapper< DECL_PARAMS >::fr_sim_event_type FrameCPP::Common::IFrameStreamPlanWrapper< DECL >::ReadFrSimEvent ( const std::string &  SimEventType,
fr_event_offset_type  Offset 
)
inline

Extract the requested FrSimEvent structure from the stream.

Parameters
[in]SimEventTypeName of the simulated event type being requested.
[in]OffsetIndex into the SimEvent array for the SimEvent type
Returns
Upon success, a non-NULL pointer to the FrSimEvent is returned. Upon failure, either an exception is thrown
IFrameStream::object_type FrameCPP::Common::IFrameStream::readFrSimEvent ( INT_4U  Frame,
const std::string &  Channel 
)
protectedinherited
IFrameStream::object_type FrameCPP::Common::IFrameStream::readFrSimEvent ( const std::string &  SimEventType,
fr_sim_event_offset_type  Offset 
)
protectedinherited
fr_sim_event_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrSimEventStruct ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrSimEvent structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSimEvent is returned. Upon failure, either an exception is thrown
IFrameStream::object_type FrameCPP::Common::IFrameStream::readFrSimEventStruct ( INT_4U  Frame,
const std::string &  Channel 
)
protectedinherited
fr_sim_data_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadFrSimStruct ( frame_offset_type  Frame,
const std::string &  Channel 
)
inherited

Extract the requested FrSerData structure from the stream.

Parameters
[in]FrameZero based index of the frame.
[in]ChannelName of the channel being requested.
Returns
Upon success, a non-NULL pointer to the FrSimData is returned. Upon failure, either an exception is thrown
IFrameStream::object_type FrameCPP::Common::IFrameStream::readFrSimStruct ( INT_4U  Frame,
const std::string &  Channel 
)
protectedinherited
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
Todo:
Need to add support for reading the FrDetector for FrStatData structures where the FrStatData is before any FrameH structures.
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
frame_h_type FrameCPP::Common::IFrameStreamWrapper< DECL >::ReadNextFrame ( )
inherited

Extract the next FrameH structure from the stream.

Returns
Upon success, a pointer to a FrameH structure.
IFrameStream::object_type FrameCPP::Common::IFrameStream::readNextFrame ( )
protectedinherited
IFrameStream::object_type FrameCPP::Common::IFrameStream::ReadNextFrameAsObject ( )
inlineinherited
IFrameStream::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.
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.
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.

void FrameCPP::Common::IFrameStream::readRecursive ( INT_4U  StopOnClassId,
bool  Decompress = false 
)
protectedinherited
LDASTools::AL::SharedPtr< StreamRefInterface > FrameCPP::Common::IFrameStream::readStreamRef ( )
protectedinherited
void FrameCPP::Common::IFrameStream::readTOC ( )
protectedinherited
StreamBase::const_stream_ref_ptr_type FrameCPP::Common::StreamBase::ReferenceStreamRef ( ) const
inherited
bool FrameCPP::Common::IFrameStream::removeRecursiveDependant ( const StreamRefInterface StreamRef)
protectedinherited
void FrameCPP::Common::IStream::RemoveResolver ( const void *  Old,
int  MaxDepth 
)
inlineinherited
template<typename T_NEW , typename T_OLD >
void FrameCPP::Common::IStream::ReplacePtr ( LDASTools::AL::SharedPtr< T_NEW > *  Obj,
LDASTools::AL::SharedPtr< T_OLD > *  OldPtr,
const int  MaxDepth 
)
inlineinherited
template<typename T , typename OT >
void FrameCPP::Common::IStream::ReplaceRef ( Container< T > &  C,
const Container< OT > &  Old,
const int  MaxDepth 
)
inlineinherited
void FrameCPP::Common::IFrameStream::reset ( )
protectedvirtualinherited

Reimplemented from FrameCPP::Common::FrameStream.

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

Method to resolve links.

const IStream::resolver_container_type & FrameCPP::Common::IStream::resolverContainer ( ) const
inlineprotectedinherited
IStream::resolver_container_type & FrameCPP::Common::IStream::resolverContainer ( )
inlineprotectedinherited
void FrameCPP::Common::IFrameStream::seedTOCInfo ( const IFrameStream Source)
inlineprotectedinherited
void FrameCPP::Common::IFrameStream::SetAutoDeleteBuffer ( const bool  AutoDelete)
inlineinherited
void FrameCPP::Common::IStream::setAutoDeleteBuffer ( const bool  Value)
inlineprotectedinherited
void FrameCPP::Common::IFrameStream::SetCheckSumFile ( const CheckSum::kind_type  Type)
inlineinherited
void FrameCPP::Common::IStream::SetCheckSumFrame ( const CheckSum::kind_type  Type)
inlineinherited
void FrameCPP::Common::IStream::SetCheckSumObject ( const CheckSum::kind_type  Type)
inlineinherited
void FrameCPP::Common::FrameStream::setLastError ( const std::string &  Message)
inlineprotectedinherited
void FrameCPP::Common::IFrameStream::SetMD5Sum ( bool  Value)
inlineinherited
void FrameCPP::Common::FrameStream::setTOC ( )
protectedinherited
cmn_streamsize_type FrameCPP::Common::IStream::Size ( )
inlineinherited

Return the size of the stream.

Returns
The number of bytes that compose the stream
const StreamRefInterface & FrameCPP::Common::FrameStream::streamRef ( ) const
inlineprotectedinherited
FrameStream::version_type FrameCPP::Common::FrameStream::streamVersion ( ) const
inlineprotectedinherited
FrameSpec::Info::verification_func_type FrameCPP::Common::IFrameStream::VerificationFunc ( ) const
inlineinherited
void FrameCPP::Common::IFrameStream::VerifyHeader ( Verify Verifier)
inherited
FrameStream::version_type FrameCPP::Common::FrameStream::Version ( ) const
inlineinherited
void FrameCPP::Common::FrameStream::version_stream ( version_type  Version)
inlineprotectedinherited

Member Data Documentation

bool FrameCPP::Common::FrameStream::m_closed_state
protectedinherited
Dictionary FrameCPP::Common::StreamBase::m_dictionary
protectedinherited
checksum_filter_type FrameCPP::Common::StreamBase::m_file_checksum
protectedinherited

Checksum for file.

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

MD5Sum value for the files.

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

Checksum for frame.

bool FrameCPP::Common::IStream::m_logNextPtr
protectedinherited
std::unique_ptr< MD5SumFilter > FrameCPP::Common::FrameStream::m_md5sumFilter
protectedinherited
object_type FrameCPP::Common::StreamBase::m_null_stream_ref
protectedinherited
checksum_filter_type FrameCPP::Common::StreamBase::m_obj_checksum
protectedinherited

Checksum for object.

ptr_struct_base_type FrameCPP::Common::StreamBase::m_ptr_struct_object
protectedinherited
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: