ldas-tools-framecpp  2.7.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Version_8::FrTOC Class Reference

Table of Contents Data Structure Definition. More...

#include <FrTOC.hh>

Inheritance diagram for FrameCPP::Version_8::FrTOC:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_8::FrTOC:
Collaboration graph
[legend]

Public Types

typedef std::vector< data_quality_type > data_quality_container_type
 Array of integer QA words from each FrameH.
 
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< dt_type > dt_container_type
 Array of frame durations in seconds.
 
typedef std::vector< frame_type > frame_container_type
 Array of frame numbers.
 
typedef std::vector< frame_type > frame_container_type
 Array of frame numbers.
 
typedef std::vector< gtimen_type > gtimen_container_type
 Array of integer GPS residual nanoseconds for the frame.
 
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< 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< namedetector_type > namedetector_container_type
 Array of FrDetector names.
 
typedef std::vector< nfirstadc_type > nfirstadc_container_type
 Array of first FrADCData positions.
 
typedef std::vector< nfirstadc_type > nfirstadc_container_type
 Array of first FrADCData positions.
 
typedef std::vector< nfirstmsg_type > nfirstmsg_container_type
 Array of first FrMsg positions.
 
typedef std::vector< nfirstmsg_type > nfirstmsg_container_type
 Array of first FrMsg positions.
 
typedef std::vector< nfirstser_type > nfirstser_container_type
 Array of first FrSerData positions.
 
typedef std::vector< nfirstser_type > nfirstser_container_type
 Array of first FrSerData positions.
 
typedef std::vector< nfirsttable_type > nfirsttable_container_type
 Array of first FrTable positions.
 
typedef std::vector< nfirsttable_type > nfirsttable_container_type
 Array of first FrTable positions.
 
typedef std::vector< positiondetector_type > positiondetector_container_type
 Array of FrDetector positions.
 
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< positionh_type > positionh_container_type
 Array of FrSH IDs.
 
typedef std::vector< runs_type > runs_container_type
 Array of FrameH positions.
 
typedef std::vector< runs_type > runs_container_type
 Array of FrameH positions.
 
typedef std::vector< shid_type > shid_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::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. More...
 
typedef std::map< name_type, adc_info_type > MapADC_type
 Container of indexed FrAdcData elements. More...
 

Public Member Functions

 FrTOC ()
 Default constructor. More...
 
 FrTOC (const FrameCPP::Common::FrTOC *Source)
 Constructor. More...
 
virtual void ForEach (query_info_type Info, FunctionBase &Action) const
 Iterate over elements of the Table of Contents. More...
 
virtual void IndexObject (object_type Object, std::streampos Position)
 Place information about an object into the TOC. More...
 
virtual FrTOCCreate () const
 Virtual constructor. More...
 
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. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator More...
 
 FrTOC ()
 Default constructor. More...
 
 FrTOC (const FrameCPP::Common::FrTOC *Source)
 Constructor. More...
 
virtual void ForEach (query_info_type Info, FunctionBase &Action) const
 Iterate over elements of the Table of Contents. More...
 
virtual void IndexObject (object_type Object, std::streampos Position)
 Place information about an object into the TOC. More...
 
virtual FrTOCCreate () const
 Virtual constructor. More...
 
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. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator More...
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
const data_quality_container_typeGetDataQuality () const
 Retreive array of integer QA words from each FrameH.
 
const data_quality_container_typeGetDataQuality () const
 Retreive array of integer QA words from each FrameH.
 
const dt_container_typeGetDt () const
 Retrieve array of frame durations in seconds.
 
const dt_container_typeGetDt () const
 Retrieve array of frame durations in seconds.
 
const frame_container_typeGetFrame () const
 Retrieve array of frame numbers.
 
const frame_container_typeGetFrame () const
 Retrieve array of frame numbers.
 
const gtimes_container_typeGetGTimeN () const
 Retrieve array of integer GPS residual nanoseconds for the frame.
 
const gtimes_container_typeGetGTimeN () const
 Retrieve array of integer GPS residual nanoseconds for the frame.
 
const gtimen_container_typeGetGTimeS () const
 Retrieve array of integer GPS frame times.
 
const gtimen_container_typeGetGTimeS () const
 Retrieve array of integer GPS frame times.
 
const nfirstadc_container_typeGetNFirstADC () const
 Retrieve array of first FrADCData positions.
 
const nfirstadc_container_typeGetNFirstADC () const
 Retrieve array of first FrADCData positions.
 
