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

Table of Contents Data Structure Definition. More...

#include <FrTOC.hh>

Inheritance diagram for FrameCPP::Version_9::FrTOC:
Collaboration diagram for FrameCPP::Version_9::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
 
typedef INT_8U position_type
 
typedef std::vector< position_typeposition_list_type
 
typedef LDASTools::AL::unordered_map< StatTypeKey, StatType_type, StatTypeKeyHashMapStatType_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 
typedef INT_4U data_quality_type
 
typedef REAL_8 dt_type
 
typedef std::string file_base_name_type
 
typedef INT_4U gtimen_type
 
typedef INT_4U gtimes_type
 
typedef std::string namedetector_type
 
typedef INT_4U ndetector_type
 
typedef FR_TOC_NFRAME_TYPE nFrame_type
 
typedef INT_4U nsh_type
 
typedef INT_8U positiondetector_type
 
typedef INT_8U positionh_type
 
typedef INT_2U shid_type
 
typedef std::string shname_type
 
typedef std::vector< data_quality_typedata_quality_container_type
 Array of integer QA words from each FrameH.
 
typedef std::vector< dt_typedt_container_type
 Array of frame durations in seconds.
 
typedef std::vector< gtimen_typegtimen_container_type
 Array of integer GPS residual nanoseconds for the frame.
 
typedef std::vector< gtimes_typegtimes_container_type
 Array of integer GPS frame times.
 
typedef std::vector< namedetector_typenamedetector_container_type
 Array of FrDetector names.
 
typedef std::vector< positiondetector_typepositiondetector_container_type
 Array of FrDetector positions.
 
typedef std::vector< positionh_typepositionh_container_type
 Array of FrSH IDs.
 
typedef std::vector< shid_typeshid_container_type
 Array of FrSH IDs.
 
typedef std::vector< shname_typeshname_container_type
 Array of FrSH names.
 
typedef INT_4U nadc_type
 
typedef std::string name_type
 
typedef std::string name_type
 
typedef std::string name_type
 
typedef std::string name_type
 
typedef std::string name_type
 
typedef std::string name_type
 
typedef std::string name_type
 
typedef INT_4U channel_id_type
 
typedef INT_4U group_id_type
 
typedef std::vector< name_typekey_container_type
 
typedef std::vector< name_typekey_container_type
 
typedef std::vector< name_typekey_container_type
 
typedef std::map< name_type, adc_info_typeMapADC_type
 Container of indexed FrAdcData elements.
 
typedef std::vector< position_typeinfo_type
 
typedef std::vector< position_typeinfo_type
 
typedef INT_4U frame_count_type
 
typedef INT_4U frame_count_type
 
typedef INT_4U n_type
 
typedef INT_4U n_type
 
typedef INT_4U nproc_type
 
typedef std::vector< position_typeproc_info_type
 
typedef std::map< name_type, proc_info_typeMapProc_type
 
typedef INT_4U nsim_type
 
typedef std::vector< position_typesim_info_type
 
typedef std::map< name_type, sim_info_typeMapSim_type
 
typedef std::map< name_type, info_typeMapSer_type
 
typedef std::map< name_type, info_typeMapSummary_type
 
typedef INT_4U nevent_type
 
typedef INT_4U nevent_type
 
typedef INT_4U nTotalEvent_type
 
typedef INT_4U gtimesEvent_type
 
typedef INT_4U gtimenEvent_type
 
typedef REAL_4 amplitudeEvent_type
 
typedef INT_8U positionEvent_type
 
typedef LDASTools::AL::GPSTime gtime_type
 
typedef LDASTools::AL::GPSTime gtime_type
 
typedef std::vector< event_typeevents_container_type
 
typedef std::vector< event_typeevents_container_type
 
typedef std::map< name_type, events_container_typenameEvent_container_type
 
typedef INT_4U nTotalSEvent_type
 
typedef INT_4U gtimesSim_type
 
typedef INT_4U gtimenSim_type
 
typedef REAL_4 amplitudeSimEvent_type
 
typedef INT_8U positionSimEvent_type
 
typedef std::map< name_type, events_container_typenameSimEvent_container_type
 
typedef const char *const struct_name_type
 
typedef const char *const struct_desc_type
 
typedef INT_2U const struct_id_type
 

Public Member Functions

 FrTOC ()=default
 Default constructor.
 
 FrTOC (const FrTOC &Source)=default
 Copy Constructor.
 
 FrTOC (const FrameCPP::Common::FrTOC *Source)
 Constructor.
 
virtual void ForEach (query_info_type Info, FunctionBase &Action) const
 Iterate over elements of the Table of Contents.
 
virtual void IndexObject (object_type Object, std::streampos Position)
 Place information about an object into the TOC.
 
virtual FrTOCCreate () const
 Virtual constructor.
 
virtual void FrStatDataQuery (const std::string &NamePattern, const LDASTools::AL::GPSTime &StartTime, const LDASTools::AL::GPSTime &EndTime, const INT_4U Version, Common::FrStatData::Query &Result) const
 Retieve FrStatData data.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
FrTOCoperator= (FrTOC &&TOC)
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator
 
const MapStatType_typeGetStatType () const
 
 FrTOC ()=default
 Default constructor.
 
 FrTOC (const FrTOC &Source)=default
 Copy Constructor.
 
 FrTOC (const FrameCPP::Common::FrTOC *Source)
 Constructor.
 
virtual void ForEach (query_info_type Info, FunctionBase &Action) const
 Iterate over elements of the Table of Contents.
 
virtual void IndexObject (object_type Object, std::streampos Position)
 Place information about an object into the TOC.
 
virtual FrTOCCreate () const
 Virtual constructor.
 
virtual void FrStatDataQuery (const std::string &NamePattern, const LDASTools::AL::GPSTime &StartTime, const LDASTools::AL::GPSTime &EndTime, const INT_4U Version, Common::FrStatData::Query &Result) const
 Retieve FrStatData data.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
FrTOCoperator= (FrTOC &&TOC)
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator
 
const MapStatType_typeGetStatType () const
 
virtual INT_4U GetTOCChecksum ()
 Return TOC identifying checksum.
 
virtual INT_4U GetTOCChecksum ()
 Return TOC identifying checksum.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
Common::FrameSpec::size_type Bytes (const stream_base_type &Stream) const
 
Common::FrameSpec::size_type Bytes (const stream_base_type &Stream) const
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
void Load (istream_type &Stream)
 Read contents from stream.
 
void Load (istream_type &Stream)
 Read contents from stream.
 
void Load (istream_type &Stream, INT_4U FrameCount)
 Read contents from stream.
 
void Load (istream_type &Stream, INT_4U FrameCount)
 Read contents from stream.
 
void Load (istream_type &Stream, INT_4U FrameCount)
 Read contents from stream.
 
void Load (istream_type &Stream, INT_4U FrameCount)
 Read contents from stream.
 
void Load (istream_type &Stream)
 Read contents from stream.
 
void Load (istream_type &Stream)
 Read contents from stream.
 
const file_base_name_typeGetFileBaseName () const
 Retrieve file base name at time of creation.
 
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 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.
 
nFrame_type GetNFrame () const
 
const positionh_container_typeGetPositionH () const
 Retrieve array of FrameH positions.
 
