ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_9::FrTOC Class Reference

Table of Contents Data Structure Definition. More...

#include <FrTOC.hh>

Public Types

typedef std::vector< data_quality_type > data_quality_container_type
 Array of integer QA words from each FrameH.
 
typedef std::vector< dt_type > dt_container_type
 Array of frame durations in seconds.
 
typedef std::vector< gtimen_type > gtimen_container_type
 Array of integer GPS residual nanoseconds for the frame.
 
typedef std::vector< gtimes_type > gtimes_container_type
 Array of integer GPS frame times.
 
typedef std::vector< namedetector_type > namedetector_container_type
 Array of FrDetector names.
 
typedef std::vector< positiondetector_type > positiondetector_container_type
 Array of FrDetector positions.
 
typedef std::vector< positionh_type > positionh_container_type
 Array of FrSH IDs.
 
typedef std::vector< shid_type > shid_container_type
 Array of FrSH IDs.
 
typedef std::vector< shname_type > shname_container_type
 Array of FrSH names.
 
typedef std::map< name_type, adc_info_type > MapADC_type
 Container of indexed FrAdcData elements.
 

Public Member Functions

 FrTOC ()=default
 Default constructor.
 
 FrTOC (const FrTOC &Source)=default
 Copy Constructor.
 
 FrTOC (const FrameCPP::Common::FrTOC *Source)
 Constructor.
 
virtual void ForEach (query_info_type Info, FunctionBase &Action) const
 Iterate over elements of the Table of Contents.
 
virtual void IndexObject (object_type Object, std::streampos Position)
 Place information about an object into the TOC.
 
virtual FrTOCCreate () const
 Virtual constructor.
 
virtual void FrStatDataQuery (const std::string &NamePattern, const LDASTools::AL::GPSTime &StartTime, const LDASTools::AL::GPSTime &EndTime, const INT_4U Version, Common::FrStatData::Query &Result) const
 Retieve FrStatData data.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator
 
 FrTOC ()=default
 Default constructor.
 
 FrTOC (const FrTOC &Source)=default
 Copy Constructor.
 
 FrTOC (const FrameCPP::Common::FrTOC *Source)
 Constructor.
 
virtual void ForEach (query_info_type Info, FunctionBase &Action) const
 Iterate over elements of the Table of Contents.
 
virtual void IndexObject (object_type Object, std::streampos Position)
 Place information about an object into the TOC.
 
virtual FrTOCCreate () const
 Virtual constructor.
 
virtual void FrStatDataQuery (const std::string &NamePattern, const LDASTools::AL::GPSTime &StartTime, const LDASTools::AL::GPSTime &EndTime, const INT_4U Version, Common::FrStatData::Query &Result) const
 Retieve FrStatData data.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator
 
virtual INT_4U GetTOCChecksum ()
 Return TOC identifying checksum.
 
virtual INT_4U GetTOCChecksum ()
 Return TOC identifying checksum.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
void Load (istream_type &Stream)
 Read contents from stream.
 
void Load (istream_type &Stream)
 Read contents from stream.
 
void Load (istream_type &Stream, INT_4U FrameCount)
 Read contents from stream.
 
void Load (istream_type &Stream, INT_4U FrameCount)
 Read contents from stream.
 
void Load (istream_type &Stream, INT_4U FrameCount)
 Read contents from stream.
 
void Load (istream_type &Stream, INT_4U FrameCount)
 Read contents from stream.
 
void Load (istream_type &Stream)
 Read contents from stream.
 
void Load (istream_type &Stream)
 Read contents from stream.
 
const file_base_name_type & GetFileBaseName () const
 Retrieve file base name at time of creation.
 
const data_quality_container_type & GetDataQuality () const
 Retreive array of integer QA words from each FrameH.
 
const dt_container_type & GetDt () const
 Retrieve array of frame durations in seconds.
 
const gtimes_container_type & GetGTimeN () const
 Retrieve array of integer GPS residual nanoseconds for the frame.
 
const gtimen_container_type & GetGTimeS () const
 Retrieve array of integer GPS frame times.
 
const positionh_container_type & GetPositionH () const
 Retrieve array of FrameH positions.
 
const shid_container_type & GetSHid () const
 Retrieve array of FrSH IDs.
 
const shname_container_type & GetSHname () const
 Retrieve array of FrSH names.
 
const namedetector_container_type & GetNameDetector () const
 Retrieve array of FrDetector names.
 
const positiondetector_container_type & GetPositionDetector () const
 Retrieve array of FrDetector positions.
 
void SetFileBaseName (const file_base_name_type &Source) const
 Set file base name.
 
bool operator== (const FrTOCProcDataClassicIO &RHS) const
 equality operator
 
bool operator== (const FrTOCSimDataClassicIO &RHS) const
 equality operator
 