const nfirstmsg_container_typeGetNFirstMsg () const
 Retrieve array of first FrMsg positions.
 
const nfirstmsg_container_typeGetNFirstMsg () const
 Retrieve array of first FrMsg positions.
 
const nfirstser_container_typeGetNFirstSer () const
 Retrieve array of first FrSerData positions.
 
const nfirstser_container_typeGetNFirstSer () const
 Retrieve array of first FrSerData positions.
 
const nfirsttable_container_typeGetNFirstTable () const
 Retrieve array of first FrTable positions.
 
const nfirsttable_container_typeGetNFirstTable () const
 Retrieve array of first FrTable positions.
 
const positionh_container_typeGetPositionH () const
 Retrieve array of FrameH positions.
 
const positionh_container_typeGetPositionH () const
 Retrieve array of FrameH positions.
 
const shid_container_typeGetSHid () const
 Retrieve array of FrSH IDs.
 
const shid_container_typeGetSHid () const
 Retrieve array of FrSH IDs.
 
const shname_container_typeGetSHname () const
 Retrieve array of FrSH names.
 
const shname_container_typeGetSHname () const
 Retrieve array of FrSH names.
 
uleaps_type GetULeapS () const
 Retrieve the number of leap seconds.
 
uleaps_type GetULeapS () const
 Retrieve the number of leap seconds.
 
const namedetector_container_typeGetNameDetector () const
 Retrieve array of FrDetector names.
 
const namedetector_container_typeGetNameDetector () const
 Retrieve array of FrDetector names.
 
const positiondetector_container_typeGetPositionDetector () const
 Retrieve array of FrDetector positions.
 
const positiondetector_container_typeGetPositionDetector () const
 Retrieve array of FrDetector positions.
 
bool operator== (const FrTOCData &RHS) const
 equality operator More...
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
const stat_container_type & GetStat () const
 Return all channels. More...
 
const stat_container_type & GetStat () const
 Return all channels. More...
 
INT_4U GetNTotalStat () const
 Return number of FrStatData structures. More...
 
INT_4U GetNTotalStat () const
 Return number of FrStatData structures. More...
 
bool operator== (const FrTOCStatData &RHS) const
 equality operator More...
 