const shid_container_typeGetSHid () const
 Retrieve array of FrSH IDs.
 
const shname_container_typeGetSHname () const
 Retrieve array of FrSH names.
 
const namedetector_container_typeGetNameDetector () const
 Retrieve array of FrDetector names.
 
const positiondetector_container_typeGetPositionDetector () const
 Retrieve array of FrDetector positions.
 
void SetFileBaseName (const file_base_name_type &Source) const
 Set file base name.
 
bool operator== (const FrTOCProcDataClassicIO &RHS) const
 equality operator
 
bool operator== (const FrTOCSimDataClassicIO &RHS) const
 equality operator
 
bool operator== (const FrTOCHeader &RHS) const
 equality operator
 
bool operator== (const FrTOCAdcData &RHS) const
 equality operator
 
void QueryAdc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrAdcData being written.
 
void QueryAdc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrAdcData being written.
 
const MapADC_typeGetADC () const
 Return all channels.
 
MapADC_type::const_iterator GetADC (const std::string &Name) const
 Return the indexed data for a named channel.
 
MapADC_type::const_iterator GetADC (INT_4U Channel) const
 Return the indexed data for an indexed channel.
 
const key_container_typeGetKeys () const
 Retrieve the keys.
 
const key_container_typeGetKeys () const
 Retrieve the keys.
 
void QueryProc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrProcData being written.
 
void QueryProc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrProcData being written.
 
const MapProc_typeGetProc () const
 Return all channels.
 
MapProc_type::const_iterator GetProc (const std::string &Channel) const
 Return the indexed data for a named channel.
 
MapProc_type::const_iterator GetProc (INT_4U Channel) const
 Return the indexed data for a named channel.
 
