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

#include <FrTOC.hh>

Inheritance diagram for FrameCPP::Version_4::FrTOC:
FrameCPP::Version_4::FrTOCSimEvent FrameCPP::Version_4::FrTOCTrigData FrameCPP::Version_4::FrTOCSummary FrameCPP::Version_4::FrTOCSerData FrameCPP::Version_4::FrTOCSimData FrameCPP::Version_4::FrTOCProcData FrameCPP::Version_4::FrTOCAdcData FrameCPP::Version_4::FrTOCStatData FrameCPP::Version_4::FrTOCData FrameCPP::Common::FrTOC

Classes

struct  StatType_type
 
class  StatTypeKey
 
class  StatTypeKeyHash
 

Public Types

typedef INT_8U position_type
 
typedef std::vector< position_typeposition_list_type
 
typedef LDASTools::AL::unordered_map< StatTypeKey, StatType_type, StatTypeKeyHashMapStatType_type
 
enum  query_info_type { TOC_CHANNEL_NAMES, TOC_DETECTOR, TOC_FR_STRUCTS }
 
typedef INT_8U cmn_position_type
 
typedef INT_4U channel_id_type
 
typedef boost::shared_ptr< FrameSpec::Objectobject_type
 
typedef std::vector< STRING< INT_2U > > cmn_name_container_type
 
typedef std::vector< REAL_8 > cmn_dt_container_type
 
typedef std::vector< INT_4U > cmn_GTimeS_container_type
 
typedef std::vector< INT_4U > cmn_GTimeN_container_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef INT_2S uleaps_type
 
typedef INT_4S localTime_type
 
typedef INT_4U nframe_type
 
typedef INT_4U gtimen_type
 
typedef INT_4U gtimes_type
 
typedef REAL_8 dt_type
 
typedef INT_4S runs_type
 
typedef INT_4U frame_type
 
typedef INT_4U nsh_type
 
typedef INT_2U shid_type
 
typedef STRING shname_type
 
typedef std::vector< gtimen_typegtimen_container_type
 
typedef std::vector< gtimes_typegtimes_container_type
 
typedef std::vector< dt_typedt_container_type
 Array of FrDetector names. More...
 
typedef std::vector< runs_typeruns_container_type
 
typedef std::vector< frame_typeframe_container_type
 
typedef std::vector< position_typepositionH_container_type
 
typedef std::vector< position_typenFirstADC_container_type
 
typedef std::vector< position_typenFirstSer_container_type
 
typedef std::vector< position_typenFirstTable_container_type
 
typedef std::vector< position_typenFirstMsg_container_type
 
typedef std::vector< shid_typeshid_container_type
 
typedef std::vector< shname_typeshname_container_type
 
typedef STRING name_type
 
typedef INT_4U nstat_type
 
typedef STRING detector_type
 
typedef INT_4U nstat_instance_type
 
typedef INT_4U tstart_type
 
typedef INT_4U tend_type
 
typedef INT_4U version_type
 
typedef position_type positionStat_type
 
typedef std::vector< stat_instance_typestat_instance_container_type
 
typedef std::map< name_type, stat_typestat_container_type
 
typedef STRING name_type
 
typedef INT_4U nADC_type
 
typedef INT_4U channelID_type
 
typedef INT_4U groupID_type
 
typedef std::map< name_type, adc_info_typeMapADC_type
 
typedef Common::FrTOC::PositionWithCache< STRING, FrTOCPosition::position_typebase_type
 
typedef FrTOCPosition::n_type nproc_type
 
typedef FrTOCPosition::info_type proc_info_type
 
typedef FrTOCPosition::Map_type MapProc_type
 
typedef INT_4U frame_count_type
 
typedef INT_4U n_type
 
typedef STRING name_type
 
typedef std::vector< position_typeinfo_type
 
typedef std::map< name_type, info_typeMap_type
 
typedef std::vector< name_typekey_container_type
 
typedef FrTOCPosition::n_type nsim_type
 
typedef FrTOCPosition::info_type sim_info_type
 
typedef FrTOCPosition::Map_type MapSim_type
 
typedef INT_4U frame_count_type
 
typedef INT_4U n_type
 
typedef STRING name_type
 
typedef std::vector< position_typeinfo_type
 
typedef std::map< name_type, info_typeMap_type
 
typedef std::vector< name_typekey_container_type
 
typedef FrTOCPosition::n_type nser_type
 
typedef FrTOCPosition::info_type ser_info_type
 
typedef FrTOCPosition::Map_type MapSer_type
 
typedef INT_4U frame_count_type
 
typedef INT_4U n_type
 
typedef STRING name_type
 
typedef std::vector< position_typeinfo_type
 
typedef std::map< name_type, info_typeMap_type
 
typedef std::vector< name_typekey_container_type
 
typedef FrTOCPosition::n_type nsummary_type
 
typedef FrTOCPosition::info_type summary_info_type
 
typedef FrTOCPosition::Map_type MapSummary_type
 
typedef INT_4U frame_count_type
 
typedef INT_4U n_type
 
typedef STRING name_type
 
typedef std::vector< position_typeinfo_type
 
typedef std::map< name_type, info_typeMap_type
 
typedef std::vector< name_typekey_container_type
 
typedef INT_4U nTrig_type
 
typedef STRING name_type
 
typedef INT_4U gtimesTrigData_type
 
typedef INT_4U gtimenTrigData_type
 
typedef INT_8U positionTrigData_type
 
typedef std::map< name_type, trig_data_typeMapTrig_type
 