void QueryStatData (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrStatData being written. More...
 
void QueryStatData (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrStatData being written. More...
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
const MapADC_typeGetADC () const
 Return all channels. More...
 
MapADC_type::const_iterator GetADC (const std::string &Name) const
 Return the indexed data for a named channel. More...
 
MapADC_type::const_iterator GetADC (INT_4U index) const
 Return the indexed data for an indexed channel. More...
 
const MapADC_typeGetADC () const
 Return all channels. More...
 
MapADC_type::const_iterator GetADC (const std::string &Name) const
 Return the indexed data for a named channel. More...
 
MapADC_type::const_iterator GetADC (INT_4U index) const
 Return the indexed data for an indexed channel. More...
 
const key_container_type & GetKeys () const
 Retrieve the keys. More...
 
const key_container_type & GetKeys () const
 Retrieve the keys. More...
 
void QueryAdc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrAdcData being written. More...
 
void QueryAdc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrAdcData being written. More...
 
bool operator== (const FrTOCAdcData &RHS) const
 equality operator More...
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
const key_container_type & GetKeys () const
 Retrieve the keys. More...
 
const MapProc_type & GetProc () const
 Return all channels. More...
 
MapProc_type::const_iterator GetProc (const std::string &Name) const
 Return the indexed data for a named channel. More...
 
MapProc_type::const_iterator GetProc (INT_4U index) const
 Return the indexed data for a named channel. More...
 
const MapProc_type & GetProc () const
 Return all channels. More...
 
MapProc_type::const_iterator GetProc (const std::string &Name) const
 Return the indexed data for a named channel. More...
 
MapProc_type::const_iterator GetProc (INT_4U index) const
 Return the indexed data for a named channel. More...
 
void QueryProc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrProcData being written. More...
 
void QueryProc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrProcData being written. More...
 
bool operator== (const FrTOCProcData &RHS) const
 equality operator More...
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
const MapSim_type & GetSim () const
 Return all channels. More...
 
MapSim_type::const_iterator GetSim (const std::string &Name) const
 Return the indexed data for a named channel. More...
 
MapSim_type::const_iterator GetSim (INT_4U index) const
 Return the indexed data for a named channel. More...
 
const MapSim_type & GetSim () const
 Return all channels. More...
 
MapSim_type::const_iterator GetSim (const std::string &Name) const
 Return the indexed data for a named channel. More...
 
MapSim_type::const_iterator GetSim (INT_4U index) const
 Return the indexed data for a named channel. More...
 
void QuerySim (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSimData being written. More...
 
void QuerySim (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSimData being written. More...
 
bool operator== (const FrTOCSimData &RHS) const
 equality operator More...
 
const MapSer_type & GetSer () const
 Return all channels. More...
 
MapSer_type::const_iterator GetSer (const std::string &Name) const
 Return the indexed data for a named channel. More...
 
MapSer_type::const_iterator GetSer (INT_4U index) const
 Return the indexed data for a named channel. More...
 
const MapSer_type & GetSer () const
 Return all channels. More...
 
MapSer_type::const_iterator GetSer (const std::string &Name) const
 Return the indexed data for a named channel. More...
 
MapSer_type::const_iterator GetSer (INT_4U index) const
 Return the indexed data for a named channel. More...
 
void QuerySer (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSerData being written. More...
 
void QuerySer (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSerData being written. More...
 
bool operator== (const FrTOCSerData &RHS) const
 equality operator More...
 
const MapSummary_type & GetSummary () const
 Return all summary elements. More...
 
MapSummary_type::const_iterator GetSummary (const std::string &Name) const
 Return the indexed data for a named summary elemnet. More...
 
MapSummary_type::const_iterator GetSummary (INT_4U index) const
 Return the indexed data for an index summary element. More...
 
const MapSummary_type & GetSummary () const
 Return all summary elements. More...
 
MapSummary_type::const_iterator GetSummary (const std::string &Name) const
 Return the indexed data for a named summary elemnet. More...
 
MapSummary_type::const_iterator GetSummary (INT_4U index) const
 Return the indexed data for an index summary element. More...
 
void QuerySum (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSummary being written. More...
 
void QuerySum (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSummary being written. More...
 
bool operator== (const FrTOCSummary &RHS) const
 equality operator More...
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
const nameEvent_container_type & GetEvent () const
 Return all events. More...
 
const nameEvent_container_type & GetEvent () const
 Return all events. More...
 
void QueryEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrEvent being written. More...
 
void QueryEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrEvent being written. More...
 
bool operator== (const FrTOCEvent &RHS) const
 equality operator More...
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
const nameSimEvent_container_type & GetSimEvent () const
 Return all events. More...
 
const nameSimEvent_container_type & GetSimEvent () const
 Return all events. More...
 
void QuerySimEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSimEvent being written. More...
 
void QuerySimEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSimEvent being written. More...
 
bool operator== (const FrTOCSimEvent &RHS) const
 equality operator More...
 

Static Public Member Functions

static const char * StructName ()
 The name structure name of this object. More...
 
static const Common::Description * StructDescription ()
 The description of structure. More...
 
static const char * StructName ()
 The name structure name of this object. More...
 
static const Common::Description * StructDescription ()
 The description of structure. More...
 
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. More...
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure. More...
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure. More...
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure. More...
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure. More...
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure. More...
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure. More...
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure. More...
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure. More...
 
template<typename SE >
static void Description (Common::Description &Desc)
 The description of structure. More...
 

Protected Member Functions

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

Protected Attributes

uleaps_type m_ULeapS
 From the first FrameH in the file.
 
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).
 
runs_container_type m_runs
 Array of run numbers. More...
 
frame_container_type m_frame
 Array of frame numbers (size of nFrame).
 
positiondetector_container_type m_positionDetector
 Array of FrDetector positions. More...
 
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. More...
 
nfirstadc_container_type m_nFirstADC
 Array of first FrADCData positions. More...
 
nfirstser_container_type m_nFirstSer
 Array of first FrSerData positions. More...
 
nfirsttable_container_type m_nFirstTable
 Array of first FrTable positions. More...
 
nfirstmsg_container_type m_nFirstMsg
 Array of first FrMsg positions. More...
 
shid_container_type m_SHid
 Array of FrSH IDs. More...
 
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 [1/2]

typedef std::map< name_type, adc_info_type > FrameCPP::Version_8::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.

◆ MapADC_type [2/2]

typedef std::map< name_type, adc_info_type > FrameCPP::Version_8::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/4]

FrameCPP::Version_8::FrTOC::FrTOC ( )

Default constructor.

Returns
A new instance of this object.

◆ FrTOC() [2/4]

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

Constructor.

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

◆ FrTOC() [3/4]

FrameCPP::Version_8::FrTOC::FrTOC ( )

Default constructor.

Returns
A new instance of this object.

◆ FrTOC() [4/4]

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

Constructor.

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

Member Function Documentation

◆ Bytes() [1/8]

Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCAdcData::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() [2/8]

Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCEvent::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() [3/8]

Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCProcData::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/8]

Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCSimData::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/8]

Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCSimEvent::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/8]

Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCStatData::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/8]

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

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

◆ cacheAdcDataPositions() [1/2]

void FrameCPP::Version_8::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_8::FrTOC::cacheAdcDataPositions ( istream_type &  Stream)
protectedvirtual

Cache where the positions of the Adc channels.

Parameters
[in,out]StreamThe Stream being read

◆ cachePositions() [1/2]

void FrameCPP::Version_8::FrTOCAdcData::cachePositions ( istream_type &  Stream)
inlineprotectedinherited

Cache where the positions of the Adc channels.

Parameters
[in,out]StreamThe Stream being read

◆ cachePositions() [2/2]

void FrameCPP::Version_8::FrTOCAdcData::cachePositions ( istream_type &  Stream)
protectedinherited

Cache where the positions of the Adc channels.

Parameters
[in,out]StreamThe Stream being read

◆ Create() [1/3]

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

Virtual constructor.

Returns
A new instance of this object.

◆ Create() [2/3]

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

Virtual constructor.

Returns
A new instance of this object.

◆ Create() [3/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.

◆ demote() [1/2]

FrTOC::demote_ret_type FrameCPP::Version_8::FrTOC::demote ( INT_2U  Target,
demote_arg_type  Obj,
Common::IStream *  Stream 
) const
protectedvirtual

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]

virtual demote_ret_type FrameCPP::Version_8::FrTOC::demote ( INT_2U  Target,
demote_arg_type  Obj,
Common::IStream *  Stream 
) const
protectedvirtual

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/10]

template<typename SE >
void FrameCPP::Version_8::FrTOCAdcData::Description ( Common::Description &  Desc)
staticinherited

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/10]