bool operator== (const FrTOCHeader &RHS) const
 equality operator
 
bool operator== (const FrTOCAdcData &RHS) const
 equality operator
 
void QueryAdc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrAdcData being written.
 
void QueryAdc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrAdcData being written.
 
const MapADC_type & GetADC () const
 Return all channels.
 
MapADC_type::const_iterator GetADC (const std::string &Name) const
 Return the indexed data for a named channel.
 
MapADC_type::const_iterator GetADC (INT_4U Channel) const
 Return the indexed data for an indexed channel.
 
const key_container_type & GetKeys () const
 Retrieve the keys.
 
const key_container_type & GetKeys () const
 Retrieve the keys.
 
void QueryProc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrProcData being written.
 
void QueryProc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrProcData being written.
 
const MapProc_type & GetProc () const
 Return all channels.
 
MapProc_type::const_iterator GetProc (const std::string &Channel) const
 Return the indexed data for a named channel.
 
MapProc_type::const_iterator GetProc (INT_4U Channel) const
 Return the indexed data for a named channel.
 
void QuerySim (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSimData being written.
 
void QuerySim (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSimData being written.
 
const MapSim_type & GetSim () const
 Return all channels.
 
MapSim_type::const_iterator GetSim (const std::string &Channel) const
 Return the indexed data for a named channel.
 
MapSim_type::const_iterator GetSim (INT_4U Channel) const
 Return the indexed data for a named channel.
 
void QuerySer (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSerData being written.
 
void QuerySer (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSerData being written.
 
const MapSer_type & GetSer () const
 Return all channels.
 
MapSer_type::const_iterator GetSer (const std::string &Channel) const
 Return the indexed data for a named channel.
 
MapSer_type::const_iterator GetSer (INT_4U Channel) const
 Return the indexed data for a named channel.
 
void QuerySum (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSummary being written.
 
void QuerySum (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSummary being written.
 
const MapSummary_type & GetSummary () const
 Return all channels.
 
MapSummary_type::const_iterator GetSummary (const std::string &Channel) const
 Return the indexed data for a named channel.
 
MapSummary_type::const_iterator GetSummary (INT_4U Channel) const
 Return the indexed data for a named channel.
 
void QueryEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrEvent being written.
 
void QueryEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrEvent being written.
 
const nameEvent_container_type & GetEvent () const
 Return all events.
 
void QuerySimEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSimEvent being written.
 
void QuerySimEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSimEvent being written.
 
const nameSimEvent_container_type & GetSimEvent () const
 Return all events.
 

Static Public Member Functions

static const char * StructName ()
 The name structure name of this object.
 
static const char * StructName ()
 The name structure name of this object.
 
static const Common::Description * StructDescription ()
 The description of structure.
 
static const Common::Description * StructDescription ()
 The description of structure.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure.
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure.
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure.
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure.
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure.
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure.
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure.
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure.
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure.
 

Protected Member Functions

virtual void cacheAdcDataPositions (istream_type &Stream)
 Cache where the positions of the Adc channels.
 
virtual void seekAdcDataPositions (istream_type &Stream, Common::FrTOC::channel_id_type Channel)
 Advance to the specified Adc channel.
 
virtual void seekAdcDataPositions (istream_type &Stream, const std::string &Channel)
 Advance to the specified Adc channel.
 
virtual void procDataCachePositions (istream_type &Stream)
 Cache where the positions of the FrProcData channels.
 
virtual void cacheAdcDataPositions (istream_type &Stream)
 Cache where the positions of the Adc channels.
 
virtual void seekAdcDataPositions (istream_type &Stream, Common::FrTOC::channel_id_type Channel)
 Advance to the specified Adc channel.
 
virtual void seekAdcDataPositions (istream_type &Stream, const std::string &Channel)
 Advance to the specified Adc channel.
 
virtual void procDataCachePositions (istream_type &Stream)
 Cache where the positions of the FrProcData channels.
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Promotes object to another version of the frame spec.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Promotes object to another version of the frame spec.
 
virtual Common::FrameSpec::size_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual Common::FrameSpec::size_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream.
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream.
 
void Load (istream_type &Stream, INT_4U FrameCount)
 Read contents from stream.
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents.
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents.
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents.
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents.
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
void write (ostream_type &Stream) const
 Write the structure to the stream.
 
void write (ostream_type &Stream) const
 Write the structure to the stream.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
void cachePositions (istream_type &Stream)
 Cache where the positions of the Adc channels.
 
void cachePositions (istream_type &Stream)
 Cache where the positions of the Adc channels.
 
void cachePositions (istream_type &Stream)
 TOC optimization.
 
void seekPositions (istream_type &Stream, channel_id_type Channel)
 Advance to the specified Adc channel.
 
void seekPositions (istream_type &Stream, const std::string &Channel)
 Advance to the specified Adc channel.
 
void seekPositions (istream_type &Stream, channel_id_type Channel)
 Advance to the specified Adc channel.
 
void seekPositions (istream_type &Stream, const std::string &Channel)
 Advance to the specified Adc channel.
 

Protected Attributes

file_base_name_type fileBaseName
 The name of the file at the time of creation.
 
data_quality_container_type m_dataQuality
 Array of integer QA words from each FrameH (size of nFrame)
 
gtimes_container_type m_GTimeS
 Array of integer GPS frame times (size of nFrame).
 
gtimen_container_type m_GTimeN
 Array of integer GPS residual nanoseconds for the frame (size of nFrame).
 
dt_container_type m_dt
 Array of frame durations in seconds (size of nFrame).
 
positiondetector_container_type m_positionDetector
 Array of FrDetector positions.
 
positionh_container_type m_positionH
 Array of FrameH positions, in bytes, from beginning of file. The size of this array is specified by nFrame.
 
namedetector_container_type m_nameDetector
 Array of FrDetector names.
 
shid_container_type m_SHid
 Array of FrSH IDs.
 
shname_container_type m_SHname
 Array of FrSH names. The size of array is specified by nSH.
 

Detailed Description

Table of Contents Data Structure Definition.

Member Typedef Documentation

◆ MapADC_type

typedef std::map< name_type, adc_info_type > FrameCPP::v9::FrTOCAdcData::MapADC_type
inherited

Container of indexed FrAdcData elements.

This structure is ordered by the name of the FrAdcData channel name. There is one element for each channel of indexed data.

Constructor & Destructor Documentation

◆ FrTOC() [1/6]

FrameCPP::Version_9::FrTOC::FrTOC ( )
default

Default constructor.

Returns
A new instance of this object.

◆ FrTOC() [2/6]

FrameCPP::Version_9::FrTOC::FrTOC ( const FrTOC & Source)
default

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
Returns
A new instance of this object.

◆ FrTOC() [3/6]

FrameCPP::Version_9::FrTOC::FrTOC ( const FrameCPP::Common::FrTOC * Source)
explicit

Constructor.

Parameters
[in]Source
Returns
A new instance of this object.

◆ FrTOC() [4/6]

FrameCPP::Version_9::FrTOC::FrTOC ( )
default

Default constructor.

Returns
A new instance of this object.

◆ FrTOC() [5/6]

FrameCPP::Version_9::FrTOC::FrTOC ( const FrTOC & Source)
default

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
Returns
A new instance of this object.

◆ FrTOC() [6/6]

FrameCPP::Version_9::FrTOC::FrTOC ( const FrameCPP::Common::FrTOC * Source)
explicit

Constructor.

Parameters
[in]Source
Returns
A new instance of this object.

Member Function Documentation

◆ Bytes() [1/7]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Bytes ( const StreamBase & Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

◆ Bytes() [2/7]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Bytes ( const StreamBase & Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

◆ Bytes() [3/7]

Common::FrameSpec::size_type FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::Bytes ( const Common::StreamBase & Stream) const
inlineinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

◆ Bytes() [4/7]

Common::FrameSpec::size_type FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::Bytes ( const Common::StreamBase & Stream) const
inlineinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

◆ Bytes() [5/7]

Common::FrameSpec::size_type FrameCPP::Version_9::FrTOCImpl::FrTOCProcDataClassicIO::Bytes ( const Common::StreamBase & Stream) const
inlineinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

◆ Bytes() [6/7]

Common::FrameSpec::size_type FrameCPP::Version_9::FrTOCImpl::FrTOCSimDataClassicIO::Bytes ( const Common::StreamBase & Stream) const
inlineinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

◆ Bytes() [7/7]

Common::FrameSpec::size_type FrameCPP::Version_9::FrTOCImpl::FrTOCSimEventClassicIO::Bytes ( const Common::StreamBase & Stream) const
inlineinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

◆ cacheAdcDataPositions() [1/2]

virtual void FrameCPP::Version_9::FrTOC::cacheAdcDataPositions ( istream_type & Stream)
protectedvirtual

Cache where the positions of the Adc channels.

Parameters
[in,out]StreamThe Stream being read

◆ cacheAdcDataPositions() [2/2]

virtual void FrameCPP::Version_9::FrTOC::cacheAdcDataPositions ( istream_type & Stream)
protectedvirtual

Cache where the positions of the Adc channels.

Parameters
[in,out]StreamThe Stream being read

◆ cachePositions() [1/3]

void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::cachePositions ( istream_type & Stream)
inlineprotectedinherited

Cache where the positions of the Adc channels.

Parameters
[in,out]StreamThe Stream being read

◆ cachePositions() [2/3]

void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::cachePositions ( istream_type & Stream)
inlineprotectedinherited

Cache where the positions of the Adc channels.

Parameters
[in,out]StreamThe Stream being read

◆ cachePositions() [3/3]

void FrameCPP::Version_9::FrTOCImpl::FrTOCProcDataClassicIO::cachePositions ( istream_type & Stream)
inlineprotectedinherited

TOC optimization.

This method optimizes the TOC reading by only reading the structure offsets. Once read, it is moved into the structure.

◆ Create() [1/3]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ Create() [2/3]

virtual FrTOC * FrameCPP::Version_9::FrTOC::Create ( ) const
virtual

Virtual constructor.

Returns
A new instance of this object.

Reimplemented from FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ Create() [3/3]

virtual FrTOC * FrameCPP::Version_9::FrTOC::Create ( ) const
virtual

Virtual constructor.

Returns
A new instance of this object.

Reimplemented from FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ demote() [1/2]

template<typename T >
virtual demote_ret_type FrameCPP::Version_9::FrTOCImpl::ClassicIO< T >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

◆ demote() [2/2]

template<typename T >
virtual demote_ret_type FrameCPP::Version_9::FrTOCImpl::ClassicIO< T >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

◆ Description() [1/9]

template<typename SE >
static void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::Description ( Common::Description & Desc)
inlinestaticinherited

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.

◆ Description() [2/9]

template<typename SE >
static void FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::Description ( Common::Description & Desc)
inlinestaticinherited

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.

◆ Description() [3/9]

template<typename SE >
static void FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::Description ( Common::Description & Desc)
inlinestaticinherited

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.

◆ Description() [4/9]

template<typename SE >
static void FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::Description ( Common::Description & Desc)
inlinestaticinherited

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.

◆ Description() [5/9]

template<typename SE >
static void FrameCPP::Version_9::FrTOCImpl::FrTOCProcDataClassicIO::Description ( Common::Description & Desc)
inlinestaticinherited

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.

◆ Description() [6/9]

template<typename SE >
static void FrameCPP::Version_9::FrTOCImpl::FrTOCSerDataClassicIO::Description ( Common::Description & Desc)
inlinestaticinherited

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ Description() [7/9]

template<typename SE >
static void FrameCPP::Version_9::FrTOCImpl::FrTOCSimDataClassicIO::Description ( Common::Description & Desc)
inlinestaticinherited

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.

◆ Description() [8/9]

template<typename SE >
static void FrameCPP::Version_9::FrTOCImpl::FrTOCSimEventClassicIO::Description ( Common::Description & Desc)
inlinestaticinherited

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.

◆ Description() [9/9]

template<typename SE >
static void FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::Description ( Common::Description & Desc)
inlinestaticinherited

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ ForEach() [1/2]

virtual void FrameCPP::Version_9::FrTOC::ForEach ( query_info_type Info,
FunctionBase & Action ) const
virtual

Iterate over elements of the Table of Contents.

Parameters
[in]InfoType of objects upon which to iterate.
[in,out]ActionAction to be performed.

◆ ForEach() [2/2]

virtual void FrameCPP::Version_9::FrTOC::ForEach ( query_info_type Info,
FunctionBase & Action ) const
virtual

Iterate over elements of the Table of Contents.

Parameters
[in]InfoType of objects upon which to iterate.
[in,out]ActionAction to be performed.

◆ forEach() [1/5]

void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::forEach ( Common::FrTOC::query_info_type Info,
Common::FrTOC::FunctionBase & Action ) const
inlineprotectedinherited

Iterate over contents.

Parameters
[in]InfoSpecifies the type of information to be searched.
[in]ActionAction to be taken for each piece of information found.

◆ forEach() [2/5]

void FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::forEach ( Common::FrTOC::query_info_type Info,
Common::FrTOC::FunctionBase & Action ) const
inlineprotectedinherited

Iterate over contents.

Parameters
[in]InfoSpecifies the type of information to be searched.
[in]ActionAction to be taken for each piece of information found.

◆ forEach() [3/5]

void FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::forEach ( Common::FrTOC::query_info_type Info,
Common::FrTOC::FunctionBase & Action ) const
inlineprotectedinherited

Iterate over contents.

Parameters
[in]InfoSpecifies the type of information to be searched.
[in]ActionAction to be taken for each piece of information found.

◆ forEach() [4/5]

void FrameCPP::Version_9::FrTOCImpl::FrTOCProcDataClassicIO::forEach ( Common::FrTOC::query_info_type Info,
Common::FrTOC::FunctionBase & Action ) const
inlineprotectedinherited

Iterate over contents.

Parameters
[in]InfoSpecifies the type of information to be searched.
[in]ActionAction to be taken for each piece of information found.

◆ forEach() [5/5]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSimDataClassicIO::forEach ( Common::FrTOC::query_info_type Info,
Common::FrTOC::FunctionBase & Action ) const
inlineprotectedinherited

Iterate over contents.

Parameters
[in]InfoSpecifies the type of information to be searched.
[in]ActionAction to be taken for each piece of information found.

◆ FrStatDataQuery() [1/2]

virtual void FrameCPP::Version_9::FrTOC::FrStatDataQuery ( const std::string & NamePattern,
const LDASTools::AL::GPSTime & StartTime,
const LDASTools::AL::GPSTime & EndTime,
const INT_4U Version,
Common::FrStatData::Query & Result ) const
virtual

Retieve FrStatData data.

Parameters
[in]NamePatternRegular expression describing the FrStatData name of`` interest.
[in]StartTimeThe lower bound GPS time of the FrStatData start time.
[in]EndTimeThe upper bound GPS time of the FrStatData end time.
[in]VersionThe FrStatData version of interest.
[out]ResultAll FrStatData information that matched the query.
Deprecated
This method has been deprecated with the version 9 frame specification. If called, a runtime execption is thrown.

◆ FrStatDataQuery() [2/2]

virtual void FrameCPP::Version_9::FrTOC::FrStatDataQuery ( const std::string & NamePattern,
const LDASTools::AL::GPSTime & StartTime,
const LDASTools::AL::GPSTime & EndTime,
const INT_4U Version,
Common::FrStatData::Query & Result ) const
virtual

Retieve FrStatData data.

Parameters
[in]NamePatternRegular expression describing the FrStatData name of`` interest.
[in]StartTimeThe lower bound GPS time of the FrStatData start time.
[in]EndTimeThe upper bound GPS time of the FrStatData end time.
[in]VersionThe FrStatData version of interest.
[out]ResultAll FrStatData information that matched the query.
Deprecated
This method has been deprecated with the version 9 frame specification. If called, a runtime execption is thrown.

◆ GetADC() [1/3]

const FrTOCAdcData::MapADC_type & FrameCPP::v9::FrTOCAdcData::GetADC ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrAdcData elements.

◆ GetADC() [2/3]

FrTOCAdcData::MapADC_type::const_iterator FrameCPP::v9::FrTOCAdcData::GetADC ( const std::string & Name) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]ChannelThe name of the channel.
Returns
Constant iterator to the indexed FrAdcData element.

◆ GetADC() [3/3]

FrTOCAdcData::MapADC_type::const_iterator FrameCPP::v9::FrTOCAdcData::GetADC ( INT_4U Channel) const
inlineinherited

Return the indexed data for an indexed channel.

Parameters
[in]ChannelThe numeric offset of the channel.
Returns
Constant iterator to the indexed FrAdcData element.

◆ GetEvent()

const nameEvent_container_type & FrameCPP::v8::FrTOCEvent::GetEvent ( ) const
inlineinherited

Return all events.

Returns
Constant container to the indexed FrEvent elements.

◆ GetKeys() [1/2]

const key_container_type & FrameCPP::v8::FrTOCProcData::GetKeys ( ) const
inlineinherited

Retrieve the keys.

Returns
Constant container of keys.

◆ GetKeys() [2/2]

const FrTOCAdcData::key_container_type & FrameCPP::v9::FrTOCAdcData::GetKeys ( ) const
inlineinherited

Retrieve the keys.

Returns
Constant container of keys.

◆ GetProc() [1/3]

const MapProc_type & FrameCPP::v8::FrTOCProcData::GetProc ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrProcData elements.

◆ GetProc() [2/3]

MapProc_type::const_iterator FrameCPP::v8::FrTOCProcData::GetProc ( const std::string & Channel) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]ChannelThe name of the channel.
Returns
Constant iterator to the indexed FrProcData element.

◆ GetProc() [3/3]

MapProc_type::const_iterator FrameCPP::v8::FrTOCProcData::GetProc ( INT_4U Channel) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]ChannelThe numeric offset of the channel.
Returns
Constant iterator to the indexed FrProcData element.

◆ GetSer() [1/3]

const MapSer_type & FrameCPP::v8::FrTOCSerData::GetSer ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrSerData elements.

◆ GetSer() [2/3]

MapSer_type::const_iterator FrameCPP::v8::FrTOCSerData::GetSer ( const std::string & Channel) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]ChannelThe name of the channel.
Returns
Constant iterator to the indexed FrSerData element.

◆ GetSer() [3/3]

MapSer_type::const_iterator FrameCPP::v8::FrTOCSerData::GetSer ( INT_4U Channel) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]ChannelThe numeric offset of the channel.
Returns
Constant iterator to the indexed FrSerData element.

◆ GetSim() [1/3]

const MapSim_type & FrameCPP::v8::FrTOCSimData::GetSim ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrSimData elements.

◆ GetSim() [2/3]

MapSim_type::const_iterator FrameCPP::v8::FrTOCSimData::GetSim ( const std::string & Channel) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]ChannelThe name of the channel.
Returns
Constant iterator to the indexed FrSimData element.

◆ GetSim() [3/3]

MapSim_type::const_iterator FrameCPP::v8::FrTOCSimData::GetSim ( INT_4U Channel) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]ChannelThe numeric offset of the channel.
Returns
Constant iterator to the indexed FrSimData element.

◆ GetSimEvent()

const nameSimEvent_container_type & FrameCPP::v8::FrTOCSimEvent::GetSimEvent ( ) const
inlineinherited

Return all events.

Returns
Constant container to the indexed FrSimEvent elements.

◆ GetSummary() [1/3]

const MapSummary_type & FrameCPP::v8::FrTOCSummary::GetSummary ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrSummary elements.

◆ GetSummary() [2/3]

MapSummary_type::const_iterator FrameCPP::v8::FrTOCSummary::GetSummary ( const std::string & Channel) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]ChannelThe name of the channel.
Returns
Constant iterator to the indexed FrSummary element.

