ldas-tools-framecpp  2.7.0
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
FrameCPP::Version_6::FrTOC Class Referenceabstract

#include <FrTOC.hh>

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

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
 
enum  query_info_type {
  TOC_CHANNEL_NAMES, TOC_DETECTOR, TOC_FR_STRUCTS, TOC_CHANNEL_NAMES,
  TOC_DETECTOR, TOC_FR_STRUCTS
}
 
enum  query_info_type {
  TOC_CHANNEL_NAMES, TOC_DETECTOR, TOC_FR_STRUCTS, TOC_CHANNEL_NAMES,
  TOC_DETECTOR, TOC_FR_STRUCTS
}
 
typedef INT_8U cmn_position_type
 
typedef INT_8U cmn_position_type
 
typedef INT_4U channel_id_type
 
typedef INT_4U channel_id_type
 
typedef boost::shared_ptr< FrameSpec::Objectobject_type
 
typedef boost::shared_ptr< FrameSpec::Objectobject_type
 
typedef std::vector< STRING< INT_2U > > cmn_name_container_type
 
typedef std::vector< STRING< INT_2U > > cmn_name_container_type
 
typedef std::vector< REAL_8 > cmn_dt_container_type
 
typedef std::vector< REAL_8 > cmn_dt_container_type
 
typedef std::vector< INT_4U > cmn_GTimeS_container_type
 
typedef std::vector< INT_4U > cmn_GTimeS_container_type
 
typedef std::vector< INT_4U > cmn_GTimeN_container_type
 
typedef std::vector< INT_4U > cmn_GTimeN_container_type
 
typedef std::vector< INT_4S > cmn_runs_container_type
 
typedef std::vector< INT_4S > cmn_runs_container_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef object_type promote_ret_type
 
typedef INT_4U data_quality_type
 
typedef INT_4U data_quality_type
 
typedef REAL_8 dt_type
 
typedef REAL_8 dt_type
 
typedef INT_4U frame_type
 
typedef INT_4U frame_type
 
typedef INT_4U gtimen_type
 
typedef INT_4U gtimen_type
 
typedef INT_4U gtimes_type
 
typedef INT_4U gtimes_type
 
typedef STRING namedetector_type
 
typedef STRING namedetector_type
 
typedef INT_4U ndetector_type
 
typedef INT_4U ndetector_type
 
typedef INT_8U nfirstadc_type
 
typedef INT_8U nfirstadc_type
 
typedef INT_8U nfirstmsg_type
 
typedef INT_8U nfirstmsg_type
 
typedef INT_8U nfirstser_type
 
typedef INT_8U nfirstser_type
 
typedef INT_8U nfirsttable_type
 
typedef INT_8U nfirsttable_type
 
typedef INT_4U nframe_type
 
typedef INT_4U nframe_type
 
typedef INT_4U nsh_type
 
typedef INT_4U nsh_type
 
typedef INT_8U positiondetector_type
 
typedef INT_8U positiondetector_type
 
typedef INT_8U positionh_type
 
typedef INT_8U positionh_type
 
typedef INT_4S runs_type
 
typedef INT_4S runs_type
 
typedef INT_2U shid_type
 
typedef INT_2U shid_type
 
typedef STRING shname_type
 
typedef STRING shname_type
 
typedef INT_2S uleaps_type
 
typedef INT_2S uleaps_type
 
typedef std::vector< data_quality_typedata_quality_container_type
 
typedef std::vector< data_quality_typedata_quality_container_type
 
typedef std::vector< dt_typedt_container_type
 
typedef std::vector< dt_typedt_container_type
 
typedef std::vector< frame_typeframe_container_type
 
typedef std::vector< frame_typeframe_container_type
 
typedef std::vector< gtimen_typegtimen_container_type
 
typedef std::vector< gtimen_typegtimen_container_type
 
typedef std::vector< gtimes_typegtimes_container_type
 
typedef std::vector< gtimes_typegtimes_container_type
 
typedef std::vector< namedetector_typenamedetector_container_type
 
typedef std::vector< namedetector_typenamedetector_container_type
 
typedef std::vector< nfirstadc_typenfirstadc_container_type
 
typedef std::vector< nfirstadc_typenfirstadc_container_type
 
typedef std::vector< nfirstmsg_typenfirstmsg_container_type
 
typedef std::vector< nfirstmsg_typenfirstmsg_container_type
 
typedef std::vector< nfirstser_typenfirstser_container_type
 
typedef std::vector< nfirstser_typenfirstser_container_type
 
typedef std::vector< nfirsttable_typenfirsttable_container_type
 
typedef std::vector< nfirsttable_typenfirsttable_container_type
 
typedef std::vector< positiondetector_typepositiondetector_container_type
 
typedef std::vector< positiondetector_typepositiondetector_container_type
 
typedef std::vector< positionh_typepositionh_container_type
 
typedef std::vector< positionh_typepositionh_container_type
 
typedef std::vector< runs_typeruns_container_type
 
typedef std::vector< runs_typeruns_container_type
 
typedef std::vector< shid_typeshid_container_type
 
typedef std::vector< shid_typeshid_container_type
 
typedef std::vector< shname_typeshname_container_type
 
typedef std::vector< shname_typeshname_container_type
 
typedef STRING name_type
 
typedef STRING name_type
 
typedef INT_4U nstat_type
 
typedef INT_4U nstat_type
 
typedef STRING detector_type
 
typedef STRING detector_type
 
typedef INT_4U nstat_instance_type
 
typedef INT_4U nstat_instance_type
 
typedef INT_4U tstart_type
 
typedef INT_4U tstart_type
 
typedef INT_4U tend_type
 
typedef INT_4U tend_type
 
typedef INT_4U version_type
 
typedef INT_4U version_type
 
typedef INT_8U positionStat_type
 
typedef INT_8U positionStat_type
 
typedef std::vector< stat_instance_typestat_instance_container_type
 
typedef std::vector< stat_instance_typestat_instance_container_type
 
typedef std::map< name_type, stat_typestat_container_type
 
typedef std::map< name_type, stat_typestat_container_type
 
typedef INT_4U nadc_type
 
typedef INT_4U nadc_type
 
typedef STRING name_type
 
typedef INT_4U channel_id_type
 
typedef INT_4U group_id_type
 
typedef INT_4U group_id_type
 
typedef std::vector< name_typekey_container_type
 
typedef std::vector< name_typekey_container_type
 