typedef INT_4U nSimEvt_type
 
typedef STRING name_type
 
typedef INT_4U gtimesSimEvent_type
 
typedef INT_4U gtimenSimEvent_type
 
typedef INT_8U positionSimEvent_type
 
typedef std::map< name_type, trig_data_typeMapSimEvt_type
 

Public Member Functions

 FrTOC ()
 
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)
 
virtual Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual FrTOCCreate () const
 constructor - virtual More...
 
virtual FrTOCCreate (istream_type &Stream) const
 constructor - virtual 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
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
const MapStatType_typeGetStatType () const
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
virtual ObjectClone () const
 constructor - virtual copy constructor More...
 
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *Stream)
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 
localTime_type GetLocalTime () const
 
const dt_container_typeGetDt () const
 
const frame_container_typeGetFrame () const
 
const gtimes_container_typeGetGTimeN () const
 
const gtimen_container_typeGetGTimeS () const
 
nframe_type GetNFrame () const
 
const nFirstADC_container_typeGetNFirstADC () const
 
const nFirstSer_container_typeGetNFirstSer () const
 
const nFirstTable_container_typeGetNFirstTable () const
 
const nFirstMsg_container_typeGetNFirstMsg () const
 
const positionH_container_typeGetPositionH () const
 
const runs_container_typeGetRuns () const
 
const shid_container_typeGetSHid () const
 
const shname_container_typeGetSHname () const
 
uleaps_type GetULeapS () const
 
bool operator== (const FrTOCData &RHS) const
 
const stat_container_typeGetStat () const
 
bool operator== (const FrTOCStatData &RHS) const
 