◆ GetSummary() [3/3]

MapSummary_type::const_iterator FrameCPP::v8::FrTOCSummary::GetSummary ( INT_4U Channel) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]ChannelThe numeric offset of the channel.
Returns
Constant iterator to the indexed FrSummary element.

◆ GetTOCChecksum() [1/2]

template<typename T >
virtual INT_4U FrameCPP::Version_9::FrTOCImpl::ClassicIO< T >::GetTOCChecksum ( )
inlinevirtualinherited

Return TOC identifying checksum.

The CRC checksum that characterizes this Table of Contents.

Returns
The checksum that characterizes this Table of Contents structure

◆ GetTOCChecksum() [2/2]

template<typename T >
virtual INT_4U FrameCPP::Version_9::FrTOCImpl::ClassicIO< T >::GetTOCChecksum ( )
inlinevirtualinherited

Return TOC identifying checksum.

The CRC checksum that characterizes this Table of Contents.

Returns
The checksum that characterizes this Table of Contents structure

◆ IndexObject() [1/2]

virtual void FrameCPP::Version_9::FrTOC::IndexObject ( object_type Object,
std::streampos Position )
virtual

Place information about an object into the TOC.

Parameters
[in]ObjectObject from which to extract information for the TOC.
[in]PositionStream position where object begins.