void QuerySim (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSimData being written.
 
void QuerySim (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSimData being written.
 
const MapSim_typeGetSim () const
 Return all channels.
 
MapSim_type::const_iterator GetSim (const std::string &Channel) const
 Return the indexed data for a named channel.
 
MapSim_type::const_iterator GetSim (INT_4U Channel) const
 Return the indexed data for a named channel.
 
void QuerySer (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSerData being written.
 
void QuerySer (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSerData being written.
 
const key_container_typeGetPositionKeys () const
 
const key_container_typeGetPositionKeys () const
 
const MapSer_typeGetSer () const
 Return all channels.
 
MapSer_type::const_iterator GetSer (const std::string &Channel) const
 Return the indexed data for a named channel.
 
MapSer_type::const_iterator GetSer (INT_4U Channel) const
 Return the indexed data for a named channel.
 
void QuerySum (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSummary being written.
 
void QuerySum (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSummary being written.
 
const MapSummary_typeGetSummary () const
 Return all channels.
 
MapSummary_type::const_iterator GetSummary (const std::string &Channel) const
 Return the indexed data for a named channel.
 
MapSummary_type::const_iterator GetSummary (INT_4U Channel) const
 Return the indexed data for a named channel.
 
void QueryEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrEvent being written.
 
void QueryEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrEvent being written.
 
const nameEvent_container_typeGetEvent () const
 Return all events.
 
void QuerySimEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSimEvent being written.
 
void QuerySimEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 Gather TOC info for FrSimEvent being written.
 
const nameSimEvent_container_typeGetSimEvent () const
 Return all events.
 

Static Public Member Functions

static const char * StructName ()
 The name structure name of this object.
 
static const char * StructName ()
 The name structure name of this object.
 
static const Common::DescriptionStructDescription ()
 The description of structure.
 
static const Common::DescriptionStructDescription ()
 The description of structure.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
template<typename SE>
static void Description (Common::Description &Desc)
 The description of structure.
 
template<typename SE>
static void Description (Common::Description &Desc)
 The description of structure.
 
template<typename SE>
static void Description (Common::Description &Desc)
 The description of structure.
 
template<typename SE>
static void Description (Common::Description &Desc)
 The description of structure.
 
template<typename SE>
static void Description (Common::Description &Desc)
 The description of structure.
 
template<typename SE>
static void Description (Common::Description &Desc)
 The description of structure.
 
template<typename SE>
static void Description (Common::Description &Desc)
 The description of structure.
 
template<typename SE>
static void Description (Common::Description &Desc)
 The description of structure.
 
template<typename SE>
static void Description (Common::Description &Desc)
 The description of structure.
 
static struct_name_type FrameSpecName ()
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
 

Public Attributes

position_type m_positions_start
 

Static Public Attributes

static const INT_4U NO_DATA_AVAILABLE
 
static const int event_type_size
 
static const int event_type_size
 
static struct_name_type struct_name
 
static struct_desc_type struct_desc
 
static struct_id_type struct_id
 

Protected Types

typedef std::vector< name_typekey_container_type
 
typedef STRING io_name_type
 
typedef STRING io_name_type
 
typedef STRING io_name_type
 
typedef std::vector< io_name_typeio_key_container_type
 
typedef std::vector< io_name_typeio_key_container_type
 
typedef std::vector< io_name_typeio_key_container_type
 

Protected Member Functions

virtual INT_4U nFrame () const
 
virtual const cmn_dt_container_type & dt () const
 
virtual const cmn_GTimeS_container_type & GTimeS () const
 
virtual const cmn_GTimeN_container_type & GTimeN () const
 
virtual cmn_runs_container_type const & runs () const
 
virtual cmn_position_type positionDetector (const std::string &Name) const
 
virtual cmn_position_type positionH (INT_4U FrameIndex) const
 
virtual const cmn_name_container_type & nameADC () 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 &Event) const
 
virtual cmn_position_type positionEvent (const std::string &Event, INT_4U Index) const
 
virtual const cmn_name_container_type & nameProc () 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_type & nameSer () const
 
virtual cmn_position_type positionSer (INT_4U FrameIndex, const std::string &Channel) const
 
virtual const cmn_name_container_type & nameSim () 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 &SimEvent) 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.
 
virtual void seekAdcDataPositions (istream_type &Stream, Common::FrTOC::channel_id_type Channel)
 Advance to the specified Adc channel.
 
virtual void seekAdcDataPositions (istream_type &Stream, const std::string &Channel)
 Advance to the specified Adc channel.
 
virtual void procDataCachePositions (istream_type &Stream)
 Cache where the positions of the FrProcData channels.
 
virtual INT_4U nSH () const
 
virtual INT_2U SHid (INT_4U Offset) const
 
virtual const std::string & SHname (INT_4U Offset) const
 
virtual void loadHeader (Common::IStream &Stream)
 
virtual INT_4U nFrame () const
 
virtual const cmn_dt_container_type & dt () const
 
virtual const cmn_GTimeS_container_type & GTimeS () const
 
virtual const cmn_GTimeN_container_type & GTimeN () const
 
virtual cmn_runs_container_type const & runs () const
 
virtual cmn_position_type positionDetector (const std::string &Name) const
 
virtual cmn_position_type positionH (INT_4U FrameIndex) const
 
virtual const cmn_name_container_type & nameADC () 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 &Event) const
 
virtual cmn_position_type positionEvent (const std::string &Event, INT_4U Index) const
 
virtual const cmn_name_container_type & nameProc () 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_type & nameSer () const
 
virtual cmn_position_type positionSer (INT_4U FrameIndex, const std::string &Channel) const
 
virtual const cmn_name_container_type & nameSim () 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 &SimEvent) 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.
 
virtual void seekAdcDataPositions (istream_type &Stream, Common::FrTOC::channel_id_type Channel)
 Advance to the specified Adc channel.
 
virtual void seekAdcDataPositions (istream_type &Stream, const std::string &Channel)
 Advance to the specified Adc channel.
 
virtual void procDataCachePositions (istream_type &Stream)
 Cache where the positions of the FrProcData channels.
 
virtual INT_4U nSH () const
 
virtual INT_2U SHid (INT_4U Offset) const
 
virtual const std::string & SHname (INT_4U Offset) const
 
virtual void loadHeader (Common::IStream &Stream)
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Promotes object to another version of the frame spec.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Promotes object to another version of the frame spec.
 
virtual Common::FrameSpec::size_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual Common::FrameSpec::size_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream.
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream.
 
void Load (istream_type &Stream, INT_4U FrameCount)
 Read contents from stream.
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents.
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents.
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents.
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents.
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
void write (ostream_type &Stream) const
 Write the structure to the stream.
 
void write (ostream_type &Stream) const
 Write the structure to the stream.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
void write (Common::OStream &Stream) const
 Write the structure to the stream.
 
void cachePositions (istream_type &Stream)
 Cache where the positions of the Adc channels.
 
void cachePositions (istream_type &Stream)
 Cache where the positions of the Adc channels.
 
void cachePositions (istream_type &Stream)
 TOC optimization.
 
void seekPositions (istream_type &Stream, channel_id_type Channel)
 Advance to the specified Adc channel.
 
void seekPositions (istream_type &Stream, const std::string &Channel)
 Advance to the specified Adc channel.
 
void seekPositions (istream_type &Stream, channel_id_type Channel)
 Advance to the specified Adc channel.
 
void seekPositions (istream_type &Stream, const std::string &Channel)
 Advance to the specified Adc channel.
 
void setPositionsOffset (istream_type &Stream)
 
void setPositionsOffset (istream_type &Stream)
 
const io_key_container_typeGetIOPositionKeys () const
 
const io_key_container_typeGetIOPositionKeys () const
 
const io_key_container_typeGetIOPositionKeys () const
 

Protected Attributes

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

Private Types

typedef ObjectWithChecksum< Common::FrTOCtoc_base_type
 Object with checksum data.
 
typedef ObjectWithChecksum< Common::FrTOCtoc_base_type
 Object with checksum data.
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_typeobject_base_type
 
typedef STRING io_namedetector_type
 
typedef STRING io_namedetector_type
 
typedef STRING io_shname_type
 
typedef STRING io_shname_type
 
typedef LDASTools::AL::unordered_map< std::string, INT_4U > reverse_lookup_type
 
typedef LDASTools::AL::unordered_map< std::string, INT_4U > reverse_lookup_type
 
typedef std::vector< position_typepositions_cache_type
 
typedef std::vector< position_typepositions_cache_type
 
typedef std::vector< position_typeinfo_type
 
typedef std::vector< position_typeinfo_type
 
typedef std::map< name_type, info_typeMap_type
 
typedef std::map< name_type, info_typeMap_type
 
typedef INT_4U frame_count_type
 
typedef INT_4U frame_count_type
 
typedef INT_4U n_type
 
typedef INT_4U n_type
 

Private Member Functions

template<typename ChannelType>
cmn_position_type position_adc (INT_4U FrameIndex, ChannelType Channel) const
 
template<typename ChannelType>
cmn_position_type position_proc (INT_4U FrameIndex, ChannelType Channel) const
 
const FrTOCoperator= (const FrTOC &Source)
 
const FrTOCoperator= (const Previous::FrTOC &Source)
 
template<typename ChannelType>
cmn_position_type position_adc (INT_4U FrameIndex, ChannelType Channel) const
 
template<typename ChannelType>
cmn_position_type position_proc (INT_4U FrameIndex, ChannelType Channel) const
 
const FrTOCoperator= (const FrTOC &Source)
 
const FrTOCoperator= (const Previous::FrTOC &Source)
 
MapADC_typegetADC ()
 
MapADC_type::iterator getADC (const std::string &Channel)
 
MapADC_type::iterator getADC (INT_4U Channel)
 
MapADC_typegetADC ()
 
MapADC_type::iterator getADC (const std::string &Channel)
 
MapADC_type::iterator getADC (INT_4U Channel)
 
reverse_lookup_type::mapped_type reverse_lookup (const reverse_lookup_type::key_type &Key) const
 
reverse_lookup_type::mapped_type reverse_lookup (const reverse_lookup_type::key_type &Key) const
 

Private Attributes

MapStatType_type m_StatType
 
ChecksumType m_chkSum
 Structure checksum.
 
positions_cache_type positions_cache
 
position_type positions_cache_offset
 
reverse_lookup_type reverse_lookup_
 
frame_count_type frame_count { 0 }
 
Common::FrTOC::cmn_name_container_type name_keys
 

Detailed Description

Table of Contents Data Structure Definition.

Member Typedef Documentation

◆ amplitudeEvent_type

◆ amplitudeSimEvent_type

◆ channel_id_type

◆ data_quality_container_type

Array of integer QA words from each FrameH.

◆ data_quality_type

◆ dt_container_type

typedef std::vector< dt_type > FrameCPP::v9::FrTOCHeader::dt_container_type
inherited

Array of frame durations in seconds.

◆ dt_type

typedef REAL_8 FrameCPP::v9::FrTOCHeader::dt_type
inherited

◆ events_container_type [1/2]

◆ events_container_type [2/2]

◆ file_base_name_type

typedef std::string FrameCPP::v9::FrTOCHeader::file_base_name_type
inherited

◆ frame_count_type [1/4]

◆ frame_count_type [2/4]

◆ frame_count_type [3/4]

◆ frame_count_type [4/4]

◆ group_id_type

◆ gtime_type [1/2]

typedef LDASTools::AL::GPSTime FrameCPP::v8::FrTOCEvent::gtime_type
inherited

◆ gtime_type [2/2]

typedef LDASTools::AL::GPSTime FrameCPP::v8::FrTOCSimEvent::gtime_type
inherited

◆ gtimen_container_type

Array of integer GPS residual nanoseconds for the frame.

◆ gtimen_type

typedef INT_4U FrameCPP::v9::FrTOCHeader::gtimen_type
inherited

◆ gtimenEvent_type

◆ gtimenSim_type

◆ gtimes_container_type

Array of integer GPS frame times.

◆ gtimes_type

typedef INT_4U FrameCPP::v9::FrTOCHeader::gtimes_type
inherited

◆ gtimesEvent_type

◆ gtimesSim_type

◆ info_type [1/4]

typedef std::vector< position_type > FrameCPP::v8::FrTOCSerData::info_type
inherited

◆ info_type [2/4]

typedef std::vector< position_type > FrameCPP::v8::FrTOCSummary::info_type
inherited

◆ info_type [3/4]

◆ info_type [4/4]

◆ io_key_container_type [1/3]

◆ io_key_container_type [2/3]

◆ io_key_container_type [3/3]

◆ io_name_type [1/3]

◆ io_name_type [2/3]

◆ io_name_type [3/3]

◆ io_namedetector_type [1/2]

◆ io_namedetector_type [2/2]

◆ io_shname_type [1/2]

◆ io_shname_type [2/2]

◆ istream_type [1/2]

template<typename ObjectType, typename ChecksumType>
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ istream_type [2/2]

template<typename ObjectType, typename ChecksumType>
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ key_container_type [1/4]

◆ key_container_type [2/4]

typedef std::vector< name_type > FrameCPP::v8::FrTOCSimData::key_container_type
protectedinherited

◆ key_container_type [3/4]

◆ key_container_type [4/4]

◆ Map_type [1/2]

◆ Map_type [2/2]

◆ MapADC_type

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.

◆ MapProc_type

◆ MapSer_type

◆ MapSim_type

◆ MapStatType_type [1/2]

typedef LDASTools::AL:: unordered_map< StatTypeKey, StatType_type, StatTypeKeyHash > FrameCPP::Version_9::FrTOC::MapStatType_type

◆ MapStatType_type [2/2]

typedef LDASTools::AL:: unordered_map< StatTypeKey, StatType_type, StatTypeKeyHash > FrameCPP::Version_9::FrTOC::MapStatType_type

◆ MapSummary_type

◆ n_type [1/4]

typedef INT_4U FrameCPP::v8::FrTOCSerData::n_type
inherited

◆ n_type [2/4]

typedef INT_4U FrameCPP::v8::FrTOCSummary::n_type
inherited

◆ n_type [3/4]

◆ n_type [4/4]

◆ nadc_type

typedef INT_4U FrameCPP::v9::FrTOCAdcData::nadc_type
inherited

◆ name_type [1/7]

typedef std::string FrameCPP::v8::FrTOCEvent::name_type
inherited

◆ name_type [2/7]

typedef std::string FrameCPP::v8::FrTOCProcData::name_type
inherited

◆ name_type [3/7]

typedef std::string FrameCPP::v8::FrTOCSerData::name_type
inherited

◆ name_type [4/7]

typedef std::string FrameCPP::v8::FrTOCSimData::name_type
inherited

◆ name_type [5/7]

typedef std::string FrameCPP::v8::FrTOCSimEvent::name_type
inherited

◆ name_type [6/7]

typedef std::string FrameCPP::v8::FrTOCSummary::name_type
inherited

◆ name_type [7/7]

typedef std::string FrameCPP::v9::FrTOCAdcData::name_type
inherited

◆ namedetector_container_type

◆ namedetector_type

typedef std::string FrameCPP::v9::FrTOCHeader::namedetector_type
inherited

◆ nameEvent_container_type

◆ nameSimEvent_container_type

◆ ndetector_type

◆ nevent_type [1/2]

typedef INT_4U FrameCPP::v8::FrTOCEvent::nevent_type
inherited

◆ nevent_type [2/2]

typedef INT_4U FrameCPP::v8::FrTOCSimEvent::nevent_type
inherited

◆ nFrame_type

◆ nproc_type

typedef INT_4U FrameCPP::v8::FrTOCProcData::nproc_type
inherited

◆ nsh_type

typedef INT_4U FrameCPP::v9::FrTOCHeader::nsh_type
inherited

◆ nsim_type

typedef INT_4U FrameCPP::v8::FrTOCSimData::nsim_type
inherited

◆ nTotalEvent_type

◆ nTotalSEvent_type

◆ object_base_type [1/3]

◆ object_base_type [2/3]

◆ object_base_type [3/3]

◆ ostream_type [1/2]

template<typename ObjectType, typename ChecksumType>
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ ostream_type [2/2]

template<typename ObjectType, typename ChecksumType>
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ position_list_type [1/2]

typedef std::vector< position_type > FrameCPP::Version_9::FrTOC::position_list_type

◆ position_list_type [2/2]

typedef std::vector< position_type > FrameCPP::Version_9::FrTOC::position_list_type

◆ position_type [1/2]

typedef INT_8U FrameCPP::Version_9::FrTOC::position_type

◆ position_type [2/2]

typedef INT_8U FrameCPP::Version_9::FrTOC::position_type

◆ positiondetector_container_type

◆ positiondetector_type

◆ positionEvent_type

◆ positionh_container_type

Array of FrSH IDs.

◆ positionh_type

◆ positions_cache_type [1/2]

◆ positions_cache_type [2/2]

◆ positionSimEvent_type

◆ proc_info_type

◆ reverse_lookup_type [1/2]

typedef LDASTools::AL::unordered_map< std::string, INT_4U > FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::reverse_lookup_type
privateinherited

◆ reverse_lookup_type [2/2]

typedef LDASTools::AL::unordered_map< std::string, INT_4U > FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::reverse_lookup_type
privateinherited

◆ self_type [1/2]

template<typename ObjectType, typename ChecksumType>
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ self_type [2/2]

template<typename ObjectType, typename ChecksumType>
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ shid_container_type

Array of FrSH IDs.

◆ shid_type

typedef INT_2U FrameCPP::v9::FrTOCHeader::shid_type
inherited

◆ shname_container_type

Array of FrSH names.

◆ shname_type

typedef std::string FrameCPP::v9::FrTOCHeader::shname_type
inherited

◆ sim_info_type

typedef std::vector< position_type > FrameCPP::v8::FrTOCSimData::sim_info_type
inherited

◆ struct_desc_type

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_id_type

template<typename Object_T>
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_name_type

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

◆ toc_base_type [1/2]

typedef ObjectWithChecksum< Common::FrTOC > FrameCPP::Version_9::FrTOC::toc_base_type
private

Object with checksum data.

◆ toc_base_type [2/2]

typedef ObjectWithChecksum< Common::FrTOC > FrameCPP::Version_9::FrTOC::toc_base_type
private

Object with checksum data.

Constructor & Destructor Documentation

◆ FrTOC() [1/6]

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

Default constructor.

Returns
A new instance of this object.

◆ FrTOC() [2/6]

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

Copy Constructor.

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

◆ FrTOC() [3/6]

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

Constructor.

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

◆ FrTOC() [4/6]

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

Default constructor.

Returns
A new instance of this object.

◆ FrTOC() [5/6]

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

Copy Constructor.

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

◆ FrTOC() [6/6]

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

Constructor.

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

Member Function Documentation

◆ Bytes() [1/10]

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

Return the number of bytes for this object.

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

◆ Bytes() [2/10]

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

Return the number of bytes for this object.

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

◆ Bytes() [3/10]

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

Number of bytes needed to write this structure.

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

◆ Bytes() [4/10]

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

◆ Bytes() [5/10]

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

Number of bytes needed to write this structure.

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

◆ Bytes() [6/10]

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

Number of bytes needed to write this structure.

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

◆ Bytes() [7/10]

Common::FrameSpec::size_type FrameCPP::Version_9::FrTOCImpl::FrTOCSerDataClassicIO::Bytes ( const stream_base_type & Stream) const
inlineinherited

◆ Bytes() [8/10]

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

Number of bytes needed to write this structure.

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

◆ Bytes() [9/10]

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

Number of bytes needed to write this structure.

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

◆ Bytes() [10/10]

Common::FrameSpec::size_type FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::Bytes ( const stream_base_type & Stream) const
inlineinherited

◆ cacheAdcDataPositions() [1/2]

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

Cache where the positions of the Adc channels.

Parameters
[in,out]StreamThe Stream being read

◆ cacheAdcDataPositions() [2/2]

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

Cache where the positions of the Adc channels.

Parameters
[in,out]StreamThe Stream being read

◆ cachePositions() [1/3]

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

Cache where the positions of the Adc channels.

Parameters
[in,out]StreamThe Stream being read

◆ cachePositions() [2/3]

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

Cache where the positions of the Adc channels.

Parameters
[in,out]StreamThe Stream being read

◆ cachePositions() [3/3]

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

TOC optimization.

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

◆ CheckSumDataClass() [1/2]

template<typename ObjectType, typename ChecksumType>
template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

template<typename ObjectType, typename ChecksumType>
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/2]

template<typename ObjectType, typename ChecksumType>
template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

template<typename ObjectType, typename ChecksumType>
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ Create() [1/3]

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

Virtual constructor.

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

◆ Create() [2/3]

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

Virtual constructor.

Returns
A new instance of this object.

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

◆ Create() [3/3]

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

Virtual constructor.

Returns
A new instance of this object.

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

◆ demote() [1/2]

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

Demotes object to previous version of the frame spec.

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

◆ demote() [2/2]

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

Demotes object to previous version of the frame spec.

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

◆ Description() [1/9]

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

The description of structure.

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

◆ Description() [2/9]

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

The description of structure.

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

◆ Description() [3/9]

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

The description of structure.

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

◆ Description() [4/9]

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

The description of structure.

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

◆ Description() [5/9]

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

The description of structure.

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

◆ Description() [6/9]

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

The description of structure.

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

◆ Description() [7/9]

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

The description of structure.

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

◆ Description() [8/9]

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

The description of structure.

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

◆ Description() [9/9]

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

The description of structure.

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

◆ dt() [1/2]

virtual const cmn_dt_container_type & FrameCPP::Version_9::FrTOC::dt ( ) const
protectedvirtual

◆ dt() [2/2]

virtual const cmn_dt_container_type & FrameCPP::Version_9::FrTOC::dt ( ) const
protectedvirtual

◆ ForEach() [1/2]

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

Iterate over elements of the Table of Contents.

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

◆ ForEach() [2/2]

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

Iterate over elements of the Table of Contents.

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

◆ forEach() [1/5]

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

Iterate over contents.

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

◆ forEach() [2/5]

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

Iterate over contents.

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

◆ forEach() [3/5]

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

Iterate over contents.

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

◆ forEach() [4/5]

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

Iterate over contents.

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

◆ forEach() [5/5]

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

Iterate over contents.

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

◆ FrameSpecDescription()

template<typename Object_T>
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId()

template<typename Object_T>
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecName()

template<typename Object_T>
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ FrStatDataQuery() [1/2]

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

Retieve FrStatData data.

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

◆ FrStatDataQuery() [2/2]

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

Retieve FrStatData data.

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

◆ GetADC() [1/3]

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

Return all channels.

Returns
Constant container to the indexed FrAdcData elements.

◆ GetADC() [2/3]

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

Return the indexed data for a named channel.

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

◆ GetADC() [3/3]

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

Return the indexed data for an indexed channel.

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

◆ getADC() [1/6]

MapADC_type & FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::getADC ( )
inlineprivateinherited

◆ getADC() [2/6]

MapADC_type & FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::getADC ( )
inlineprivateinherited

◆ getADC() [3/6]

MapADC_type::iterator FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::getADC ( const std::string & Channel)
inlineprivateinherited

◆ getADC() [4/6]

MapADC_type::iterator FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::getADC ( const std::string & Channel)
inlineprivateinherited

◆ getADC() [5/6]

MapADC_type::iterator FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::getADC ( INT_4U Channel)
inlineprivateinherited

◆ getADC() [6/6]

MapADC_type::iterator FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::getADC ( INT_4U Channel)
inlineprivateinherited

◆ GetDataQuality()

const data_quality_container_type & FrameCPP::v9::FrTOCHeader::GetDataQuality ( ) const
inlineinherited

Retreive array of integer QA words from each FrameH.

◆ GetDt()

const dt_container_type & FrameCPP::v9::FrTOCHeader::GetDt ( ) const
inlineinherited

Retrieve array of frame durations in seconds.

◆ GetEvent()

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

Return all events.

Returns
Constant container to the indexed FrEvent elements.

◆ GetFileBaseName()

const file_base_name_type & FrameCPP::v9::FrTOCHeader::GetFileBaseName ( ) const
inlineinherited

Retrieve file base name at time of creation.

◆ GetGTimeN()

const gtimes_container_type & FrameCPP::v9::FrTOCHeader::GetGTimeN ( ) const
inlineinherited

Retrieve array of integer GPS residual nanoseconds for the frame.

◆ GetGTimeS()

const gtimen_container_type & FrameCPP::v9::FrTOCHeader::GetGTimeS ( ) const
inlineinherited

Retrieve array of integer GPS frame times.

◆ GetIOPositionKeys() [1/3]

const io_key_container_type & FrameCPP::Version_9::FrTOCImpl::FrTOCSerDataClassicIO::GetIOPositionKeys ( ) const
inlineprotectedinherited

◆ GetIOPositionKeys() [2/3]

const io_key_container_type & FrameCPP::Version_9::FrTOCImpl::FrTOCSerDataClassicIO::GetIOPositionKeys ( ) const
inlineprotectedinherited

◆ GetIOPositionKeys() [3/3]

const io_key_container_type & FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::GetIOPositionKeys ( ) const
inlineprotectedinherited

◆ GetKeys() [1/2]

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

Retrieve the keys.

Returns
Constant container of keys.

◆ GetKeys() [2/2]

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

Retrieve the keys.

Returns
Constant container of keys.

◆ GetNameDetector()

const namedetector_container_type & FrameCPP::v9::FrTOCHeader::GetNameDetector ( ) const
inlineinherited

Retrieve array of FrDetector names.

◆ GetNFrame()

nFrame_type FrameCPP::v9::FrTOCHeader::GetNFrame ( ) const
inlineinherited

◆ GetPositionDetector()

const positiondetector_container_type & FrameCPP::v9::FrTOCHeader::GetPositionDetector ( ) const
inlineinherited

Retrieve array of FrDetector positions.

◆ GetPositionH()

const positionh_container_type & FrameCPP::v9::FrTOCHeader::GetPositionH ( ) const
inlineinherited

Retrieve array of FrameH positions.

◆ GetPositionKeys() [1/2]

const key_container_type & FrameCPP::v8::FrTOCSerData::GetPositionKeys ( ) const
inlineinherited

◆ GetPositionKeys() [2/2]

const key_container_type & FrameCPP::v8::FrTOCSummary::GetPositionKeys ( ) const
inlineinherited

◆ GetProc() [1/3]

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

Return all channels.

Returns
Constant container to the indexed FrProcData elements.

◆ GetProc() [2/3]

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

Return the indexed data for a named channel.

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

◆ GetProc() [3/3]

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

Return the indexed data for a named channel.

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

◆ GetSer() [1/3]

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

Return all channels.

Returns
Constant container to the indexed FrSerData elements.

◆ GetSer() [2/3]

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

Return the indexed data for a named channel.

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

◆ GetSer() [3/3]

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

Return the indexed data for a named channel.

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

◆ GetSHid()

const shid_container_type & FrameCPP::v9::FrTOCHeader::GetSHid ( ) const
inlineinherited

Retrieve array of FrSH IDs.

◆ GetSHname()

const shname_container_type & FrameCPP::v9::FrTOCHeader::GetSHname ( ) const
inlineinherited

Retrieve array of FrSH names.

◆ GetSim() [1/3]

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

Return all channels.

Returns
Constant container to the indexed FrSimData elements.

◆ GetSim() [2/3]

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

Return the indexed data for a named channel.

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

◆ GetSim() [3/3]

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

Return the indexed data for a named channel.

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

◆ GetSimEvent()

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

Return all events.

Returns
Constant container to the indexed FrSimEvent elements.

◆ GetStatType() [1/2]

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

◆ GetStatType() [2/2]

const MapStatType_type & FrameCPP::Version_9::FrTOC::GetStatType ( ) const

◆ GetSummary() [1/3]

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

Return all channels.

Returns
Constant container to the indexed FrSummary elements.

◆ GetSummary() [2/3]

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

Return the indexed data for a named channel.

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

◆ GetSummary() [3/3]

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

Return the indexed data for a named channel.

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

◆ GetTOCChecksum() [1/2]

virtual INT_4U FrameCPP::Version_9::FrTOCImpl::ClassicIO< FrTOC >::GetTOCChecksum ( )
inlinevirtualinherited

Return TOC identifying checksum.

The CRC checksum that characterizes this Table of Contents.

Returns
The checksum that characterizes this Table of Contents structure

◆ GetTOCChecksum() [2/2]

virtual INT_4U FrameCPP::Version_9::FrTOCImpl::ClassicIO< FrTOC >::GetTOCChecksum ( )
inlinevirtualinherited

Return TOC identifying checksum.

The CRC checksum that characterizes this Table of Contents.

Returns
The checksum that characterizes this Table of Contents structure

◆ GTimeN() [1/2]

virtual const cmn_GTimeN_container_type & FrameCPP::Version_9::FrTOC::GTimeN ( ) const
protectedvirtual

◆ GTimeN() [2/2]

virtual const cmn_GTimeN_container_type & FrameCPP::Version_9::FrTOC::GTimeN ( ) const
protectedvirtual

◆ GTimeS() [1/2]

virtual const cmn_GTimeS_container_type & FrameCPP::Version_9::FrTOC::GTimeS ( ) const
protectedvirtual

◆ GTimeS() [2/2]

virtual const cmn_GTimeS_container_type & FrameCPP::Version_9::FrTOC::GTimeS ( ) const
protectedvirtual

◆ IndexObject() [1/2]

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

Place information about an object into the TOC.

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

◆ IndexObject() [2/2]

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

Place information about an object into the TOC.

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

◆ Load() [1/9]

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

Read contents from stream.

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

◆ Load() [2/9]

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

Read contents from stream.

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

◆ Load() [3/9]

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

Read contents from stream.

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

◆ Load() [4/9]

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

Read contents from stream.

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

◆ Load() [5/9]

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

Read contents from stream.

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

◆ Load() [6/9]

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

Read contents from stream.

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

◆ Load() [7/9]

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

Read contents from stream.

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

◆ Load() [8/9]

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

Read contents from stream.

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

◆ Load() [9/9]

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

Read contents from stream.

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

◆ loadHeader() [1/2]

virtual void FrameCPP::Version_9::FrTOC::loadHeader ( Common::IStream & Stream)
protectedvirtual

◆ loadHeader() [2/2]

virtual void FrameCPP::Version_9::FrTOC::loadHeader ( Common::IStream & Stream)
protectedvirtual

◆ nameADC() [1/2]

virtual const cmn_name_container_type & FrameCPP::Version_9::FrTOC::nameADC ( ) const
protectedvirtual

◆ nameADC() [2/2]

virtual const cmn_name_container_type & FrameCPP::Version_9::FrTOC::nameADC ( ) const
protectedvirtual

◆ nameProc() [1/2]

virtual const cmn_name_container_type & FrameCPP::Version_9::FrTOC::nameProc ( ) const
protectedvirtual

◆ nameProc() [2/2]

virtual const cmn_name_container_type & FrameCPP::Version_9::FrTOC::nameProc ( ) const
protectedvirtual

◆ nameSer() [1/2]

virtual const cmn_name_container_type & FrameCPP::Version_9::FrTOC::nameSer ( ) const
protectedvirtual

◆ nameSer() [2/2]

virtual const cmn_name_container_type & FrameCPP::Version_9::FrTOC::nameSer ( ) const
protectedvirtual

◆ nameSim() [1/2]

virtual const cmn_name_container_type & FrameCPP::Version_9::FrTOC::nameSim ( ) const
protectedvirtual

◆ nameSim() [2/2]

virtual const cmn_name_container_type & FrameCPP::Version_9::FrTOC::nameSim ( ) const
protectedvirtual

◆ nFrame() [1/2]

virtual INT_4U FrameCPP::Version_9::FrTOC::nFrame ( ) const
protectedvirtual

◆ nFrame() [2/2]

virtual INT_4U FrameCPP::Version_9::FrTOC::nFrame ( ) const
protectedvirtual

◆ nSH() [1/2]

virtual INT_4U FrameCPP::Version_9::FrTOC::nSH ( ) const
protectedvirtual

◆ nSH() [2/2]

virtual INT_4U FrameCPP::Version_9::FrTOC::nSH ( ) const
protectedvirtual

◆ ObjectStructName() [1/2]

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

The name structure name of this object.

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

◆ ObjectStructName() [2/2]

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

The name structure name of this object.

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

◆ operator=() [1/6]

const FrTOC & FrameCPP::Version_9::FrTOC::operator= ( const FrTOC & Source)
private

◆ operator=() [2/6]

const FrTOC & FrameCPP::Version_9::FrTOC::operator= ( const FrTOC & Source)
private

◆ operator=() [3/6]

const FrTOC & FrameCPP::Version_9::FrTOC::operator= ( const Previous::FrTOC & Source)
private

◆ operator=() [4/6]

const FrTOC & FrameCPP::Version_9::FrTOC::operator= ( const Previous::FrTOC & Source)
private

◆ operator=() [5/6]

FrTOC & FrameCPP::Version_9::FrTOC::operator= ( FrTOC && TOC)
inline

◆ operator=() [6/6]

FrTOC & FrameCPP::Version_9::FrTOC::operator= ( FrTOC && TOC)
inline

◆ operator==() [1/6]

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

equality operator

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

◆ operator==() [2/6]

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

equality operator

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

◆ operator==() [3/6]

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

equality operator

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

◆ operator==() [4/6]

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

equality operator

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

◆ operator==() [5/6]

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

equality operator

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

◆ operator==() [6/6]

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

equality operator

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

◆ pBytes() [1/2]

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

Number of bytes needed to write this structure.

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

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

◆ pBytes() [2/2]

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

Number of bytes needed to write this structure.

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

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

◆ pCreate() [1/2]

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

Virtual constructor.

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

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

◆ pCreate() [2/2]

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

Virtual constructor.

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

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

◆ position_adc() [1/2]

template<typename ChannelType>
cmn_position_type FrameCPP::Version_9::FrTOC::position_adc ( INT_4U FrameIndex,
ChannelType Channel ) const
private

◆ position_adc() [2/2]

template<typename ChannelType>
cmn_position_type FrameCPP::Version_9::FrTOC::position_adc ( INT_4U FrameIndex,
ChannelType Channel ) const
private

◆ position_proc() [1/2]

template<typename ChannelType>
cmn_position_type FrameCPP::Version_9::FrTOC::position_proc ( INT_4U FrameIndex,
ChannelType Channel ) const
private

◆ position_proc() [2/2]

template<typename ChannelType>
cmn_position_type FrameCPP::Version_9::FrTOC::position_proc ( INT_4U FrameIndex,
ChannelType Channel ) const
private

◆ positionADC() [1/4]

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

◆ positionADC() [2/4]

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

◆ positionADC() [3/4]

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

◆ positionADC() [4/4]

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

◆ positionDetector() [1/2]

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

◆ positionDetector() [2/2]

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

◆ positionEvent() [1/4]

virtual cmn_position_type FrameCPP::Version_9::FrTOC::positionEvent ( const std::string & Event,
INT_4U Index ) const
protectedvirtual

◆ positionEvent() [2/4]

virtual cmn_position_type FrameCPP::Version_9::FrTOC::positionEvent ( const std::string & Event,
INT_4U Index ) const
protectedvirtual

◆ positionEvent() [3/4]

virtual cmn_position_type FrameCPP::Version_9::FrTOC::positionEvent ( INT_4U FrameIndex,
const std::string & Event ) const
protectedvirtual

◆ positionEvent() [4/4]

virtual cmn_position_type FrameCPP::Version_9::FrTOC::positionEvent ( INT_4U FrameIndex,
const std::string & Event ) const
protectedvirtual

◆ positionH() [1/2]

virtual cmn_position_type FrameCPP::Version_9::FrTOC::positionH ( INT_4U FrameIndex) const
protectedvirtual

◆ positionH() [2/2]

virtual cmn_position_type FrameCPP::Version_9::FrTOC::positionH ( INT_4U FrameIndex) const
protectedvirtual

◆ positionProc() [1/4]

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

◆ positionProc() [2/4]

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

◆ positionProc() [3/4]

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

◆ positionProc() [4/4]

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

◆ positionSer() [1/2]

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

◆ positionSer() [2/2]

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

◆ positionSim() [1/2]

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

◆ positionSim() [2/2]

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

◆ positionSimEvent() [1/4]

virtual cmn_position_type FrameCPP::Version_9::FrTOC::positionSimEvent ( const std::string & EventType,
INT_4U Index ) const
protectedvirtual

◆ positionSimEvent() [2/4]

virtual cmn_position_type FrameCPP::Version_9::FrTOC::positionSimEvent ( const std::string & EventType,
INT_4U Index ) const
protectedvirtual

◆ positionSimEvent() [3/4]

virtual cmn_position_type FrameCPP::Version_9::FrTOC::positionSimEvent ( INT_4U FrameIndex,
const std::string & SimEvent ) const
protectedvirtual

◆ positionSimEvent() [4/4]

virtual cmn_position_type FrameCPP::Version_9::FrTOC::positionSimEvent ( INT_4U FrameIndex,
const std::string & SimEvent ) const
protectedvirtual

◆ procDataCachePositions() [1/2]

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

Cache where the positions of the FrProcData channels.

Parameters
[in,out]StreamThe Stream being read

◆ procDataCachePositions() [2/2]

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

Cache where the positions of the FrProcData channels.

Parameters
[in,out]StreamThe Stream being read

◆ promote() [1/2]

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

Promotes object to another version of the frame spec.

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

◆ promote() [2/2]

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

Promotes object to another version of the frame spec.

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

◆ pWrite() [1/2]

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

Write the structure to the stream.

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

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

◆ pWrite() [2/2]

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

Write the structure to the stream.

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

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

◆ QueryAdc() [1/2]

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

Gather TOC info for FrAdcData being written.

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

◆ QueryAdc() [2/2]

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

Gather TOC info for FrAdcData being written.

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

◆ QueryEvent() [1/2]

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

Gather TOC info for FrEvent being written.

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

◆ QueryEvent() [2/2]

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

Gather TOC info for FrEvent being written.

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

◆ QueryProc() [1/2]

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

Gather TOC info for FrProcData being written.

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

◆ QueryProc() [2/2]

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

Gather TOC info for FrProcData being written.

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

◆ QuerySer() [1/2]

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

Gather TOC info for FrSerData being written.

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

◆ QuerySer() [2/2]

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

Gather TOC info for FrSerData being written.

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

◆ QuerySim() [1/2]

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

Gather TOC info for FrSimData being written.

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

◆ QuerySim() [2/2]

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

Gather TOC info for FrSimData being written.

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

◆ QuerySimEvent() [1/2]

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

Gather TOC info for FrSimEvent being written.

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

◆ QuerySimEvent() [2/2]

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

Gather TOC info for FrSimEvent being written.

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

◆ QuerySum() [1/2]

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

Gather TOC info for FrSummary being written.

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

◆ QuerySum() [2/2]

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

Gather TOC info for FrSummary being written.

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

◆ reverse_lookup() [1/2]

reverse_lookup_type::mapped_type FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::reverse_lookup ( const reverse_lookup_type::key_type & Key) const
inlineprivateinherited

◆ reverse_lookup() [2/2]

reverse_lookup_type::mapped_type FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::reverse_lookup ( const reverse_lookup_type::key_type & Key) const
inlineprivateinherited

◆ runs() [1/2]

virtual cmn_runs_container_type const & FrameCPP::Version_9::FrTOC::runs ( ) const
protectedvirtual

◆ runs() [2/2]

virtual cmn_runs_container_type const & FrameCPP::Version_9::FrTOC::runs ( ) const
protectedvirtual

◆ seekAdcDataPositions() [1/4]

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

Advance to the specified Adc channel.

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

◆ seekAdcDataPositions() [2/4]

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

Advance to the specified Adc channel.

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

◆ seekAdcDataPositions() [3/4]

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

Advance to the specified Adc channel.

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

◆ seekAdcDataPositions() [4/4]

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

Advance to the specified Adc channel.

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

◆ seekPositions() [1/4]

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

Advance to the specified Adc channel.

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

◆ seekPositions() [2/4]

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

Advance to the specified Adc channel.

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

◆ seekPositions() [3/4]

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

Advance to the specified Adc channel.

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

◆ seekPositions() [4/4]

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

Advance to the specified Adc channel.

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

◆ SetFileBaseName()

void FrameCPP::v9::FrTOCHeader::SetFileBaseName ( const file_base_name_type & Source) const
inlineinherited

Set file base name.

◆ setPositionsOffset() [1/2]

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

◆ setPositionsOffset() [2/2]

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

◆ SHid() [1/2]

virtual INT_2U FrameCPP::Version_9::FrTOC::SHid ( INT_4U Offset) const
protectedvirtual

◆ SHid() [2/2]

virtual INT_2U FrameCPP::Version_9::FrTOC::SHid ( INT_4U Offset) const
protectedvirtual

◆ SHname() [1/2]

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

◆ SHname() [2/2]

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

◆ StructDescription() [1/2]

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

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_9::FrTOCImpl::ClassicIO< FrTOC >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ StructName() [1/2]

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

The name structure name of this object.

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

◆ StructName() [2/2]

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

The name structure name of this object.

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

◆ Write() [1/2]

template<typename ObjectType, typename ChecksumType>
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

◆ Write() [2/2]

template<typename ObjectType, typename ChecksumType>
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

◆ write() [1/9]

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

Write the structure to the stream.

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

◆ write() [2/9]

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

Write the structure to the stream.

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

◆ write() [3/9]

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

Write the structure to the stream.

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

◆ write() [4/9]

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

Write the structure to the stream.

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

◆ write() [5/9]

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

Write the structure to the stream.

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

◆ write() [6/9]

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

Write the structure to the stream.

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

◆ write() [7/9]

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

Write the structure to the stream.

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

◆ write() [8/9]

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

Write the structure to the stream.

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

◆ write() [9/9]

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

Write the structure to the stream.

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

Member Data Documentation

◆ event_type_size [1/2]

static const int FrameCPP::v8::FrTOCEvent::event_type_size
staticinherited
Initial value:
= sizeof( gtimesEvent_type ) +
sizeof( gtimenEvent_type ) + sizeof( amplitudeEvent_type ) +
INT_4U gtimenEvent_type
Definition FrTOCEvent.hh:45
INT_8U positionEvent_type
Definition FrTOCEvent.hh:47
INT_4U gtimesEvent_type
Definition FrTOCEvent.hh:44
REAL_4 amplitudeEvent_type
Definition FrTOCEvent.hh:46

◆ event_type_size [2/2]

static const int FrameCPP::v8::FrTOCSimEvent::event_type_size
staticinherited
Initial value:
= sizeof( gtimesSim_type ) +
sizeof( gtimenSim_type ) + sizeof( amplitudeSimEvent_type ) +
INT_4U gtimesSim_type
Definition FrTOCSimEvent.hh:45
INT_4U gtimenSim_type
Definition FrTOCSimEvent.hh:46
REAL_4 amplitudeSimEvent_type
Definition FrTOCSimEvent.hh:47
INT_8U positionSimEvent_type
Definition FrTOCSimEvent.hh:48

◆ fileBaseName

file_base_name_type FrameCPP::v9::FrTOCHeader::fileBaseName
mutableprotectedinherited

The name of the file at the time of creation.

◆ frame_count

frame_count_type FrameCPP::Version_9::FrTOCImpl::FrTOCProcDataClassicIO::frame_count { 0 }
privateinherited

◆ m_chkSum

template<typename ObjectType, typename ChecksumType>
ChecksumType FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::m_chkSum
privateinherited

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

◆ m_dataQuality

data_quality_container_type FrameCPP::v9::FrTOCHeader::m_dataQuality
protectedinherited

Array of integer QA words from each FrameH (size of nFrame)

◆ m_dt

dt_container_type FrameCPP::v9::FrTOCHeader::m_dt
protectedinherited

Array of frame durations in seconds (size of nFrame).

◆ m_GTimeN

gtimen_container_type FrameCPP::v9::FrTOCHeader::m_GTimeN
protectedinherited

Array of integer GPS residual nanoseconds for the frame (size of nFrame).

◆ m_GTimeS

gtimes_container_type FrameCPP::v9::FrTOCHeader::m_GTimeS
protectedinherited

Array of integer GPS frame times (size of nFrame).

◆ m_info [1/7]

nameEvent_container_type FrameCPP::v8::FrTOCEvent::m_info
protectedinherited

◆ m_info [2/7]

MapProc_type FrameCPP::v8::FrTOCProcData::m_info
protectedinherited

◆ m_info [3/7]

MapSer_type FrTOCSerData::m_info
protectedinherited

◆ m_info [4/7]

MapSim_type FrameCPP::v8::FrTOCSimData::m_info
protectedinherited

◆ m_info [5/7]

nameSimEvent_container_type FrameCPP::v8::FrTOCSimEvent::m_info
protectedinherited

◆ m_info [6/7]

MapSummary_type FrTOCSummary::m_info
protectedinherited

◆ m_info [7/7]

MapADC_type FrameCPP::v9::FrTOCAdcData::m_info
protectedinherited

◆ m_io_keys [1/2]

io_key_container_type FrameCPP::Version_9::FrTOCImpl::FrTOCSerDataClassicIO::m_io_keys
protectedinherited

◆ m_io_keys [2/2]

io_key_container_type FrameCPP::Version_9::FrTOCImpl::FrTOCSummaryClassicIO::m_io_keys
protectedinherited

◆ m_keys [1/5]

key_container_type FrameCPP::v8::FrTOCProcData::m_keys
protectedinherited

◆ m_keys [2/5]

key_container_type FrTOCSerData::m_keys
protectedinherited

◆ m_keys [3/5]

key_container_type FrameCPP::v8::FrTOCSimData::m_keys
protectedinherited

◆ m_keys [4/5]

key_container_type FrTOCSummary::m_keys
protectedinherited

◆ m_keys [5/5]

key_container_type FrameCPP::v9::FrTOCAdcData::m_keys
protectedinherited

◆ m_nameDetector

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

Array of FrDetector names.

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

◆ m_positionDetector

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

Array of FrDetector positions.

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

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

◆ m_positionH

positionh_container_type FrameCPP::v9::FrTOCHeader::m_positionH
protectedinherited

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

◆ m_positions_start

position_type FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::m_positions_start
inherited

◆ m_SHid

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

Array of FrSH IDs.

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

◆ m_SHname

shname_container_type FrameCPP::v9::FrTOCHeader::m_SHname
protectedinherited

Array of FrSH names. The size of array is specified by nSH.

◆ m_StatType

MapStatType_type FrameCPP::Version_9::FrTOC::m_StatType
private

◆ name_keys

Common::FrTOC::cmn_name_container_type FrameCPP::Version_9::FrTOCImpl::FrTOCSerDataClassicIO::name_keys
privateinherited

◆ NO_DATA_AVAILABLE

static const INT_4U FrameCPP::Version_9::FrTOC::NO_DATA_AVAILABLE
static

◆ positions_cache

positions_cache_type FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::positions_cache
privateinherited

A cache of the positions of the FrAdcData structures within the stream.

◆ positions_cache_offset

position_type FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::positions_cache_offset
privateinherited

The number of bytes from the end of the stream where the array containing the FrAdcData offsets.

◆ reverse_lookup_

reverse_lookup_type FrameCPP::Version_9::FrTOCImpl::FrTOCAdcDataClassicIO::reverse_lookup_
mutableprivateinherited

Provide means where a channel index can be mapped to a channel name

◆ struct_desc

template<typename Object_T>
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc
staticinherited

◆ struct_id

template<typename Object_T>
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id
staticinherited

◆ struct_name

template<typename Object_T>
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name
staticinherited

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