void QueryStatData (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
const MapADC_typeGetADC () const
 
MapADC_type::const_iterator GetADC (const std::string &Name) const
 
MapADC_type::const_iterator GetADC (INT_4U index) const
 
void QueryADC (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
bool operator== (const FrTOCAdcData &RHS) const
 
const MapProc_typeGetProc () const
 
MapProc_type::const_iterator GetProc (const std::string &Name) const
 
MapProc_type::const_iterator GetProc (INT_4U index) const
 
void QueryProc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
bool operator== (const FrTOCProcData &RHS) const
 
const key_container_typeGetPositionKeys () const
 
const MapSim_typeGetSim () const
 
MapSim_type::const_iterator GetSim (const std::string &Name) const
 
MapSim_type::const_iterator GetSim (INT_4U index) const
 
void QuerySim (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
bool operator== (const FrTOCSimData &RHS) const
 
const key_container_typeGetPositionKeys () const
 
const MapSer_typeGetSer () const
 
MapSer_type::const_iterator GetSer (const std::string &Name) const
 
MapSer_type::const_iterator GetSer (INT_4U index) const
 
void QuerySer (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
bool operator== (const FrTOCSerData &RHS) const
 
const key_container_typeGetPositionKeys () const
 
const MapSummary_typeGetSummary () const
 
MapSummary_type::const_iterator GetSummary (const std::string &Name) const
 
MapSummary_type::const_iterator GetSummary (INT_4U index) const
 
void QuerySum (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
bool operator== (const FrTOCSummary &RHS) const
 
const key_container_typeGetPositionKeys () const
 
const MapTrig_typeGetTrigData () const
 
MapTrig_type::const_iterator GetTrigData (const std::string &Name) const
 
void QueryTrigData (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
bool operator== (const FrTOCTrigData &RHS) const
 
bool operator== (const FrTOCSimEvent &RHS) const
 
const MapSimEvt_typeGetSimEvent () const
 
MapSimEvt_type::const_iterator GetSimEvent (const std::string &Channel) const
 
void QuerySimEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 

Static Public Member Functions

static const char * StructName ()
 
static const Common::DescriptionStructDescription ()
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
static void Description (Common::Description &Desc)
 
static void Description (Common::Description &Desc)
 
static void Description (Common::Description &Desc)
 
static void Description (Common::Description &Desc)
 
static void Description (Common::Description &Desc)
 
template<typename SE >
static void Description (Common::Description &Desc)
 
template<typename SE >
static void Description (Common::Description &Desc)
 
static void Description (Common::Description &Desc)
 
static void Description (Common::Description &Desc)
 

Static Public Attributes

static const INT_4U NO_DATA_AVAILABLE = 0xFFFFFFFF
 
static const Common::FrameSpec::Info::frame_object_types s_object_id = Common::FrameSpec::Info::FSI_FR_TOC
 

Protected Types

typedef std::vector< name_typekey_container_type
 

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object. More...
 
virtual INT_4U nFrame () const
 
virtual const cmn_dt_container_typedt () const
 
virtual const cmn_GTimeS_container_typeGTimeS () const
 
virtual const cmn_GTimeN_container_typeGTimeN () const
 
virtual cmn_position_type positionDetector (const std::string &Name) const
 Retrieve the stream position for the detector. More...
 
virtual cmn_position_type positionH (INT_4U FrameIndex) const
 
virtual const cmn_name_container_typenameADC () const
 
virtual cmn_position_type positionADC (INT_4U FrameIndex, const std::string &Channel) const
 
virtual cmn_position_type positionADC (INT_4U FrameIndex, INT_4U Channel) const
 
virtual cmn_position_type positionEvent (INT_4U FrameIndex, const std::string &Channel) const
 
virtual cmn_position_type positionEvent (const std::string &EventType, INT_4U Index) const
 
virtual const cmn_name_container_typenameProc () const
 
virtual cmn_position_type positionProc (INT_4U FrameIndex, const std::string &Channel) const
 
virtual cmn_position_type positionProc (INT_4U FrameIndex, INT_4U Channel) const
 
virtual const cmn_name_container_typenameSer () const
 
virtual cmn_position_type positionSer (INT_4U FrameIndex, const std::string &Channel) const
 
virtual const cmn_name_container_typenameSim () const
 
virtual cmn_position_type positionSim (INT_4U FrameIndex, const std::string &Channel) const
 
virtual cmn_position_type positionSimEvent (INT_4U FrameIndex, const std::string &Channel) const
 
virtual cmn_position_type positionSimEvent (const std::string &EventType, INT_4U Index) const
 
virtual void cacheAdcDataPositions (istream_type &Stream)
 Cache where the positions of the Adc channels. More...
 
virtual void seekAdcDataPositions (istream_type &Stream, 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 INT_4U nSH () const
 
virtual INT_2U SHid (INT_4U Offset) const
 
virtual const std::string & SHname (INT_4U Offset) const
 
void setAdcDataPoisitions ()
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void write (Common::OStream &Stream) const
 
void write (Common::OStream &Stream) const
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void cachePositions (istream_type &Stream)
 
void seekPositions (istream_type &Stream, channelID_type Channel)
 
void seekPositions (istream_type &Stream, const std::string &Channel)
 
void write (Common::OStream &Stream) const
 
bool operator== (const PositionWithCache &RHS) const
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void write (Common::OStream &Stream) const
 
const Map_typegetInfo () const
 
Map_type::const_iterator getInfo (const std::string &Name) const
 
Map_type::const_iterator getInfo (INT_4U Index) const
 
void cachePositions (istream_type &Stream)
 TOC optimization. More...
 
void setPositionsOffset (istream_type &Stream)
 
bool operator== (const FrTOCPosition &RHS) const
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void write (Common::OStream &Stream) const
 
const Map_typegetInfo () const
 
Map_type::const_iterator getInfo (const std::string &Name) const
 
Map_type::const_iterator getInfo (INT_4U Index) const
 
bool operator== (const FrTOCPosition &RHS) const
 
void write (Common::OStream &Stream) const
 
const Map_typegetInfo () const
 
Map_type::const_iterator getInfo (const std::string &Name) const
 
Map_type::const_iterator getInfo (INT_4U Index) const
 
bool operator== (const FrTOCPosition &RHS) const
 
void write (Common::OStream &Stream) const
 
const Map_typegetInfo () const
 
Map_type::const_iterator getInfo (const std::string &Name) const
 
Map_type::const_iterator getInfo (INT_4U Index) const
 
void write (Common::OStream &Stream) const
 
void write (Common::OStream &Stream) const
 

Protected Attributes

uleaps_type m_ULeapS
 
localTime_type m_localTime
 
gtimes_container_type m_GTimeS
 
gtimen_container_type m_GTimeN
 
dt_container_type m_dt
 
runs_container_type m_runs
 
frame_container_type m_frame
 
positionH_container_type m_positionH
 
nFirstADC_container_type m_nFirstADC
 
nFirstSer_container_type m_nFirstSer
 
nFirstTable_container_type m_nFirstTable
 
nFirstMsg_container_type m_nFirstMsg
 
shid_container_type m_SHid
 
shname_container_type m_SHname
 
stat_container_type m_info
 
key_container_type m_keys
 
MapADC_type m_adc_info
 
key_container_type m_keys
 
Map_type m_info
 
key_container_type m_keys
 
Map_type m_info
 
key_container_type m_keys
 
Map_type m_info
 
key_container_type m_keys
 
Map_type m_info
 
MapTrig_type m_info
 
MapSimEvt_type m_info
 

Member Typedef Documentation

◆ base_type

◆ channel_id_type

typedef INT_4U FrameCPP::Common::FrTOC::channel_id_type
inherited

◆ channelID_type

◆ cmn_dt_container_type

typedef std::vector< REAL_8 > FrameCPP::Common::FrTOC::cmn_dt_container_type
inherited

◆ cmn_GTimeN_container_type

typedef std::vector< INT_4U > FrameCPP::Common::FrTOC::cmn_GTimeN_container_type
inherited

◆ cmn_GTimeS_container_type

typedef std::vector< INT_4U > FrameCPP::Common::FrTOC::cmn_GTimeS_container_type
inherited

◆ cmn_name_container_type

typedef std::vector< STRING< INT_2U > > FrameCPP::Common::FrTOC::cmn_name_container_type
inherited

◆ cmn_position_type

◆ demote_arg_type

◆ demote_ret_type

◆ detector_type

◆ dt_container_type

Array of FrDetector names.

◆ dt_type

typedef REAL_8 FrameCPP::Version_4::FrTOCData::dt_type
inherited

◆ frame_container_type

◆ frame_count_type [1/4]

◆ frame_count_type [2/4]

◆ frame_count_type [3/4]

◆ frame_count_type [4/4]

◆ frame_spec_version_type

◆ frame_type

◆ groupID_type

◆ gtimen_container_type

◆ gtimen_type

◆ gtimenSimEvent_type

◆ gtimenTrigData_type

◆ gtimes_container_type

◆ gtimes_type

◆ gtimesSimEvent_type

◆ gtimesTrigData_type

◆ info_type [1/4]

◆ info_type [2/4]

◆ info_type [3/4]

◆ info_type [4/4]

◆ key_container_type [1/5]

◆ key_container_type [2/5]

◆ key_container_type [3/5]

◆ key_container_type [4/5]

typedef std::vector< name_type > FrameCPP::Version_4::FrTOCAdcData::key_container_type
protectedinherited

◆ key_container_type [5/5]

◆ localTime_type

◆ Map_type [1/4]

◆ Map_type [2/4]

◆ Map_type [3/4]

◆ Map_type [4/4]

◆ MapADC_type

◆ MapProc_type

◆ MapSer_type

◆ MapSim_type

◆ MapSimEvt_type

◆ MapStatType_type

◆ MapSummary_type

◆ MapTrig_type

◆ n_type [1/4]

◆ n_type [2/4]

◆ n_type [3/4]

◆ n_type [4/4]

◆ nADC_type

◆ name_type [1/8]

◆ name_type [2/8]

◆ name_type [3/8]

◆ name_type [4/8]

◆ name_type [5/8]

◆ name_type [6/8]

◆ name_type [7/8]

◆ name_type [8/8]

◆ nFirstADC_container_type

◆ nFirstMsg_container_type

◆ nFirstSer_container_type

◆ nFirstTable_container_type

◆ nframe_type

◆ nproc_type

◆ nser_type

◆ nsh_type

typedef INT_4U FrameCPP::Version_4::FrTOCData::nsh_type
inherited

◆ nsim_type

◆ nSimEvt_type

◆ nstat_instance_type

◆ nstat_type

◆ nsummary_type

◆ nTrig_type

◆ object_type

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

◆ position_list_type

◆ position_type

◆ positionH_container_type

◆ positionSimEvent_type

◆ positionStat_type

◆ positionTrigData_type

◆ proc_info_type

◆ promote_arg_type

◆ promote_ret_type

◆ runs_container_type

◆ runs_type

◆ ser_info_type

◆ shid_container_type

◆ shid_type

◆ shname_container_type

◆ shname_type

◆ sim_info_type

◆ stat_container_type

◆ stat_instance_container_type

◆ summary_info_type

◆ tend_type

◆ tstart_type

◆ uleaps_type

◆ unique_object_type

◆ version_type

Member Enumeration Documentation

◆ query_info_type

Enumerator
TOC_CHANNEL_NAMES 
TOC_DETECTOR 
TOC_FR_STRUCTS 

Constructor & Destructor Documentation

◆ FrTOC()

FrameCPP::Version_4::FrTOC::FrTOC ( )

Member Function Documentation

◆ Bytes()

Common::FrameSpec::size_type FrameCPP::Version_4::FrTOC::Bytes ( const Common::StreamBase Stream) const
virtual

Return the number of bytes for this object.

Parameters
[in]StreamThe stream on which the object will be written or read.
Returns
The number of bytes required by this object for the specified stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ cacheAdcDataPositions()

void FrameCPP::Version_4::FrTOC::cacheAdcDataPositions ( istream_type Stream)
protectedvirtual

Cache where the positions of the Adc channels.

Parameters
[in,out]StreamThe Stream being read

Implements FrameCPP::Common::FrTOC.

◆ cachePositions() [1/2]

void FrameCPP::Version_4::FrTOCAdcData::cachePositions ( istream_type Stream)
inlineprotectedinherited

◆ cachePositions() [2/2]

void FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCPosition::position_type >::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.

◆ Clone()

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtualinherited

◆ Create() [1/3]

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

constructor - virtual

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Create() [2/3]

FrTOC * FrameCPP::Version_4::FrTOC::Create ( istream_type Stream) const
virtual

constructor - virtual

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Create() [3/3]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( std::istream &  Buffer) const
virtualinherited

constructor - virtual

Reimplemented in FrameCPP::Version_8::FrHeader, and FrameCPP::Version_3::FrHeader.

◆ demote()

FrTOC::demote_ret_type FrameCPP::Version_4::FrTOC::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Down grade an object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ DemoteObject()

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type  Target,
object_type  Obj,
istream_type Stream 
)
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ Description() [1/9]

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

◆ Description() [2/9]

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

◆ Description() [3/9]

void FrameCPP::Version_4::FrTOCSimData::Description ( Common::Description Desc)
staticinherited

◆ Description() [4/9]

void FrameCPP::Version_4::FrTOCProcData::Description ( Common::Description Desc)
staticinherited

◆ Description() [5/9]

void FrameCPP::Version_4::FrTOCSimEvent::Description ( Common::Description Desc)
staticinherited

◆ Description() [6/9]

void FrameCPP::Version_4::FrTOCAdcData::Description ( Common::Description Desc)
staticinherited

◆ Description() [7/9]

void FrameCPP::Version_4::FrTOCTrigData::Description ( Common::Description Desc)
staticinherited

◆ Description() [8/9]

void FrameCPP::Version_4::FrTOCStatData::Description ( Common::Description Desc)
staticinherited

◆ Description() [9/9]

void FrameCPP::Version_4::FrTOCData::Description ( Common::Description Desc)
staticinherited

◆ dt()

const FrTOC::cmn_dt_container_type & FrameCPP::Version_4::FrTOC::dt ( ) const
protectedvirtual

◆ forEach() [1/4]

void FrameCPP::Version_4::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() [2/4]

void FrameCPP::Version_4::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() [3/4]

void FrameCPP::Version_4::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()

void FrameCPP::Version_4::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

Reimplemented from FrameCPP::Common::FrTOC.

◆ forEach() [4/4]

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

◆ FrStatDataQuery()

void FrameCPP::Version_4::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

◆ GetADC() [1/3]

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

◆ GetADC() [2/3]

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

◆ GetADC() [3/3]

FrTOCAdcData::MapADC_type::const_iterator FrameCPP::Version_4::FrTOCAdcData::GetADC ( INT_4U  index) const
inlineinherited

◆ GetClass()

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inlineinherited

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass()

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetDescription()

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
inlinevirtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetDt()

const FrTOCData::dt_container_type & FrameCPP::Version_4::FrTOCData::GetDt ( ) const
inlineinherited

◆ GetFrame()

const FrTOCData::frame_container_type & FrameCPP::Version_4::FrTOCData::GetFrame ( ) const
inlineinherited

◆ GetGTimeN()

const FrTOCData::gtimen_container_type & FrameCPP::Version_4::FrTOCData::GetGTimeN ( ) const
inlineinherited

◆ GetGTimeS()

const FrTOCData::gtimes_container_type & FrameCPP::Version_4::FrTOCData::GetGTimeS ( ) const
inlineinherited

◆ getInfo() [1/12]

const FrTOCPosition::Map_type & FrameCPP::Version_4::FrTOCPosition::getInfo ( ) const
inlineprotectedinherited

◆ getInfo() [2/12]

const FrTOCPosition::Map_type & FrameCPP::Version_4::FrTOCPosition::getInfo ( ) const
inlineprotectedinherited

◆ getInfo() [3/12]

const FrTOCPosition::Map_type & FrameCPP::Version_4::FrTOCPosition::getInfo ( ) const
inlineprotectedinherited

◆ getInfo() [4/12]

FrTOCPosition::Map_type::const_iterator FrameCPP::Version_4::FrTOCPosition::getInfo ( const std::string &  Name) const
inlineprotectedinherited

◆ getInfo() [5/12]

FrTOCPosition::Map_type::const_iterator FrameCPP::Version_4::FrTOCPosition::getInfo ( const std::string &  Name) const
inlineprotectedinherited

◆ getInfo() [6/12]

FrTOCPosition::Map_type::const_iterator FrameCPP::Version_4::FrTOCPosition::getInfo ( const std::string &  Name) const
inlineprotectedinherited

◆ getInfo() [7/12]

FrTOCPosition::Map_type::const_iterator FrameCPP::Version_4::FrTOCPosition::getInfo ( INT_4U  Index) const
inlineprotectedinherited

◆ getInfo() [8/12]

FrTOCPosition::Map_type::const_iterator FrameCPP::Version_4::FrTOCPosition::getInfo ( INT_4U  Index) const
inlineprotectedinherited

◆ getInfo() [9/12]

FrTOCPosition::Map_type::const_iterator FrameCPP::Version_4::FrTOCPosition::getInfo ( INT_4U  Index) const
inlineprotectedinherited

◆ getInfo() [10/12]

const Map_type& FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCPosition::position_type >::getInfo ( ) const
inlineprotectedinherited

◆ getInfo() [11/12]

Map_type::const_iterator FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCPosition::position_type >::getInfo ( const std::string &  Name) const
inlineprotectedinherited

◆ getInfo() [12/12]

Map_type::const_iterator FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCPosition::position_type >::getInfo ( INT_4U  Index) const
inlineprotectedinherited

◆ GetLocalTime()

FrTOCData::localTime_type FrameCPP::Version_4::FrTOCData::GetLocalTime ( ) const
inlineinherited

◆ GetNFirstADC()

const FrTOCData::nFirstADC_container_type & FrameCPP::Version_4::FrTOCData::GetNFirstADC ( ) const
inlineinherited

◆ GetNFirstMsg()

const FrTOCData::nFirstMsg_container_type & FrameCPP::Version_4::FrTOCData::GetNFirstMsg ( ) const
inlineinherited

◆ GetNFirstSer()

const FrTOCData::nFirstSer_container_type & FrameCPP::Version_4::FrTOCData::GetNFirstSer ( ) const
inlineinherited

◆ GetNFirstTable()

const FrTOCData::nFirstTable_container_type & FrameCPP::Version_4::FrTOCData::GetNFirstTable ( ) const
inlineinherited

◆ GetNFrame()

FrTOCData::nframe_type FrameCPP::Version_4::FrTOCData::GetNFrame ( ) const
inlineinherited

◆ GetPositionH()

const FrTOCData::positionH_container_type & FrameCPP::Version_4::FrTOCData::GetPositionH ( ) const
inlineinherited

◆ GetPositionKeys() [1/4]

const FrTOCPosition::key_container_type & FrameCPP::Version_4::FrTOCPosition::GetPositionKeys ( ) const
inlineinherited

◆ GetPositionKeys() [2/4]

const FrTOCPosition::key_container_type & FrameCPP::Version_4::FrTOCPosition::GetPositionKeys ( ) const
inlineinherited

◆ GetPositionKeys() [3/4]

const FrTOCPosition::key_container_type & FrameCPP::Version_4::FrTOCPosition::GetPositionKeys ( ) const
inlineinherited

◆ GetPositionKeys() [4/4]

◆ GetProc() [1/3]

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

◆ GetProc() [2/3]

FrTOCProcData::MapProc_type::const_iterator FrameCPP::Version_4::FrTOCProcData::GetProc ( const std::string &  Name) const
inlineinherited

◆ GetProc() [3/3]

FrTOCProcData::MapProc_type::const_iterator FrameCPP::Version_4::FrTOCProcData::GetProc ( INT_4U  index) const
inlineinherited

◆ GetRuns()

const FrTOCData::runs_container_type & FrameCPP::Version_4::FrTOCData::GetRuns ( ) const
inlineinherited

◆ GetSer() [1/3]

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

◆ GetSer() [2/3]

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

◆ GetSer() [3/3]

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

◆ GetSHid()

const FrTOCData::shid_container_type & FrameCPP::Version_4::FrTOCData::GetSHid ( ) const
inlineinherited

◆ GetSHname()

const FrTOCData::shname_container_type & FrameCPP::Version_4::FrTOCData::GetSHname ( ) const
inlineinherited

◆ GetSim() [1/3]

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

◆ GetSim() [2/3]

FrTOCSimData::MapSim_type::const_iterator FrameCPP::Version_4::FrTOCSimData::GetSim ( const std::string &  Name) const
inlineinherited

◆ GetSim() [3/3]

FrTOCSimData::MapSim_type::const_iterator FrameCPP::Version_4::FrTOCSimData::GetSim ( INT_4U  index) const
inlineinherited

◆ GetSimEvent() [1/2]

const FrTOCSimEvent::MapSimEvt_type & FrameCPP::Version_4::FrTOCSimEvent::GetSimEvent ( ) const
inlineinherited

◆ GetSimEvent() [2/2]

FrTOCSimEvent::MapSimEvt_type::const_iterator FrameCPP::Version_4::FrTOCSimEvent::GetSimEvent ( const std::string &  Channel) const
inlineinherited

◆ GetStat()

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

◆ GetStatType()

const FrTOC::MapStatType_type & FrameCPP::Version_4::FrTOC::GetStatType ( ) const
inline

◆ GetSummary() [1/3]

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

◆ GetSummary() [2/3]

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

◆ GetSummary() [3/3]

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

◆ GetTrigData() [1/2]

const FrTOCTrigData::MapTrig_type & FrameCPP::Version_4::FrTOCTrigData::GetTrigData ( ) const
inlineinherited

◆ GetTrigData() [2/2]

FrTOCTrigData::MapTrig_type::const_iterator FrameCPP::Version_4::FrTOCTrigData::GetTrigData ( const std::string &  Name) const
inlineinherited

◆ GetULeapS()

FrTOCData::uleaps_type FrameCPP::Version_4::FrTOCData::GetULeapS ( ) const
inlineinherited

◆ GTimeN()

const FrTOC::cmn_GTimeN_container_type & FrameCPP::Version_4::FrTOC::GTimeN ( ) const
protectedvirtual

◆ GTimeS()

const FrTOC::cmn_GTimeS_container_type & FrameCPP::Version_4::FrTOC::GTimeS ( ) const
protectedvirtual

◆ IndexObject()

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

◆ nameADC()

const FrTOC::cmn_name_container_type & FrameCPP::Version_4::FrTOC::nameADC ( ) const
protectedvirtual

◆ nameProc()

const FrTOC::cmn_name_container_type & FrameCPP::Version_4::FrTOC::nameProc ( ) const
protectedvirtual

◆ nameSer()

const FrTOC::cmn_name_container_type & FrameCPP::Version_4::FrTOC::nameSer ( ) const
protectedvirtual

◆ nameSim()

const FrTOC::cmn_name_container_type & FrameCPP::Version_4::FrTOC::nameSim ( ) const
protectedvirtual

◆ nFrame()

INT_4U FrameCPP::Version_4::FrTOC::nFrame ( ) const
protectedvirtual

◆ nSH()

INT_4U FrameCPP::Version_4::FrTOC::nSH ( ) const
protectedvirtual

◆ ObjectStructName()

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

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [1/14]

bool FrameCPP::Version_4::FrTOCSimEvent::operator== ( const FrTOCSimEvent RHS) const
inherited

◆ operator==() [2/14]

bool FrameCPP::Version_4::FrTOCSerData::operator== ( const FrTOCSerData RHS) const
inherited

◆ operator==() [3/14]

bool FrameCPP::Version_4::FrTOCSummary::operator== ( const FrTOCSummary RHS) const
inherited

◆ operator==() [4/14]

bool FrameCPP::Version_4::FrTOCSimData::operator== ( const FrTOCSimData RHS) const
inherited

◆ operator==() [5/14]

bool FrameCPP::Version_4::FrTOCProcData::operator== ( const FrTOCProcData RHS) const
inherited

◆ operator==() [6/14]

bool FrameCPP::Version_4::FrTOCTrigData::operator== ( const FrTOCTrigData RHS) const
inherited

◆ operator==() [7/14]

bool FrameCPP::Version_4::FrTOCPosition::operator== ( const FrTOCPosition RHS) const
protectedinherited

◆ operator==() [8/14]

bool FrameCPP::Version_4::FrTOCPosition::operator== ( const FrTOCPosition RHS) const
protectedinherited

◆ operator==() [9/14]

bool FrameCPP::Version_4::FrTOCPosition::operator== ( const FrTOCPosition RHS) const
protectedinherited

◆ operator==() [10/14]

bool FrameCPP::Version_4::FrTOCStatData::operator== ( const FrTOCStatData RHS) const
inherited

◆ operator==() [11/14]

bool FrameCPP::Version_4::FrTOCAdcData::operator== ( const FrTOCAdcData RHS) const
inherited

◆ operator==() [12/14]

bool FrameCPP::Version_4::FrTOCData::operator== ( const FrTOCData RHS) const
inlineinherited

◆ operator==() [13/14]

bool FrameCPP::Version_4::FrTOC::operator== ( const Common::FrameSpec::Object Obj) const
virtual

comparison operator

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [14/14]

bool FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCPosition::position_type >::operator== ( const PositionWithCache< STRING, FrTOCPosition::position_type > &  RHS) const
inlineprotectedinherited

◆ positionADC() [1/2]

FrTOC::cmn_position_type FrameCPP::Version_4::FrTOC::positionADC ( INT_4U  FrameIndex,
const std::string &  Channel 
) const
protectedvirtual

◆ positionADC() [2/2]

FrTOC::cmn_position_type FrameCPP::Version_4::FrTOC::positionADC ( INT_4U  FrameIndex,
INT_4U  Channel 
) const
protectedvirtual

◆ positionDetector()

FrTOC::cmn_position_type FrameCPP::Version_4::FrTOC::positionDetector ( const std::string &  Name) const
protectedvirtual

Retrieve the stream position for the detector.

Parameters
[in]NameThe name of the detector for which the position is being requested.
Returns
Upon successfully locating the requested detector, its position within the stream is returned, otherwise a detailed exception is throw.

Implements FrameCPP::Common::FrTOC.

◆ positionEvent() [1/2]

FrTOC::cmn_position_type FrameCPP::Version_4::FrTOC::positionEvent ( INT_4U  FrameIndex,
const std::string &  Channel 
) const
protectedvirtual

◆ positionEvent() [2/2]

FrTOC::cmn_position_type FrameCPP::Version_4::FrTOC::positionEvent ( const std::string &  EventType,
INT_4U  Index 
) const
protectedvirtual
Todo:
Need to fix

Implements FrameCPP::Common::FrTOC.

◆ positionH()

FrTOC::cmn_position_type FrameCPP::Version_4::FrTOC::positionH ( INT_4U  FrameIndex) const
protectedvirtual

◆ positionProc() [1/2]

FrTOC::cmn_position_type FrameCPP::Version_4::FrTOC::positionProc ( INT_4U  FrameIndex,
const std::string &  Channel 
) const
protectedvirtual

◆ positionProc() [2/2]

FrTOC::cmn_position_type FrameCPP::Version_4::FrTOC::positionProc ( INT_4U  FrameIndex,
INT_4U  Channel 
) const
protectedvirtual

◆ positionSer()

FrTOC::cmn_position_type FrameCPP::Version_4::FrTOC::positionSer ( INT_4U  FrameIndex,
const std::string &  Channel 
) const
protectedvirtual

◆ positionSim()

FrTOC::cmn_position_type FrameCPP::Version_4::FrTOC::positionSim ( INT_4U  FrameIndex,
const std::string &  Channel 
) const
protectedvirtual

◆ positionSimEvent() [1/2]

FrTOC::cmn_position_type FrameCPP::Version_4::FrTOC::positionSimEvent ( INT_4U  FrameIndex,
const std::string &  Channel 
) const
protectedvirtual

◆ positionSimEvent() [2/2]

FrTOC::cmn_position_type FrameCPP::Version_4::FrTOC::positionSimEvent ( const std::string &  EventType,
INT_4U  Index 
) const
protectedvirtual
Todo:
Need to fix

Implements FrameCPP::Common::FrTOC.

◆ procDataCachePositions()

void FrameCPP::Version_4::FrTOC::procDataCachePositions ( istream_type Stream)
protectedvirtual

Cache where the positions of the FrProcData channels.

Parameters
[in,out]StreamThe Stream being read

Implements FrameCPP::Common::FrTOC.

◆ promote()

FrTOC::promote_ret_type FrameCPP::Version_4::FrTOC::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Upgrade an object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ PromoteObject() [1/3]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [2/3]

template<typename PreviousType , typename CurrentType >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [3/3]

template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type  Target,
FrameSpec::ObjectInterface::frame_spec_version_type  Source,
FrameSpec::ObjectInterface::promote_arg_type  Obj,
IStream Stream 
)
inherited

◆ QueryADC()

void FrameCPP::Version_4::FrTOCAdcData::QueryADC ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

◆ QueryProc()

void FrameCPP::Version_4::FrTOCProcData::QueryProc ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

◆ QuerySer()

void FrameCPP::Version_4::FrTOCSerData::QuerySer ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

◆ QuerySim()

void FrameCPP::Version_4::FrTOCSimData::QuerySim ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

◆ QuerySimEvent()

void FrameCPP::Version_4::FrTOCSimEvent::QuerySimEvent ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

◆ QueryStatData()

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

◆ QuerySum()

void FrameCPP::Version_4::FrTOCSummary::QuerySum ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

◆ QueryTrigData()

void FrameCPP::Version_4::FrTOCTrigData::QueryTrigData ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

◆ seekAdcDataPositions() [1/2]

void FrameCPP::Version_4::FrTOC::seekAdcDataPositions ( istream_type Stream,
channel_id_type  Channel 
)
protectedvirtual

Advance to the specified Adc channel.

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

Implements FrameCPP::Common::FrTOC.

◆ seekAdcDataPositions() [2/2]

void FrameCPP::Version_4::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

Implements FrameCPP::Common::FrTOC.

◆ seekPositions() [1/2]

void FrameCPP::Version_4::FrTOCAdcData::seekPositions ( istream_type Stream,
channelID_type  Channel 
)
inlineprotectedinherited

◆ seekPositions() [2/2]

void FrameCPP::Version_4::FrTOCAdcData::seekPositions ( istream_type Stream,
const std::string &  Channel 
)
inlineprotectedinherited

◆ setAdcDataPoisitions()

void FrameCPP::Common::FrTOC::setAdcDataPoisitions ( )
protectedinherited

◆ setPositionsOffset()

void FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCPosition::position_type >::setPositionsOffset ( istream_type Stream)
inlineprotectedinherited

◆ SHid()

INT_2U FrameCPP::Version_4::FrTOC::SHid ( INT_4U  Offset) const
protectedvirtual

◆ SHname()

const std::string & FrameCPP::Version_4::FrTOC::SHname ( INT_4U  Offset) const
protectedvirtual

◆ StructDescription()

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

◆ StructName()

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

◆ VerifyObject()

void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited

◆ write() [1/9]

void FrameCPP::Version_4::FrTOCSerData::write ( Common::OStream Stream) const
inlineprotectedinherited

◆ write() [2/9]

void FrameCPP::Version_4::FrTOCSummary::write ( Common::OStream Stream) const
inlineprotectedinherited

◆ write() [3/9]

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

◆ write() [4/9]

void FrameCPP::Version_4::FrTOCTrigData::write ( Common::OStream Stream) const
protectedinherited

◆ write() [5/9]

void FrameCPP::Version_4::FrTOCSimData::write ( Common::OStream Stream) const
inlineprotectedinherited

◆ write() [6/9]

void FrameCPP::Version_4::FrTOCProcData::write ( Common::OStream Stream) const
inlineprotectedinherited

◆ write() [7/9]

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

◆ write() [8/9]

void FrameCPP::Version_4::FrTOCAdcData::write ( Common::OStream Stream) const
inlineprotectedinherited

◆ write() [9/9]

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

◆ Write()

void FrameCPP::Version_4::FrTOC::Write ( ostream_type Stream) const
virtual

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ WriteNext()

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

Member Data Documentation

◆ m_adc_info

MapADC_type FrameCPP::Version_4::FrTOCAdcData::m_adc_info
protectedinherited

◆ m_dt

dt_container_type FrameCPP::Version_4::FrTOCData::m_dt
protectedinherited

◆ m_frame

frame_container_type FrameCPP::Version_4::FrTOCData::m_frame
protectedinherited

◆ m_GTimeN

gtimen_container_type FrameCPP::Version_4::FrTOCData::m_GTimeN
protectedinherited

◆ m_GTimeS

gtimes_container_type FrameCPP::Version_4::FrTOCData::m_GTimeS
protectedinherited

◆ m_info [1/7]

Map_type FrameCPP::Version_4::FrTOCPosition::m_info
protectedinherited

◆ m_info [2/7]

Map_type FrameCPP::Version_4::FrTOCPosition::m_info
protectedinherited

◆ m_info [3/7]

Map_type FrameCPP::Version_4::FrTOCPosition::m_info
protectedinherited

◆ m_info [4/7]

MapSimEvt_type FrameCPP::Version_4::FrTOCSimEvent::m_info
protectedinherited

◆ m_info [5/7]

MapTrig_type FrameCPP::Version_4::FrTOCTrigData::m_info
protectedinherited

◆ m_info [6/7]

stat_container_type FrameCPP::Version_4::FrTOCStatData::m_info
protectedinherited

◆ m_info [7/7]

◆ m_keys [1/5]

key_container_type FrameCPP::Version_4::FrTOCPosition::m_keys
protectedinherited

◆ m_keys [2/5]

key_container_type FrameCPP::Version_4::FrTOCPosition::m_keys
protectedinherited

◆ m_keys [3/5]

key_container_type FrameCPP::Version_4::FrTOCPosition::m_keys
protectedinherited

◆ m_keys [4/5]

key_container_type FrameCPP::Version_4::FrTOCAdcData::m_keys
protectedinherited

◆ m_keys [5/5]

◆ m_localTime

localTime_type FrameCPP::Version_4::FrTOCData::m_localTime
protectedinherited

◆ m_nFirstADC

nFirstADC_container_type FrameCPP::Version_4::FrTOCData::m_nFirstADC
protectedinherited

◆ m_nFirstMsg

nFirstMsg_container_type FrameCPP::Version_4::FrTOCData::m_nFirstMsg
protectedinherited

◆ m_nFirstSer

nFirstSer_container_type FrameCPP::Version_4::FrTOCData::m_nFirstSer
protectedinherited

◆ m_nFirstTable

nFirstTable_container_type FrameCPP::Version_4::FrTOCData::m_nFirstTable
protectedinherited

◆ m_positionH

positionH_container_type FrameCPP::Version_4::FrTOCData::m_positionH
protectedinherited

◆ m_runs

runs_container_type FrameCPP::Version_4::FrTOCData::m_runs
protectedinherited

◆ m_SHid

shid_container_type FrameCPP::Version_4::FrTOCData::m_SHid
protectedinherited

◆ m_SHname

shname_container_type FrameCPP::Version_4::FrTOCData::m_SHname
protectedinherited

◆ m_ULeapS

uleaps_type FrameCPP::Version_4::FrTOCData::m_ULeapS
protectedinherited

◆ NO_DATA_AVAILABLE

const INT_4U FrameCPP::Version_4::FrTOC::NO_DATA_AVAILABLE = 0xFFFFFFFF
static

◆ s_object_id

const Common::FrameSpec::Info::frame_object_types FrameCPP::Common::FrTOC::s_object_id = Common::FrameSpec::Info::FSI_FR_TOC
staticinherited

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