typedef std::map< name_type, adc_info_typeMapADC_type
 
typedef std::map< name_type, adc_info_typeMapADC_type
 
typedef Common::FrTOC::PositionWithCache< STRING, FrTOCTypes::position_typebase_type
 
typedef Common::FrTOC::PositionWithCache< STRING, FrTOCTypes::position_typebase_type
 
typedef FrTOCTypes::n_type nproc_type
 
typedef FrTOCTypes::n_type nproc_type
 
typedef FrTOCTypes::position_container_type proc_info_type
 
typedef FrTOCTypes::position_container_type proc_info_type
 
typedef FrTOCTypes::ordered_position_container_type MapProc_type
 
typedef FrTOCTypes::ordered_position_container_type MapProc_type
 
typedef INT_4U nsim_type
 
typedef INT_4U nsim_type
 
typedef STRING name_type
 
typedef std::vector< position_typesim_info_type
 
typedef std::vector< position_typesim_info_type
 
typedef std::map< name_type, sim_info_typeMapSim_type
 
typedef std::map< name_type, sim_info_typeMapSim_type
 
typedef INT_4U nevent_type
 
typedef INT_4U nevent_type
 
typedef STRING name_type
 
typedef INT_4U gtimesEvent_type
 
typedef INT_4U gtimesEvent_type
 
typedef INT_4U gtimenEvent_type
 
typedef INT_4U gtimenEvent_type
 
typedef REAL_4 amplitudeEvent_type
 
typedef REAL_4 amplitudeEvent_type
 
typedef INT_8U positionEvent_type
 
typedef INT_8U positionEvent_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 std::map< name_type, events_container_typenameEvent_container_type
 
typedef INT_4U nevent_type
 
typedef STRING name_type
 
typedef INT_4U gtimesSim_type
 
typedef INT_4U gtimesSim_type
 
typedef INT_4U gtimenSim_type
 
typedef INT_4U gtimenSim_type
 
typedef REAL_4 amplitudeSimEvent_type
 
typedef REAL_4 amplitudeSimEvent_type
 
typedef INT_8U positionSimEvent_type
 
typedef INT_8U positionSimEvent_type
 
typedef std::vector< event_typeevents_container_type
 
typedef std::map< name_type, events_container_typenameSimEvent_container_type
 
typedef std::map< name_type, events_container_typenameSimEvent_container_type
 

Public Member Functions

 FrTOC ()
 
 FrTOC (const FrameCPP::Common::FrTOC *Source)
 Constructor. More...
 
virtual void ForEach (query_info_type Info, FunctionBase &Action) const
 Iterate over elements of the Table of Contents. More...
 
virtual void IndexObject (object_type Object, std::streampos Position)
 
virtual Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual FrTOCCreate () const
 constructor - virtual More...
 
virtual FrTOCCreate (istream_type &Stream) const
 constructor - virtual More...
 
virtual void FrStatDataQuery (const std::string &NamePattern, const LDASTools::AL::GPSTime &StartTime, const LDASTools::AL::GPSTime &EndTime, const INT_4U Version, Common::FrStatData::Query &Result) const
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
const MapStatType_typeGetStatType () const
 
 FrTOC ()
 
 FrTOC (const FrameCPP::Common::FrTOC *Source)
 Constructor. More...
 
virtual void ForEach (query_info_type Info, FunctionBase &Action) const
 Iterate over elements of the Table of Contents. More...
 
virtual void IndexObject (object_type Object, std::streampos Position)
 
virtual Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual FrTOCCreate () const
 constructor - virtual More...
 
virtual FrTOCCreate (istream_type &Stream) const
 constructor - virtual More...
 
virtual void FrStatDataQuery (const std::string &NamePattern, const LDASTools::AL::GPSTime &StartTime, const LDASTools::AL::GPSTime &EndTime, const INT_4U Version, Common::FrStatData::Query &Result) const
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
const MapStatType_typeGetStatType () const
 
virtual void FrStatDataQuery (const std::string &NamePattern, const LDASTools::AL::GPSTime &StartTime, const LDASTools::AL::GPSTime &EndTime, const INT_4U Version, FrStatData::Query &Result) const =0
 
virtual void seekAdcDataPositions (istream_type &Stream, channel_id_type Channel)=0
 Advance to the specified Adc channel. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
virtual ObjectClone () const
 constructor - virtual copy constructor More...
 
virtual ObjectClone () const
 constructor - virtual copy constructor More...
 
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *Stream)
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 
const data_quality_container_typeGetDataQuality () const
 
const data_quality_container_typeGetDataQuality () const
 
const dt_container_typeGetDt () const
 
const dt_container_typeGetDt () const
 
const frame_container_typeGetFrame () const
 
const frame_container_typeGetFrame () const
 
const gtimes_container_typeGetGTimeN () const
 
const gtimes_container_typeGetGTimeN () const
 
const gtimen_container_typeGetGTimeS () const
 
const gtimen_container_typeGetGTimeS () const
 
const nfirstadc_container_typeGetNFirstADC () const
 
const nfirstadc_container_typeGetNFirstADC () const
 
const nfirstmsg_container_typeGetNFirstMsg () const
 
const nfirstmsg_container_typeGetNFirstMsg () const
 
const nfirstser_container_typeGetNFirstSer () const
 
const nfirstser_container_typeGetNFirstSer () const
 
const nfirsttable_container_typeGetNFirstTable () const
 
const nfirsttable_container_typeGetNFirstTable () const
 
nframe_type GetNFrame () const
 
nframe_type GetNFrame () const
 
const positionh_container_typeGetPositionH () const
 
const positionh_container_typeGetPositionH () const
 
const runs_container_typeGetRuns () const
 
const runs_container_typeGetRuns () const
 
const shid_container_typeGetSHid () const
 
const shid_container_typeGetSHid () const
 
const shname_container_typeGetSHname () const
 
const shname_container_typeGetSHname () const
 
uleaps_type GetULeapS () const
 
uleaps_type GetULeapS () const
 
const namedetector_container_typeGetNameDetector () const
 
const namedetector_container_typeGetNameDetector () const
 
const positiondetector_container_typeGetPositionDetector () const
 
const positiondetector_container_typeGetPositionDetector () const
 
bool operator== (const FrTOCData &RHS) const
 
const stat_container_typeGetStat () const
 
const stat_container_typeGetStat () const
 