template<typename SE >
void FrameCPP::Version_8::FrTOCData::Description ( Common::Description &  Desc)
staticinherited

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/10]

template<typename SE >
void FrameCPP::Version_8::FrTOCEvent::Description ( Common::Description &  Desc)
staticinherited

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/10]

template<typename SE >
void FrameCPP::Version_8::FrTOCProcData::Description ( Common::Description &  Desc)
staticinherited

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/10]

template<typename SE >
void FrameCPP::Version_8::FrTOCSerData::Description ( Common::Description &  Desc)
staticinherited

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/10]

template<typename SE >
void FrameCPP::Version_8::FrTOCSimData::Description ( Common::Description &  Desc)
staticinherited

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

template<typename SE >
void FrameCPP::Version_8::FrTOCSimEvent::Description ( Common::Description &  Desc)
staticinherited

The description of structure.

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

◆ Description() [8/10]

template<typename SE >
void FrameCPP::Version_8::FrTOCStatData::Description ( Common::Description &  Desc)
staticinherited

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/10]

template<typename SE >
void FrameCPP::Version_8::FrTOCSummary::Description ( Common::Description &  Desc)
staticinherited

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

template<typename SE >
static void FrameCPP::Version_8::FrTOCData::Description ( Common::Description &  Desc)
staticinherited

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.

◆ forEach() [1/5]

void FrameCPP::Version_8::FrTOCAdcData::forEach ( Common::FrTOC::query_info_type  Info,
Common::FrTOC::FunctionBase &  Action 
) const
protectedinherited

Iterate over contents.

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

This method allows for iterting over each element of information and allows the caller to gather information about each element.

◆ forEach() [2/5]

void FrameCPP::Version_8::FrTOCData::forEach ( Common::FrTOC::query_info_type  Info,
Common::FrTOC::FunctionBase &  Action 
) const
protectedinherited

Iterate over contents.

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

This method allows for iterting over each element of information and allows the caller to gather information about each element.

◆ forEach() [3/5]

void FrameCPP::Version_8::FrTOCProcData::forEach ( Common::FrTOC::query_info_type  Info,
Common::FrTOC::FunctionBase &  Action 
) const
protectedinherited

Iterate over contents.

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

This method allows for iterting over each element of information and allows the caller to gather information about each element.

◆ forEach() [4/5]

void FrameCPP::Version_8::FrTOCSimData::forEach ( Common::FrTOC::query_info_type  Info,
Common::FrTOC::FunctionBase &  Action 
) const
protectedinherited

Iterate over contents.

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