◆ IndexObject() [2/2]

virtual void FrameCPP::Version_9::FrTOC::IndexObject ( object_type Object,
std::streampos Position )
virtual

Place information about an object into the TOC.

Parameters
[in]ObjectObject from which to extract information for the TOC.
[in]PositionStream position where object begins.

◆ Load() [1/9]

void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::Load ( istream_type & Stream,
INT_4U FrameCount )
protectedinherited

Read contents from stream.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

◆ Load() [2/9]

void FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::Load ( istream_type & Stream)
inlineinherited

Read contents from stream.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

◆ Load() [3/9]

void FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::Load ( istream_type & Stream)
inlineinherited

Read contents from stream.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

◆ Load() [4/9]

void FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::Load ( istream_type & Stream)
inlineinherited

Read contents from stream.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

◆ Load() [5/9]

void FrameCPP::Version_9::FrTOCImpl::FrTOCProcDataClassicIO::Load ( istream_type & Stream,
INT_4U FrameCount )
inherited

Read contents from stream.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

◆ Load() [6/9]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSerDataClassicIO::Load ( istream_type & Stream,
INT_4U FrameCount )
inlineinherited

Read contents from stream.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

◆ Load() [7/9]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSimDataClassicIO::Load ( istream_type & Stream,
INT_4U FrameCount )
inherited