bool operator== (const FrTOCStatData &RHS) const
 
void QueryStatData (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
void QueryStatData (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
const MapADC_typeGetADC () const
 
MapADC_type::const_iterator GetADC (const std::string &Name) const
 
MapADC_type::const_iterator GetADC (INT_4U index) const
 
const MapADC_typeGetADC () const
 
MapADC_type::const_iterator GetADC (const std::string &Name) const
 
MapADC_type::const_iterator GetADC (INT_4U index) const
 
const key_container_typeGetKeys () const
 Retrieve the keys. More...
 
const key_container_typeGetKeys () const
 Retrieve the keys. More...
 
void QueryAdc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
void QueryAdc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
bool operator== (const FrTOCAdcData &RHS) const
 
const key_container_typeGetKeys () const
 
const MapProc_typeGetProc () const
 
MapProc_type::const_iterator GetProc (const std::string &Name) const
 
MapProc_type::const_iterator GetProc (INT_4U index) const
 
const MapProc_typeGetProc () const
 
MapProc_type::const_iterator GetProc (const std::string &Name) const
 
MapProc_type::const_iterator GetProc (INT_4U index) const
 
void QueryProc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
void QueryProc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
bool operator== (const FrTOCProcData &RHS) const
 
const MapSim_typeGetSim () const
 
MapSim_type::const_iterator GetSim (const std::string &Name) const
 
MapSim_type::const_iterator GetSim (INT_4U index) const
 
const MapSim_typeGetSim () const
 
MapSim_type::const_iterator GetSim (const std::string &Name) const
 
MapSim_type::const_iterator GetSim (INT_4U index) const
 
void QuerySim (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
void QuerySim (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
bool operator== (const FrTOCSimData &RHS) const
 
const nameEvent_container_typeGetEvent () const
 
const nameEvent_container_typeGetEvent () const
 
void QueryEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
void QueryEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
bool operator== (const FrTOCEvent &RHS) const
 
const nameSimEvent_container_typeGetSimEvent () const
 
const nameSimEvent_container_typeGetSimEvent () const
 
void QuerySimEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
void QuerySimEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
bool operator== (const FrTOCSimEvent &RHS) const
 

Static Public Member Functions

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

Static Public Attributes

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

Protected Types

typedef std::vector< name_typekey_container_type
 

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object. More...
 
virtual INT_4U nFrame () const
 
virtual const cmn_dt_container_typedt () const
 
virtual const cmn_GTimeS_container_typeGTimeS () const
 
virtual const cmn_GTimeN_container_typeGTimeN () const
 
virtual cmn_runs_container_type const & runs () const
 
virtual cmn_position_type positionDetector (const std::string &Name) const
 Retrieve the stream position for the detector. More...
 
virtual cmn_position_type positionH (INT_4U FrameIndex) const
 
virtual const cmn_name_container_typenameADC () const
 
virtual cmn_position_type positionADC (INT_4U FrameIndex, const std::string &Channel) const
 
virtual cmn_position_type positionADC (INT_4U FrameIndex, INT_4U Channel) const
 
virtual cmn_position_type positionEvent (INT_4U FrameIndex, const std::string &Event) const
 
virtual cmn_position_type positionEvent (const std::string &EventType, INT_4U Index) const
 
virtual const cmn_name_container_typenameProc () const
 
virtual cmn_position_type positionProc (INT_4U FrameIndex, const std::string &Channel) const
 
virtual cmn_position_type positionProc (INT_4U FrameIndex, INT_4U Channel) const
 
virtual const cmn_name_container_typenameSer () const
 
virtual cmn_position_type positionSer (INT_4U FrameIndex, const std::string &Channel) const
 
virtual const cmn_name_container_typenameSim () const
 
virtual cmn_position_type positionSim (INT_4U FrameIndex, const std::string &Channel) const
 
virtual cmn_position_type positionSimEvent (INT_4U FrameIndex, const std::string &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. More...
 
virtual void seekAdcDataPositions (istream_type &Stream, Common::FrTOC::channel_id_type Channel)
 Advance to the specified Adc channel. More...
 
virtual void seekAdcDataPositions (istream_type &Stream, const std::string &Channel)
 Advance to the specified Adc channel. More...
 
virtual void procDataCachePositions (istream_type &Stream)
 Cache where the positions of the FrProcData channels. More...
 
virtual 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, istream_type *Stream) const
 Down grade an object. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object. More...
 
virtual INT_4U nFrame () const
 
virtual const cmn_dt_container_typedt () const
 
virtual const cmn_GTimeS_container_typeGTimeS () const
 
virtual const cmn_GTimeN_container_typeGTimeN () const
 
virtual cmn_runs_container_type const & runs () const
 
virtual cmn_position_type positionDetector (const std::string &Name) const
 Retrieve the stream position for the detector. More...
 
virtual cmn_position_type positionH (INT_4U FrameIndex) const
 
virtual const cmn_name_container_typenameADC () const
 
virtual cmn_position_type positionADC (INT_4U FrameIndex, const std::string &Channel) const
 
virtual cmn_position_type positionADC (INT_4U FrameIndex, INT_4U Channel) const
 
virtual cmn_position_type positionEvent (INT_4U FrameIndex, const std::string &Event) const
 
virtual cmn_position_type positionEvent (const std::string &EventType, INT_4U Index) const
 
virtual const cmn_name_container_typenameProc () const
 
virtual cmn_position_type positionProc (INT_4U FrameIndex, const std::string &Channel) const
 
virtual cmn_position_type positionProc (INT_4U FrameIndex, INT_4U Channel) const
 
virtual const cmn_name_container_typenameSer () const
 
virtual cmn_position_type positionSer (INT_4U FrameIndex, const std::string &Channel) const
 
virtual const cmn_name_container_typenameSim () const
 
virtual cmn_position_type positionSim (INT_4U FrameIndex, const std::string &Channel) const
 
virtual cmn_position_type positionSimEvent (INT_4U FrameIndex, const std::string &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. More...
 
virtual void seekAdcDataPositions (istream_type &Stream, Common::FrTOC::channel_id_type Channel)
 Advance to the specified Adc channel. More...
 
virtual void seekAdcDataPositions (istream_type &Stream, const std::string &Channel)
 Advance to the specified Adc channel. More...
 
virtual void procDataCachePositions (istream_type &Stream)
 Cache where the positions of the FrProcData channels. More...
 
virtual 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)
 
void setAdcDataPoisitions ()
 
void setAdcDataPoisitions ()
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void load (Common::IStream &Stream)
 
void load (Common::IStream &Stream)
 
void write (Common::OStream &Stream) const
 
void write (Common::OStream &Stream) const
 
void write (Common::OStream &Stream) const
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void cachePositions (istream_type &Stream)
 
void cachePositions (istream_type &Stream)
 
void seekPositions (istream_type &Stream, channel_id_type Channel)
 
void seekPositions (istream_type &Stream, const std::string &Channel)
 
void seekPositions (istream_type &Stream, channel_id_type Channel)
 
void seekPositions (istream_type &Stream, const std::string &Channel)
 
void write (Common::OStream &Stream) const
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void write (Common::OStream &Stream) const
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void write (Common::OStream &Stream) const
 
void write (Common::OStream &Stream) const
 
void write (Common::OStream &Stream) const
 

Protected Attributes

uleaps_type m_ULeapS
 
data_quality_container_type m_dataQuality
 
gtimes_container_type m_GTimeS
 
gtimen_container_type m_GTimeN
 
dt_container_type m_dt
 
runs_container_type m_runs
 
frame_container_type m_frame
 
positiondetector_container_type m_positionDetector
 
positionh_container_type m_positionH
 
namedetector_container_type m_nameDetector
 
nfirstadc_container_type m_nFirstADC
 
nfirstser_container_type m_nFirstSer
 
nfirsttable_container_type m_nFirstTable
 
nfirstmsg_container_type m_nFirstMsg
 
shid_container_type m_SHid
 
shname_container_type m_SHname
 
stat_container_type m_info
 
position_type m_positions_start
 
key_container_type m_keys
 
MapADC_type m_info
 
key_container_type m_keys
 
MapSim_type m_info
 
nameEvent_container_type m_info
 
nameSimEvent_container_type m_info
 

Private Member Functions

 FrTOC (istream_type &Stream)
 
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
 
 FrTOC (istream_type &Stream)
 
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
 

Private Attributes

MapStatType_type m_StatType
 

Member Typedef Documentation

◆ amplitudeEvent_type [1/2]

◆ amplitudeEvent_type [2/2]

◆ amplitudeSimEvent_type [1/2]

◆ amplitudeSimEvent_type [2/2]

◆ base_type [1/2]

◆ base_type [2/2]

◆ channel_id_type [1/3]

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

◆ channel_id_type [2/3]

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

◆ channel_id_type [3/3]

◆ cmn_dt_container_type [1/2]

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

◆ cmn_dt_container_type [2/2]

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

◆ cmn_GTimeN_container_type [1/2]

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

◆ cmn_GTimeN_container_type [2/2]

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

◆ cmn_GTimeS_container_type [1/2]

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

◆ cmn_GTimeS_container_type [2/2]

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

◆ cmn_name_container_type [1/2]

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

◆ cmn_name_container_type [2/2]

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

◆ cmn_position_type [1/2]

typedef INT_8U FrameCPP::Common::FrTOC::cmn_position_type
inherited

◆ cmn_position_type [2/2]

typedef INT_8U FrameCPP::Common::FrTOC::cmn_position_type
inherited

◆ cmn_runs_container_type [1/2]

typedef std::vector< INT_4S > FrameCPP::Common::FrTOC::cmn_runs_container_type
inherited

◆ cmn_runs_container_type [2/2]

typedef std::vector< INT_4S > FrameCPP::Common::FrTOC::cmn_runs_container_type
inherited

◆ data_quality_container_type [1/2]

◆ data_quality_container_type [2/2]

◆ data_quality_type [1/2]

◆ data_quality_type [2/2]

◆ demote_arg_type [1/2]

◆ demote_arg_type [2/2]

◆ demote_ret_type [1/2]

◆ demote_ret_type [2/2]

◆ detector_type [1/2]

◆ detector_type [2/2]

◆ dt_container_type [1/2]

◆ dt_container_type [2/2]

◆ dt_type [1/2]

typedef REAL_8 FrameCPP::Version_6::FrTOCData::dt_type
inherited

◆ dt_type [2/2]

typedef REAL_8 FrameCPP::Version_6::FrTOCData::dt_type
inherited

◆ events_container_type [1/3]

◆ events_container_type [2/3]

◆ events_container_type [3/3]

◆ frame_container_type [1/2]

◆ frame_container_type [2/2]

◆ frame_spec_version_type [1/2]

◆ frame_spec_version_type [2/2]

◆ frame_type [1/2]

◆ frame_type [2/2]

◆ group_id_type [1/2]

◆ group_id_type [2/2]

◆ gtimen_container_type [1/2]

◆ gtimen_container_type [2/2]

◆ gtimen_type [1/2]

◆ gtimen_type [2/2]

◆ gtimenEvent_type [1/2]

◆ gtimenEvent_type [2/2]

◆ gtimenSim_type [1/2]

◆ gtimenSim_type [2/2]

◆ gtimes_container_type [1/2]

◆ gtimes_container_type [2/2]

◆ gtimes_type [1/2]

◆ gtimes_type [2/2]

◆ gtimesEvent_type [1/2]

◆ gtimesEvent_type [2/2]

◆ gtimesSim_type [1/2]

◆ gtimesSim_type [2/2]

◆ key_container_type [1/3]

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

◆ key_container_type [2/3]

◆ key_container_type [3/3]

◆ MapADC_type [1/2]

◆ MapADC_type [2/2]

◆ MapProc_type [1/2]

◆ MapProc_type [2/2]

◆ MapSim_type [1/2]

◆ MapSim_type [2/2]

◆ MapStatType_type [1/2]

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

◆ MapStatType_type [2/2]

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

◆ nadc_type [1/2]

◆ nadc_type [2/2]

◆ name_type [1/6]

◆ name_type [2/6]

◆ name_type [3/6]

◆ name_type [4/6]

◆ name_type [5/6]

◆ name_type [6/6]

◆ namedetector_container_type [1/2]

◆ namedetector_container_type [2/2]

◆ namedetector_type [1/2]

◆ namedetector_type [2/2]

◆ nameEvent_container_type [1/2]

◆ nameEvent_container_type [2/2]

◆ nameSimEvent_container_type [1/2]

◆ nameSimEvent_container_type [2/2]

◆ ndetector_type [1/2]

◆ ndetector_type [2/2]

◆ nevent_type [1/3]

◆ nevent_type [2/3]

◆ nevent_type [3/3]

◆ nfirstadc_container_type [1/2]

◆ nfirstadc_container_type [2/2]

◆ nfirstadc_type [1/2]

◆ nfirstadc_type [2/2]

◆ nfirstmsg_container_type [1/2]

◆ nfirstmsg_container_type [2/2]

◆ nfirstmsg_type [1/2]

◆ nfirstmsg_type [2/2]

◆ nfirstser_container_type [1/2]

◆ nfirstser_container_type [2/2]

◆ nfirstser_type [1/2]

◆ nfirstser_type [2/2]

◆ nfirsttable_container_type [1/2]

◆ nfirsttable_container_type [2/2]

◆ nfirsttable_type [1/2]

◆ nfirsttable_type [2/2]

◆ nframe_type [1/2]

◆ nframe_type [2/2]

◆ nproc_type [1/2]

◆ nproc_type [2/2]

◆ nsh_type [1/2]

typedef INT_4U FrameCPP::Version_6::FrTOCData::nsh_type
inherited

◆ nsh_type [2/2]

typedef INT_4U FrameCPP::Version_6::FrTOCData::nsh_type
inherited

◆ nsim_type [1/2]

◆ nsim_type [2/2]

◆ nstat_instance_type [1/2]

◆ nstat_instance_type [2/2]

◆ nstat_type [1/2]

◆ nstat_type [2/2]

◆ object_type [1/2]

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

◆ object_type [2/2]

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

◆ position_list_type [1/2]

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

◆ position_list_type [2/2]

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

◆ position_type [1/2]

typedef INT_8U FrameCPP::Version_6::FrTOC::position_type

◆ position_type [2/2]

typedef INT_8U FrameCPP::Version_6::FrTOC::position_type

◆ positiondetector_container_type [1/2]

◆ positiondetector_container_type [2/2]

◆ positiondetector_type [1/2]

◆ positiondetector_type [2/2]

◆ positionEvent_type [1/2]

◆ positionEvent_type [2/2]

◆ positionh_container_type [1/2]

◆ positionh_container_type [2/2]

◆ positionh_type [1/2]

◆ positionh_type [2/2]

◆ positionSimEvent_type [1/2]

◆ positionSimEvent_type [2/2]

◆ positionStat_type [1/2]

◆ positionStat_type [2/2]

◆ proc_info_type [1/2]

◆ proc_info_type [2/2]

◆ promote_arg_type [1/2]

◆ promote_arg_type [2/2]

◆ promote_ret_type [1/2]

◆ promote_ret_type [2/2]

◆ runs_container_type [1/2]

◆ runs_container_type [2/2]

◆ runs_type [1/2]

◆ runs_type [2/2]

◆ shid_container_type [1/2]

◆ shid_container_type [2/2]

◆ shid_type [1/2]

◆ shid_type [2/2]

◆ shname_container_type [1/2]

◆ shname_container_type [2/2]

◆ shname_type [1/2]

◆ shname_type [2/2]

◆ sim_info_type [1/2]

◆ sim_info_type [2/2]

◆ stat_container_type [1/2]

◆ stat_container_type [2/2]

◆ stat_instance_container_type [1/2]

◆ stat_instance_container_type [2/2]

◆ tend_type [1/2]

◆ tend_type [2/2]

◆ tstart_type [1/2]

◆ tstart_type [2/2]

◆ uleaps_type [1/2]

◆ uleaps_type [2/2]

◆ unique_object_type [1/2]

◆ unique_object_type [2/2]

◆ version_type [1/2]

◆ version_type [2/2]

Member Enumeration Documentation

◆ query_info_type [1/2]

enum FrameCPP::Common::FrTOC::query_info_type
inherited
Enumerator
TOC_CHANNEL_NAMES 
TOC_DETECTOR 
TOC_FR_STRUCTS 
TOC_CHANNEL_NAMES 
TOC_DETECTOR 
TOC_FR_STRUCTS 

◆ query_info_type [2/2]

enum FrameCPP::Common::FrTOC::query_info_type
inherited
Enumerator
TOC_CHANNEL_NAMES 
TOC_DETECTOR 
TOC_FR_STRUCTS 
TOC_CHANNEL_NAMES 
TOC_DETECTOR 
TOC_FR_STRUCTS 

Constructor & Destructor Documentation

◆ FrTOC() [1/6]

FrameCPP::Version_6::FrTOC::FrTOC ( )

◆ FrTOC() [2/6]

FrameCPP::Version_6::FrTOC::FrTOC ( const FrameCPP::Common::FrTOC Source)
explicit

Constructor.

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

◆ FrTOC() [3/6]

FrameCPP::Version_6::FrTOC::FrTOC ( istream_type Stream)
private

◆ FrTOC() [4/6]

FrameCPP::Version_6::FrTOC::FrTOC ( )

◆ FrTOC() [5/6]

FrameCPP::Version_6::FrTOC::FrTOC ( const FrameCPP::Common::FrTOC Source)
explicit

Constructor.

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

◆ FrTOC() [6/6]

FrameCPP::Version_6::FrTOC::FrTOC ( istream_type Stream)
private

Member Function Documentation

◆ Bytes() [1/2]

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

Return the number of bytes for this object.

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

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

◆ Bytes() [2/2]

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

Return the number of bytes for this object.

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

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

◆ cacheAdcDataPositions() [1/2]

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

Cache where the positions of the Adc channels.

Parameters
[in,out]StreamThe Stream being read

Implements FrameCPP::Common::FrTOC.

◆ cacheAdcDataPositions() [2/2]

virtual void FrameCPP::Version_6::FrTOC::cacheAdcDataPositions ( istream_type Stream)
protectedvirtual

Cache where the positions of the Adc channels.

Parameters
[in,out]StreamThe Stream being read

Implements FrameCPP::Common::FrTOC.

◆ cachePositions() [1/2]

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

◆ cachePositions() [2/2]

void FrameCPP::Version_6::FrTOCAdcData::cachePositions ( istream_type Stream)
protectedinherited

◆ Clone() [1/2]

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

constructor - virtual copy constructor

Reimplemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrStatData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrHeader, and FrameCPP::Version_3::FrHeader.

◆ Clone() [2/2]

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

constructor - virtual copy constructor

Reimplemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrStatData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrHeader, and FrameCPP::Version_3::FrHeader.

◆ Create() [1/5]

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

constructor - virtual

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

◆ Create() [2/5]

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

constructor - virtual

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

◆ Create() [3/5]

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

constructor - virtual

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

◆ Create() [4/5]

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

constructor - virtual

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

◆ Create() [5/5]

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

◆ demote() [1/2]

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

Down grade an object.

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

◆ demote() [2/2]

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

Down grade an object.

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

◆ DemoteObject() [1/2]

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

Down grade an object.

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

◆ DemoteObject() [2/2]

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

Down grade an object.

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

◆ Description() [1/8]

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

◆ Description() [2/8]

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

◆ Description() [3/8]

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

◆ Description() [4/8]

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

◆ Description() [5/8]

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

◆ Description() [6/8]

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

◆ Description() [7/8]

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

◆ Description() [8/8]

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

◆ dt() [1/2]

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

◆ dt() [2/2]

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

◆ forEach() [1/5]

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

Iterate over contents.

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

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

◆ forEach() [2/5]

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

Iterate over contents.

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

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

◆ ForEach() [1/2]

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

Iterate over elements of the Table of Contents.

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

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

Todo:
Need to finish the list of channel names

Reimplemented from FrameCPP::Common::FrTOC.

◆ ForEach() [2/2]

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

Reimplemented from FrameCPP::Common::FrTOC.

◆ forEach() [3/5]

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

Iterate over contents.

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

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

◆ forEach() [4/5]

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

Iterate over contents.

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

◆ forEach() [5/5]

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

Iterate over contents.

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

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

◆ FrStatDataQuery() [1/3]

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

◆ FrStatDataQuery() [2/3]

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

◆ FrStatDataQuery() [3/3]

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

◆ GetADC() [1/6]

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

◆ GetADC() [2/6]

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

◆ GetADC() [3/6]

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

◆ GetADC() [4/6]

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

◆ GetADC() [5/6]

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

◆ GetADC() [6/6]

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

◆ GetClass() [1/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ GetClass() [2/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [1/2]

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

Retrieve the class identifier.

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

◆ getClass() [2/2]

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

Retrieve the class identifier.

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

◆ GetDataQuality() [1/2]

const FrTOCData::data_quality_container_type & FrameCPP::Version_6::FrTOCData::GetDataQuality ( ) const
inlineinherited

◆ GetDataQuality() [2/2]

const data_quality_container_type& FrameCPP::Version_6::FrTOCData::GetDataQuality ( ) const
inherited

◆ GetDescription() [1/2]

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

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

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

◆ GetDescription() [2/2]

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

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

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

◆ GetDt() [1/2]

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

◆ GetDt() [2/2]

const dt_container_type& FrameCPP::Version_6::FrTOCData::GetDt ( ) const
inherited

◆ GetEvent() [1/2]

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

◆ GetEvent() [2/2]

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

◆ GetFrame() [1/2]

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

◆ GetFrame() [2/2]

const frame_container_type& FrameCPP::Version_6::FrTOCData::GetFrame ( ) const
inherited

◆ GetGTimeN() [1/2]

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

◆ GetGTimeN() [2/2]

const gtimes_container_type& FrameCPP::Version_6::FrTOCData::GetGTimeN ( ) const
inherited

◆ GetGTimeS() [1/2]

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

◆ GetGTimeS() [2/2]

const gtimen_container_type& FrameCPP::Version_6::FrTOCData::GetGTimeS ( ) const
inherited

◆ GetKeys() [1/3]

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

◆ GetKeys() [2/3]

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

Retrieve the keys.

Returns
Constant container of keys.

◆ GetKeys() [3/3]

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

Retrieve the keys.

Returns
Constant container of keys.

◆ GetNameDetector() [1/2]

const namedetector_container_type& FrameCPP::Version_6::FrTOCData::GetNameDetector ( ) const
inherited

◆ GetNameDetector() [2/2]

const FrTOCData::namedetector_container_type & FrameCPP::Version_6::FrTOCData::GetNameDetector ( ) const
inlineinherited

◆ GetNFirstADC() [1/2]

const FrTOCData::nfirstadc_container_type & FrameCPP::Version_6::FrTOCData::GetNFirstADC ( ) const
inlineinherited

◆ GetNFirstADC() [2/2]

const nfirstadc_container_type& FrameCPP::Version_6::FrTOCData::GetNFirstADC ( ) const
inherited

◆ GetNFirstMsg() [1/2]

const nfirstmsg_container_type& FrameCPP::Version_6::FrTOCData::GetNFirstMsg ( ) const
inherited

◆ GetNFirstMsg() [2/2]

const FrTOCData::nfirstmsg_container_type & FrameCPP::Version_6::FrTOCData::GetNFirstMsg ( ) const
inlineinherited

◆ GetNFirstSer() [1/2]

const FrTOCData::nfirstser_container_type & FrameCPP::Version_6::FrTOCData::GetNFirstSer ( ) const
inlineinherited

◆ GetNFirstSer() [2/2]

const nfirstser_container_type& FrameCPP::Version_6::FrTOCData::GetNFirstSer ( ) const
inherited

◆ GetNFirstTable() [1/2]

const FrTOCData::nfirsttable_container_type & FrameCPP::Version_6::FrTOCData::GetNFirstTable ( ) const
inlineinherited

◆ GetNFirstTable() [2/2]

const nfirsttable_container_type& FrameCPP::Version_6::FrTOCData::GetNFirstTable ( ) const
inherited

◆ GetNFrame() [1/2]

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

◆ GetNFrame() [2/2]

nframe_type FrameCPP::Version_6::FrTOCData::GetNFrame ( ) const
inherited

◆ GetPositionDetector() [1/2]

const FrTOCData::positiondetector_container_type & FrameCPP::Version_6::FrTOCData::GetPositionDetector ( ) const
inlineinherited

◆ GetPositionDetector() [2/2]

const positiondetector_container_type& FrameCPP::Version_6::FrTOCData::GetPositionDetector ( ) const
inherited

◆ GetPositionH() [1/2]

const FrTOCData::positionh_container_type & FrameCPP::Version_6::FrTOCData::GetPositionH ( ) const
inlineinherited

◆ GetPositionH() [2/2]

const positionh_container_type& FrameCPP::Version_6::FrTOCData::GetPositionH ( ) const
inherited

◆ GetProc() [1/6]

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

◆ GetProc() [2/6]

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

◆ GetProc() [3/6]

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

◆ GetProc() [4/6]

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

◆ GetProc() [5/6]

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

◆ GetProc() [6/6]

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

◆ GetRuns() [1/2]

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

◆ GetRuns() [2/2]

const runs_container_type& FrameCPP::Version_6::FrTOCData::GetRuns ( ) const
inherited

◆ GetSHid() [1/2]

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

◆ GetSHid() [2/2]

const shid_container_type& FrameCPP::Version_6::FrTOCData::GetSHid ( ) const
inherited

◆ GetSHname() [1/2]

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

◆ GetSHname() [2/2]

const shname_container_type& FrameCPP::Version_6::FrTOCData::GetSHname ( ) const
inherited

◆ GetSim() [1/6]

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

◆ GetSim() [2/6]

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

◆ GetSim() [3/6]

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

◆ GetSim() [4/6]

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

◆ GetSim() [5/6]

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

◆ GetSim() [6/6]

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

◆ GetSimEvent() [1/2]

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

◆ GetSimEvent() [2/2]

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

◆ GetStat() [1/2]

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

◆ GetStat() [2/2]

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

◆ GetStatType() [1/2]

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

◆ GetStatType() [2/2]

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

◆ GetULeapS() [1/2]

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

◆ GetULeapS() [2/2]

uleaps_type FrameCPP::Version_6::FrTOCData::GetULeapS ( ) const
inherited

◆ GTimeN() [1/2]

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

◆ GTimeN() [2/2]

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

◆ GTimeS() [1/2]

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

◆ GTimeS() [2/2]

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

◆ IndexObject() [1/2]

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

◆ IndexObject() [2/2]

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

◆ load() [1/2]

void FrameCPP::Version_6::FrTOCData::load ( Common::IStream Stream)
protectedinherited

◆ load() [2/2]

void FrameCPP::Version_6::FrTOCData::load ( Common::IStream Stream)
protectedinherited

◆ loadHeader() [1/2]

void FrameCPP::Version_6::FrTOC::loadHeader ( Common::IStream Stream)
protectedvirtual

◆ loadHeader() [2/2]

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

◆ nameADC() [1/2]

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

◆ nameADC() [2/2]

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

◆ nameProc() [1/2]

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

◆ nameProc() [2/2]

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

◆ nameSer() [1/2]

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

◆ nameSer() [2/2]

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

◆ nameSim() [1/2]

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

◆ nameSim() [2/2]

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

◆ nFrame() [1/2]

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

◆ nFrame() [2/2]

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

◆ nSH() [1/2]

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

◆ nSH() [2/2]

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

◆ ObjectStructName() [1/2]

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

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

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

◆ ObjectStructName() [2/2]

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

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

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

◆ operator==() [1/9]

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

◆ operator==() [2/9]

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

◆ operator==() [3/9]

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

◆ operator==() [4/9]

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

◆ operator==() [5/9]

bool FrameCPP::Version_6::FrTOCEvent::operator== ( const FrTOCEvent RHS) const
inherited

◆ operator==() [6/9]

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

◆ operator==() [7/9]

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

◆ operator==() [8/9]

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

comparison operator

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

◆ operator==() [9/9]

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

comparison operator

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

◆ position_adc() [1/2]

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

◆ position_adc() [2/2]

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

◆ position_proc() [1/2]

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

◆ position_proc() [2/2]

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

◆ positionADC() [1/4]

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

◆ positionADC() [2/4]

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

◆ positionADC() [3/4]

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

◆ positionADC() [4/4]

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

◆ positionDetector() [1/2]

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

Retrieve the stream position for the detector.

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

Implements FrameCPP::Common::FrTOC.

◆ positionDetector() [2/2]

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

Retrieve the stream position for the detector.

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

Implements FrameCPP::Common::FrTOC.

◆ positionEvent() [1/4]

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

◆ positionEvent() [2/4]

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

◆ positionEvent() [3/4]

FrTOC::cmn_position_type FrameCPP::Version_6::FrTOC::positionEvent ( const std::string &  EventType,
INT_4U  Index 
) const
protectedvirtual

◆ positionEvent() [4/4]

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

◆ positionH() [1/2]

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

◆ positionH() [2/2]

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

◆ positionProc() [1/4]

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

◆ positionProc() [2/4]

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

◆ positionProc() [3/4]

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

◆ positionProc() [4/4]

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

◆ positionSer() [1/2]

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

◆ positionSer() [2/2]

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

◆ positionSim() [1/2]

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

◆ positionSim() [2/2]

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

◆ positionSimEvent() [1/4]

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

◆ positionSimEvent() [2/4]

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

◆ positionSimEvent() [3/4]

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

◆ positionSimEvent() [4/4]

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

◆ procDataCachePositions() [1/2]

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

Cache where the positions of the FrProcData channels.

Parameters
[in,out]StreamThe Stream being read

Implements FrameCPP::Common::FrTOC.

◆ procDataCachePositions() [2/2]

virtual void FrameCPP::Version_6::FrTOC::procDataCachePositions ( istream_type Stream)
protectedvirtual

Cache where the positions of the FrProcData channels.

Parameters
[in,out]StreamThe Stream being read

Implements FrameCPP::Common::FrTOC.

◆ promote() [1/2]

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

Upgrade an object.

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

◆ promote() [2/2]

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

Upgrade an object.

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

◆ PromoteObject() [1/5]

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

Upgrade an object.

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

◆ PromoteObject() [2/5]

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

Upgrade an object.

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

◆ PromoteObject() [3/5]

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

Upgrade an object.

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

◆ PromoteObject() [4/5]

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

Upgrade an object.

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

◆ PromoteObject() [5/5]

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

◆ QueryAdc() [1/2]

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

◆ QueryAdc() [2/2]

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

◆ QueryEvent() [1/2]

void FrameCPP::Version_6::FrTOCEvent::QueryEvent ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

◆ QueryEvent() [2/2]

void FrameCPP::Version_6::FrTOCEvent::QueryEvent ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

◆ QueryProc() [1/2]

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

◆ QueryProc() [2/2]

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

◆ QuerySim() [1/2]

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

◆ QuerySim() [2/2]

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

◆ QuerySimEvent() [1/2]

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

◆ QuerySimEvent() [2/2]

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

◆ QueryStatData() [1/2]

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

◆ QueryStatData() [2/2]

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

◆ runs() [1/2]

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

◆ runs() [2/2]

FrTOC::cmn_runs_container_type const & FrameCPP::Version_6::FrTOC::runs ( ) const
protectedvirtual

◆ seekAdcDataPositions() [1/5]

virtual void FrameCPP::Version_6::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/5]

void FrameCPP::Version_6::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/5]

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

Advance to the specified Adc channel.

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

Implements FrameCPP::Common::FrTOC.

◆ seekAdcDataPositions() [4/5]

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

Advance to the specified Adc channel.

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

Implements FrameCPP::Common::FrTOC.

◆ seekAdcDataPositions() [5/5]

virtual void FrameCPP::Common::FrTOC::seekAdcDataPositions ( istream_type Stream,
channel_id_type  Channel 
)
pure virtualinherited

Advance to the specified Adc channel.

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

Implemented in FrameCPP::Version_4::FrTOC, and FrameCPP::Version_4::FrTOC.

◆ seekPositions() [1/4]

void FrameCPP::Version_6::FrTOCAdcData::seekPositions ( istream_type Stream,
channel_id_type  Channel 
)
inlineprotectedinherited

◆ seekPositions() [2/4]

void FrameCPP::Version_6::FrTOCAdcData::seekPositions ( istream_type Stream,
channel_id_type  Channel 
)
protectedinherited

◆ seekPositions() [3/4]

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

◆ seekPositions() [4/4]

void FrameCPP::Version_6::FrTOCAdcData::seekPositions ( istream_type Stream,
const std::string &  Channel 
)
protectedinherited

◆ setAdcDataPoisitions() [1/2]

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

◆ setAdcDataPoisitions() [2/2]

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

◆ SHid() [1/2]

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

◆ SHid() [2/2]

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

◆ SHname() [1/2]

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

◆ SHname() [2/2]

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

◆ StructDescription() [1/2]

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

◆ StructDescription() [2/2]

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

◆ StructName() [1/2]

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

◆ StructName() [2/2]

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

◆ VerifyObject() [1/2]

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

◆ VerifyObject() [2/2]

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

◆ write() [1/8]

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

◆ write() [2/8]

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

◆ write() [3/8]

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

◆ write() [4/8]

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

◆ write() [5/8]

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

◆ write() [6/8]

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

◆ write() [7/8]

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

◆ Write() [1/2]

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

Write object to the stream.

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

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

◆ Write() [2/2]

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

Write object to the stream.

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

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

◆ write() [8/8]

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

◆ WriteNext() [1/2]

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

Write a next pointer to the parent to the stream.

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

◆ WriteNext() [2/2]

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

Write a next pointer to the parent to the stream.

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

Member Data Documentation

◆ event_type_size [1/2]

static const int FrameCPP::Version_6::FrTOCEvent::event_type_size
staticinherited
Initial value:
= sizeof( gtimesEvent_type ) +
sizeof( gtimenEvent_type ) + sizeof( amplitudeEvent_type ) +

◆ event_type_size [2/2]

static const int FrameCPP::Version_6::FrTOCSimEvent::event_type_size
staticinherited
Initial value:
= sizeof( gtimesSim_type ) +
sizeof( gtimenSim_type ) + sizeof( amplitudeSimEvent_type ) +

◆ m_dataQuality

data_quality_container_type FrameCPP::Version_6::FrTOCData::m_dataQuality
protectedinherited

◆ m_dt

dt_container_type FrameCPP::Version_6::FrTOCData::m_dt
protectedinherited

◆ m_frame

frame_container_type FrameCPP::Version_6::FrTOCData::m_frame
protectedinherited

◆ m_GTimeN

gtimen_container_type FrameCPP::Version_6::FrTOCData::m_GTimeN
protectedinherited

◆ m_GTimeS

gtimes_container_type FrameCPP::Version_6::FrTOCData::m_GTimeS
protectedinherited

◆ m_info [1/5]

MapSim_type FrameCPP::Version_6::FrTOCSimData::m_info
protectedinherited

◆ m_info [2/5]

nameSimEvent_container_type FrameCPP::Version_6::FrTOCSimEvent::m_info
protectedinherited

◆ m_info [3/5]

nameEvent_container_type FrameCPP::Version_6::FrTOCEvent::m_info
protectedinherited

◆ m_info [4/5]

stat_container_type FrameCPP::Version_6::FrTOCStatData::m_info
protectedinherited

◆ m_info [5/5]

MapADC_type FrameCPP::Version_6::FrTOCAdcData::m_info
protectedinherited

◆ m_keys [1/2]

key_container_type FrameCPP::Version_6::FrTOCSimData::m_keys
protectedinherited

◆ m_keys [2/2]

key_container_type FrameCPP::Version_6::FrTOCAdcData::m_keys
protectedinherited

◆ m_nameDetector

namedetector_container_type FrameCPP::Version_6::FrTOCData::m_nameDetector
protectedinherited

◆ m_nFirstADC

nfirstadc_container_type FrameCPP::Version_6::FrTOCData::m_nFirstADC
protectedinherited

◆ m_nFirstMsg

nfirstmsg_container_type FrameCPP::Version_6::FrTOCData::m_nFirstMsg
protectedinherited

◆ m_nFirstSer

nfirstser_container_type FrameCPP::Version_6::FrTOCData::m_nFirstSer
protectedinherited

◆ m_nFirstTable

nfirsttable_container_type FrameCPP::Version_6::FrTOCData::m_nFirstTable
protectedinherited

◆ m_positionDetector

positiondetector_container_type FrameCPP::Version_6::FrTOCData::m_positionDetector
protectedinherited

◆ m_positionH

positionh_container_type FrameCPP::Version_6::FrTOCData::m_positionH
protectedinherited

◆ m_positions_start

position_type FrameCPP::Version_6::FrTOCAdcData::m_positions_start
protectedinherited

◆ m_runs

runs_container_type FrameCPP::Version_6::FrTOCData::m_runs
protectedinherited

◆ m_SHid

shid_container_type FrameCPP::Version_6::FrTOCData::m_SHid
protectedinherited

◆ m_SHname

shname_container_type FrameCPP::Version_6::FrTOCData::m_SHname
protectedinherited

◆ m_StatType

MapStatType_type FrameCPP::Version_6::FrTOC::m_StatType
private

◆ m_ULeapS

uleaps_type FrameCPP::Version_6::FrTOCData::m_ULeapS
protectedinherited

◆ NO_DATA_AVAILABLE

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

◆ s_object_id

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

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