This method allows for iterting over each element of information and allows the caller to gather information about each element.

◆ forEach() [5/5]

void FrameCPP::Version_8::FrTOCData::forEach ( Common::FrTOC::query_info_type  Info,
Common::FrTOC::FunctionBase &  Action 
) const
protectedinherited

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

void FrameCPP::Version_8::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.

Loop over members of the table of contents to gather information requested by the caller.

Todo:
Need to finish the list of channel names

◆ ForEach() [2/2]

virtual void FrameCPP::Version_8::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.

◆ FrStatDataQuery() [1/2]

void FrameCPP::Version_8::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.

◆ FrStatDataQuery() [2/2]

virtual void FrameCPP::Version_8::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.

◆ GetADC() [1/6]

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

Return all channels.

Returns
Constant container to the indexed FrAdcData elements.

◆ GetADC() [2/6]

const MapADC_type& FrameCPP::Version_8::FrTOCAdcData::GetADC ( ) const
inherited

Return all channels.

Returns
Constant container to the indexed FrAdcData elements.

◆ GetADC() [3/6]

FrTOCAdcData::MapADC_type::const_iterator FrameCPP::Version_8::FrTOCAdcData::GetADC ( const std::string &  Name) const
inherited

Return the indexed data for a named channel.

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

◆ GetADC() [4/6]

MapADC_type::const_iterator FrameCPP::Version_8::FrTOCAdcData::GetADC ( const std::string &  Name) const
inherited

Return the indexed data for a named channel.

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

◆ GetADC() [5/6]

FrTOCAdcData::MapADC_type::const_iterator FrameCPP::Version_8::FrTOCAdcData::GetADC ( INT_4U  index) const
inherited

Return the indexed data for an indexed channel.

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

◆ GetADC() [6/6]

MapADC_type::const_iterator FrameCPP::Version_8::FrTOCAdcData::GetADC ( INT_4U  index) const
inherited

Return the indexed data for an indexed channel.

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

◆ GetEvent() [1/2]

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

Return all events.

Returns
Constant container to the indexed FrEvent elements.

◆ GetEvent() [2/2]

const nameEvent_container_type& FrameCPP::Version_8::FrTOCEvent::GetEvent ( ) const
inherited

Return all events.

Returns
Constant container to the indexed FrEvent elements.

◆ GetKeys() [1/3]

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

Retrieve the keys.

Returns
Constant container of keys.

◆ GetKeys() [2/3]

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

Retrieve the keys.

Returns
Constant container of keys.

◆ GetKeys() [3/3]

const key_container_type& FrameCPP::Version_8::FrTOCAdcData::GetKeys ( ) const
inherited

Retrieve the keys.

Returns
Constant container of keys.

◆ GetNTotalStat() [1/2]

INT_4U FrameCPP::Version_8::FrTOCStatData::GetNTotalStat ( ) const
inlineinherited

Return number of FrStatData structures.

Returns
The number of FrStatData structures.

◆ GetNTotalStat() [2/2]

INT_4U FrameCPP::Version_8::FrTOCStatData::GetNTotalStat ( ) const
inherited

Return number of FrStatData structures.

Returns
The number of FrStatData structures.

◆ GetProc() [1/6]

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

Return all channels.

Returns
Constant container to the indexed FrProcData elements.

◆ GetProc() [2/6]

const MapProc_type& FrameCPP::Version_8::FrTOCProcData::GetProc ( ) const
inherited

Return all channels.

Returns
Constant container to the indexed FrProcData elements.

◆ GetProc() [3/6]

FrTOCProcData::MapProc_type::const_iterator FrameCPP::Version_8::FrTOCProcData::GetProc ( const std::string &  Name) const
inherited

Return the indexed data for a named channel.

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

◆ GetProc() [4/6]

MapProc_type::const_iterator FrameCPP::Version_8::FrTOCProcData::GetProc ( const std::string &  Name) const
inherited

Return the indexed data for a named channel.

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

◆ GetProc() [5/6]

FrTOCProcData::MapProc_type::const_iterator FrameCPP::Version_8::FrTOCProcData::GetProc ( INT_4U  index) const
inherited

Return the indexed data for a named channel.

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

◆ GetProc() [6/6]

MapProc_type::const_iterator FrameCPP::Version_8::FrTOCProcData::GetProc ( INT_4U  index) const
inherited

Return the indexed data for a named channel.

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

◆ GetSer() [1/6]

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

Return all channels.

Returns
Constant container to the indexed FrSerData elements.

◆ GetSer() [2/6]