Read contents from stream.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

◆ Load() [8/9]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSimEventClassicIO::Load ( istream_type & Stream)
inlineinherited

Read contents from stream.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

◆ Load() [9/9]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::Load ( istream_type & Stream,
INT_4U FrameCount )
inlineinherited

Read contents from stream.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

◆ ObjectStructName() [1/2]

virtual const char * FrameCPP::Version_9::FrTOC::ObjectStructName ( ) const
virtual

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ ObjectStructName() [2/2]

virtual const char * FrameCPP::Version_9::FrTOC::ObjectStructName ( ) const
virtual

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ operator==() [1/6]

bool FrameCPP::v9::FrTOCAdcData::operator== ( const FrTOCAdcData & RHS) const
inherited

equality operator

Parameters
[in]RHSThe FrTOCAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [2/6]

bool FrameCPP::v9::FrTOCHeader::operator== ( const FrTOCHeader & RHS) const
inlineinherited

equality operator

Parameters
[in]RHSThe FrTOCData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [3/6]

virtual bool FrameCPP::Version_9::FrTOC::operator== ( const Common::FrameSpec::Object & RHS) const
virtual

equality operator

Parameters
[in]RHSThe FrAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [4/6]

virtual bool FrameCPP::Version_9::FrTOC::operator== ( const Common::FrameSpec::Object & RHS) const
virtual

equality operator

Parameters
[in]RHSThe FrAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [5/6]

bool FrameCPP::Version_9::FrTOCImpl::FrTOCProcDataClassicIO::operator== ( const FrTOCProcDataClassicIO & RHS) const
inherited

equality operator

Parameters
[in]RHSThe FrTOCProcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [6/6]

bool FrameCPP::Version_9::FrTOCImpl::FrTOCSimDataClassicIO::operator== ( const FrTOCSimDataClassicIO & RHS) const
inherited

equality operator

Parameters
[in]RHSThe FrTOCAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ pBytes() [1/2]

template<typename T >
virtual Common::FrameSpec::size_type FrameCPP::Version_9::FrTOCImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtualinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

◆ pBytes() [2/2]

template<typename T >
virtual Common::FrameSpec::size_type FrameCPP::Version_9::FrTOCImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtualinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

◆ pCreate() [1/2]

template<typename T >
virtual self_type * FrameCPP::Version_9::FrTOCImpl::ClassicIO< T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

◆ pCreate() [2/2]

template<typename T >
virtual self_type * FrameCPP::Version_9::FrTOCImpl::ClassicIO< T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

◆ procDataCachePositions() [1/2]

virtual void FrameCPP::Version_9::FrTOC::procDataCachePositions ( istream_type & Stream)
protectedvirtual

Cache where the positions of the FrProcData channels.

Parameters
[in,out]StreamThe Stream being read

◆ procDataCachePositions() [2/2]

virtual void FrameCPP::Version_9::FrTOC::procDataCachePositions ( istream_type & Stream)
protectedvirtual

Cache where the positions of the FrProcData channels.

Parameters
[in,out]StreamThe Stream being read

◆ promote() [1/2]

template<typename T >
virtual promote_ret_type FrameCPP::Version_9::FrTOCImpl::ClassicIO< T >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object promoted to the next generation.

◆ promote() [2/2]

template<typename T >
virtual promote_ret_type FrameCPP::Version_9::FrTOCImpl::ClassicIO< T >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object promoted to the next generation.

◆ pWrite() [1/2]

template<typename T >
virtual void FrameCPP::Version_9::FrTOCImpl::ClassicIO< T >::pWrite ( Common::OStream & Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ pWrite() [2/2]

template<typename T >
virtual void FrameCPP::Version_9::FrTOCImpl::ClassicIO< T >::pWrite ( Common::OStream & Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ QueryAdc() [1/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::QueryAdc ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inlineinherited

Gather TOC info for FrAdcData being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ QueryAdc() [2/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::QueryAdc ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inlineinherited

Gather TOC info for FrAdcData being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ QueryEvent() [1/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::QueryEvent ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inlineinherited

Gather TOC info for FrEvent being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ QueryEvent() [2/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::QueryEvent ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inlineinherited

Gather TOC info for FrEvent being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ QueryProc() [1/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCProcDataClassicIO::QueryProc ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inlineinherited

Gather TOC info for FrProcData being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ QueryProc() [2/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCProcDataClassicIO::QueryProc ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inlineinherited

Gather TOC info for FrProcData being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ QuerySer() [1/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSerDataClassicIO::QuerySer ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inlineinherited

Gather TOC info for FrSerData being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ QuerySer() [2/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSerDataClassicIO::QuerySer ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inlineinherited

Gather TOC info for FrSerData being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ QuerySim() [1/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSimDataClassicIO::QuerySim ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inlineinherited

Gather TOC info for FrSimData being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ QuerySim() [2/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSimDataClassicIO::QuerySim ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inlineinherited

Gather TOC info for FrSimData being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ QuerySimEvent() [1/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSimEventClassicIO::QuerySimEvent ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inlineinherited

Gather TOC info for FrSimEvent being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ QuerySimEvent() [2/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSimEventClassicIO::QuerySimEvent ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inlineinherited

Gather TOC info for FrSimEvent being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ QuerySum() [1/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::QuerySum ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inlineinherited

Gather TOC info for FrSummary being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ QuerySum() [2/2]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::QuerySum ( const Common::TOCInfo & Info,
INT_4U FrameOffset,
INT_8U Position )
inlineinherited

Gather TOC info for FrSummary being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.

◆ seekAdcDataPositions() [1/4]

virtual void FrameCPP::Version_9::FrTOC::seekAdcDataPositions ( istream_type & Stream,
Common::FrTOC::channel_id_type Channel )
protectedvirtual

Advance to the specified Adc channel.

Parameters
[in,out]StreamThe Stream being read
[in]ChannelThe requested channel

◆ seekAdcDataPositions() [2/4]

virtual void FrameCPP::Version_9::FrTOC::seekAdcDataPositions ( istream_type & Stream,
Common::FrTOC::channel_id_type Channel )
protectedvirtual

Advance to the specified Adc channel.

Parameters
[in,out]StreamThe Stream being read
[in]ChannelThe requested channel

◆ seekAdcDataPositions() [3/4]

virtual void FrameCPP::Version_9::FrTOC::seekAdcDataPositions ( istream_type & Stream,
const std::string & Channel )
protectedvirtual

Advance to the specified Adc channel.

Parameters
[in,out]StreamThe Stream being read
[in]ChannelThe requested channel

◆ seekAdcDataPositions() [4/4]

virtual void FrameCPP::Version_9::FrTOC::seekAdcDataPositions ( istream_type & Stream,
const std::string & Channel )
protectedvirtual

Advance to the specified Adc channel.

Parameters
[in,out]StreamThe Stream being read
[in]ChannelThe requested channel

◆ seekPositions() [1/4]

void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::seekPositions ( istream_type & Stream,
channel_id_type Channel )
inlineprotectedinherited

Advance to the specified Adc channel.

Parameters
[in,out]StreamThe Stream being read
[in]ChannelThe requested channel

◆ seekPositions() [2/4]

void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::seekPositions ( istream_type & Stream,
channel_id_type Channel )
inlineprotectedinherited

Advance to the specified Adc channel.

Parameters
[in,out]StreamThe Stream being read
[in]ChannelThe requested channel

◆ seekPositions() [3/4]

void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::seekPositions ( istream_type & Stream,
const std::string & Channel )
inlineprotectedinherited

Advance to the specified Adc channel.

Parameters
[in,out]StreamThe Stream being read
[in]ChannelThe requested channel

◆ seekPositions() [4/4]

void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::seekPositions ( istream_type & Stream,
const std::string & Channel )
inlineprotectedinherited

Advance to the specified Adc channel.

Parameters
[in,out]StreamThe Stream being read
[in]ChannelThe requested channel

◆ StructDescription() [1/2]

template<typename T >
static const Common::Description * FrameCPP::Version_9::FrTOCImpl::ClassicIO< T >::StructDescription ( )
inlinestaticinherited

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructDescription() [2/2]

template<typename T >
static const Common::Description * FrameCPP::Version_9::FrTOCImpl::ClassicIO< T >::StructDescription ( )
inlinestaticinherited

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructName() [1/2]

const char * FrameCPP::Version_9::FrTOC::StructName ( )
inlinestatic

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ StructName() [2/2]

static const char * FrameCPP::Version_9::FrTOC::StructName ( )
static

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ write() [1/9]

void FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::write ( Common::OStream & Stream) const
inlineprotectedinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ write() [2/9]

void FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::write ( Common::OStream & Stream) const
inlineprotectedinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ write() [3/9]

void FrameCPP::Version_9::FrTOCImpl::FrTOCDataClassicIO::write ( Common::OStream & Stream) const
inlineprotectedinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ write() [4/9]

void FrameCPP::Version_9::FrTOCImpl::FrTOCEventClassicIO::write ( Common::OStream & Stream) const
inlineprotectedinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ write() [5/9]

void FrameCPP::Version_9::FrTOCImpl::FrTOCProcDataClassicIO::write ( Common::OStream & Stream) const
inlineprotectedinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ write() [6/9]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSerDataClassicIO::write ( ostream_type & Stream) const
inlineprotectedinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ write() [7/9]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSimDataClassicIO::write ( Common::OStream & Stream) const
inlineprotectedinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ write() [8/9]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSimEventClassicIO::write ( Common::OStream & Stream) const
inlineprotectedinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ write() [9/9]

void FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::write ( ostream_type & Stream) const
inlineprotectedinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

Member Data Documentation

◆ m_nameDetector

namedetector_container_type FrameCPP::v9::FrTOCHeader::m_nameDetector
protectedinherited

Array of FrDetector names.

The size of this array is specified by nDetector. They appear alphabetically.

◆ m_positionDetector

positiondetector_container_type FrameCPP::v9::FrTOCHeader::m_positionDetector
protectedinherited

Array of FrDetector positions.

Array of FrDetector positions from the beginning of file. The size of array is specified by nDetector.

Note
Only the first occurrence for each type of FrDetector is captured.

◆ m_SHid

shid_container_type FrameCPP::v9::FrTOCHeader::m_SHid
protectedinherited

Array of FrSH IDs.

Array of FrSH IDs. The size of this array is specified by nSH.


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