const MapSer_type& FrameCPP::Version_8::FrTOCSerData::GetSer ( ) const
inherited

Return all channels.

Returns
Constant container to the indexed FrSerData elements.

◆ GetSer() [3/6]

FrTOCSerData::MapSer_type::const_iterator FrameCPP::Version_8::FrTOCSerData::GetSer ( const std::string &  Name) const
inlineinherited

Return the indexed data for a named channel.

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

◆ GetSer() [4/6]

MapSer_type::const_iterator FrameCPP::Version_8::FrTOCSerData::GetSer ( const std::string &  Name) const
inherited

Return the indexed data for a named channel.

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

◆ GetSer() [5/6]

FrTOCSerData::MapSer_type::const_iterator FrameCPP::Version_8::FrTOCSerData::GetSer ( INT_4U  index) const
inlineinherited

Return the indexed data for a named channel.

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

◆ GetSer() [6/6]

MapSer_type::const_iterator FrameCPP::Version_8::FrTOCSerData::GetSer ( INT_4U  index) const
inherited

Return the indexed data for a named channel.

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

◆ GetSim() [1/6]

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

Return all channels.

Returns
Constant container to the indexed FrSimData elements.

◆ GetSim() [2/6]

const MapSim_type& FrameCPP::Version_8::FrTOCSimData::GetSim ( ) const
inherited

Return all channels.

Returns
Constant container to the indexed FrSimData elements.

◆ GetSim() [3/6]

FrTOCSimData::MapSim_type::const_iterator FrameCPP::Version_8::FrTOCSimData::GetSim ( const std::string &  Name) const
inherited

Return the indexed data for a named channel.

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

◆ GetSim() [4/6]

MapSim_type::const_iterator FrameCPP::Version_8::FrTOCSimData::GetSim ( const std::string &  Name) const
inherited

Return the indexed data for a named channel.

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

◆ GetSim() [5/6]

FrTOCSimData::MapSim_type::const_iterator FrameCPP::Version_8::FrTOCSimData::GetSim ( INT_4U  index) const
inherited

Return the indexed data for a named channel.

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

◆ GetSim() [6/6]

MapSim_type::const_iterator FrameCPP::Version_8::FrTOCSimData::GetSim ( INT_4U  index) const
inherited

Return the indexed data for a named channel.

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

◆ GetSimEvent() [1/2]

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

Return all events.

Returns
Constant container to the indexed FrSimEvent elements.

◆ GetSimEvent() [2/2]

const nameSimEvent_container_type& FrameCPP::Version_8::FrTOCSimEvent::GetSimEvent ( ) const
inherited

Return all events.

Returns
Constant container to the indexed FrSimEvent elements.

◆ GetStat() [1/2]

const FrTOCStatData::stat_container_type & FrameCPP::Version_8::FrTOCStatData::GetStat ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrStatData elements.

◆ GetStat() [2/2]

const stat_container_type& FrameCPP::Version_8::FrTOCStatData::GetStat ( ) const
inherited

Return all channels.

Returns
Constant container to the indexed FrStatData elements.

◆ GetSummary() [1/6]

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

Return all summary elements.

Returns
Constant container to the indexed FrSummary elements.

◆ GetSummary() [2/6]

const MapSummary_type& FrameCPP::Version_8::FrTOCSummary::GetSummary ( ) const
inherited

Return all summary elements.

Returns
Constant container to the indexed FrSummary elements.

◆ GetSummary() [3/6]

FrTOCSummary::MapSummary_type::const_iterator FrameCPP::Version_8::FrTOCSummary::GetSummary ( const std::string &  Name) const
inlineinherited

Return the indexed data for a named summary elemnet.

Parameters
[in]NameThe name of the summary elment.
Returns
Constant iterator to the indexed FrSummary element.

◆ GetSummary() [4/6]

MapSummary_type::const_iterator FrameCPP::Version_8::FrTOCSummary::GetSummary ( const std::string &  Name) const
inherited

Return the indexed data for a named summary elemnet.

Parameters
[in]NameThe name of the summary elment.
Returns
Constant iterator to the indexed FrSummary element.

◆ GetSummary() [5/6]

FrTOCSummary::MapSummary_type::const_iterator FrameCPP::Version_8::FrTOCSummary::GetSummary ( INT_4U  index) const
inlineinherited

Return the indexed data for an index summary element.

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

◆ GetSummary() [6/6]

MapSummary_type::const_iterator FrameCPP::Version_8::FrTOCSummary::GetSummary ( INT_4U  index) const
inherited

Return the indexed data for an index summary element.

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

◆ IndexObject() [1/2]

void FrameCPP::Version_8::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_8::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.

◆ ObjectStructName() [1/2]

const char * FrameCPP::Version_8::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_8::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/11]

bool FrameCPP::Version_8::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.
Todo:
actually implement comparision operator

◆ operator==() [2/11]

virtual bool FrameCPP::Version_8::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==() [3/11]

bool FrameCPP::Version_8::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==() [4/11]

bool FrameCPP::Version_8::FrTOCData::operator== ( const FrTOCData 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==() [5/11]

bool FrameCPP::Version_8::FrTOCEvent::operator== ( const FrTOCEvent 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==() [6/11]

bool FrameCPP::Version_8::FrTOCProcData::operator== ( const FrTOCProcData 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==() [7/11]

bool FrameCPP::Version_8::FrTOCSerData::operator== ( const FrTOCSerData 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==() [8/11]

bool FrameCPP::Version_8::FrTOCSimData::operator== ( const FrTOCSimData 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==() [9/11]

bool FrameCPP::Version_8::FrTOCSimEvent::operator== ( const FrTOCSimEvent 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==() [10/11]

bool FrameCPP::Version_8::FrTOCStatData::operator== ( const FrTOCStatData 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==() [11/11]

bool FrameCPP::Version_8::FrTOCSummary::operator== ( const FrTOCSummary 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]

Common::FrameSpec::size_type FrameCPP::Version_8::FrTOC::pBytes ( const Common::StreamBase &  Stream) const
protectedvirtual

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.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ pBytes() [2/2]

virtual Common::FrameSpec::size_type FrameCPP::Version_8::FrTOC::pBytes ( const Common::StreamBase &  Stream) const
protectedvirtual

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.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ pCreate() [1/2]

FrTOC * FrameCPP::Version_8::FrTOC::pCreate ( Common::IStream &  Stream) const
protectedvirtual

Virtual constructor.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ pCreate() [2/2]

virtual FrTOC* FrameCPP::Version_8::FrTOC::pCreate ( Common::IStream &  Stream) const
protectedvirtual

Virtual constructor.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ procDataCachePositions() [1/2]

void FrameCPP::Version_8::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_8::FrTOC::procDataCachePositions ( istream_type &  Stream)
protectedvirtual

Cache where the positions of the FrProcData channels.

Parameters
[in,out]StreamThe Stream being read

◆ promote() [1/2]

FrTOC::promote_ret_type FrameCPP::Version_8::FrTOC::promote ( INT_2U  Target,
promote_arg_type  Obj,
Common::IStream *  Stream 
) const
protectedvirtual

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]

virtual promote_ret_type FrameCPP::Version_8::FrTOC::promote ( INT_2U  Target,
promote_arg_type  Obj,
Common::IStream *  Stream 
) const
protectedvirtual

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]

void FrameCPP::Version_8::FrTOC::pWrite ( Common::OStream &  Stream) const
protectedvirtual

Write the structure to the stream.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ pWrite() [2/2]

virtual void FrameCPP::Version_8::FrTOC::pWrite ( Common::OStream &  Stream) const
protectedvirtual

Write the structure to the stream.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ QueryAdc() [1/2]

void FrameCPP::Version_8::FrTOCAdcData::QueryAdc ( const Common::TOCInfo &  Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

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_8::FrTOCAdcData::QueryAdc ( const Common::TOCInfo &  Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

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_8::FrTOCEvent::QueryEvent ( const Common::TOCInfo &  Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

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_8::FrTOCEvent::QueryEvent ( const Common::TOCInfo &  Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

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_8::FrTOCProcData::QueryProc ( const Common::TOCInfo &  Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

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_8::FrTOCProcData::QueryProc ( const Common::TOCInfo &  Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

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_8::FrTOCSerData::QuerySer ( const Common::TOCInfo &  Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

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_8::FrTOCSerData::QuerySer ( const Common::TOCInfo &  Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

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_8::FrTOCSimData::QuerySim ( const Common::TOCInfo &  Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

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_8::FrTOCSimData::QuerySim ( const Common::TOCInfo &  Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

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_8::FrTOCSimEvent::QuerySimEvent ( const Common::TOCInfo &  Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

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_8::FrTOCSimEvent::QuerySimEvent ( const Common::TOCInfo &  Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

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.

◆ QueryStatData() [1/2]

void FrameCPP::Version_8::FrTOCStatData::QueryStatData ( const Common::TOCInfo &  Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

Gather TOC info for FrStatData 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.

◆ QueryStatData() [2/2]

void FrameCPP::Version_8::FrTOCStatData::QueryStatData ( const Common::TOCInfo &  Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

Gather TOC info for FrStatData 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_8::FrTOCSummary::QuerySum ( const Common::TOCInfo &  Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

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_8::FrTOCSummary::QuerySum ( const Common::TOCInfo &  Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

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]

void FrameCPP::Version_8::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_8::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]

void FrameCPP::Version_8::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_8::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_8::FrTOCAdcData::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_8::FrTOCAdcData::seekPositions ( istream_type &  Stream,
channel_id_type  Channel 
)
protectedinherited

Advance to the specified Adc channel.

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

◆ seekPositions() [3/4]

void FrameCPP::Version_8::FrTOCAdcData::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_8::FrTOCAdcData::seekPositions ( istream_type &  Stream,
const std::string &  Channel 
)
protectedinherited

Advance to the specified Adc channel.

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

◆ StructDescription() [1/2]

const Common::Description * FrameCPP::Version_8::FrTOC::StructDescription ( )
static

The description of structure.

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

◆ StructDescription() [2/2]

static const Common::Description* FrameCPP::Version_8::FrTOC::StructDescription ( )
static

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_8::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_8::FrTOC::StructName ( )
static

The name structure name of this object.

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

◆ write() [1/10]

void FrameCPP::Version_8::FrTOCAdcData::write ( Common::OStream &  Stream) const
protectedinherited

Write the structure to the stream.

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

◆ write() [2/10]

void FrameCPP::Version_8::FrTOCData::write ( Common::OStream &  Stream) const
protectedinherited

Write the structure to the stream.

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

◆ write() [3/10]

void FrameCPP::Version_8::FrTOCEvent::write ( Common::OStream &  Stream) const
protectedinherited

Write the structure to the stream.

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

◆ write() [4/10]

void FrameCPP::Version_8::FrTOCProcData::write ( Common::OStream &  Stream) const
protectedinherited

Write the structure to the stream.

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

◆ write() [5/10]

void FrameCPP::Version_8::FrTOCSerData::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/10]

void FrameCPP::Version_8::FrTOCSimData::write ( Common::OStream &  Stream) const
protectedinherited

Write the structure to the stream.

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

◆ write() [7/10]

void FrameCPP::Version_8::FrTOCSimEvent::write ( Common::OStream &  Stream) const
protectedinherited

Write the structure to the stream.

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

◆ write() [8/10]

void FrameCPP::Version_8::FrTOCStatData::write ( Common::OStream &  Stream) const
protectedinherited

Write the structure to the stream.

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

◆ write() [9/10]

void FrameCPP::Version_8::FrTOCSummary::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() [10/10]

void FrameCPP::Version_8::FrTOCData::write ( Common::OStream &  Stream) const
protectedinherited

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::Version_8::FrTOCData::m_nameDetector
protectedinherited

Array of FrDetector names.

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

◆ m_nFirstADC

nfirstadc_container_type FrameCPP::Version_8::FrTOCData::m_nFirstADC
protectedinherited

Array of first FrADCData positions.

Array of first FrADCData positions, in bytes, from beginning of file. The size of this array is specified by nFrame.

◆ m_nFirstMsg

nfirstmsg_container_type FrameCPP::Version_8::FrTOCData::m_nFirstMsg
protectedinherited

Array of first FrMsg positions.

Array of first FrMsg positions, in bytes, from beginning of file. The size of this array is specified by nFrame.

◆ m_nFirstSer

nfirstser_container_type FrameCPP::Version_8::FrTOCData::m_nFirstSer
protectedinherited

Array of first FrSerData positions.

Array of first FrSerData positions, in bytes, from beginning of file. The size of this array is specified by nFrame.

◆ m_nFirstTable

nfirsttable_container_type FrameCPP::Version_8::FrTOCData::m_nFirstTable
protectedinherited

Array of first FrTable positions.

Array of first FrTable positions, in bytes, from beginning of file The size of this array is specified by nFrame.

Note
The pointer is to the first table associated with FrRawData for each frame.

◆ m_positionDetector

positiondetector_container_type FrameCPP::Version_8::FrTOCData::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_runs

runs_container_type FrameCPP::Version_8::FrTOCData::m_runs
protectedinherited

Array of run numbers.

Array of run numbers. The size of this array is specified by nFrame.

◆ m_SHid

shid_container_type FrameCPP::Version_8::FrTOCData::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: