ldas-tools-framecpp  2.6.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Version_8::FrTOC Class Reference

Table of Contents Data Structure Definition. More...

#include <FrTOC.hh>

Inheritance diagram for FrameCPP::Version_8::FrTOC:
FrameCPP::Version_8::FrTOCSimEvent FrameCPP::Version_8::FrTOCEvent FrameCPP::Version_8::FrTOCSummary FrameCPP::Version_8::FrTOCSerData FrameCPP::Version_8::FrTOCSimData FrameCPP::Version_8::FrTOCProcData FrameCPP::Version_8::FrTOCAdcData FrameCPP::Version_8::FrTOCStatData FrameCPP::Version_8::FrTOCData FrameCPP::Version_8::ObjectWithChecksum< Common::FrTOC >

Classes

struct  StatType_type
 
class  StatTypeKey
 
class  StatTypeKeyHash
 

Public Types

typedef INT_8U position_type
 
typedef std::vector
< position_type
position_list_type
 
typedef
LDASTools::AL::unordered_map
< StatTypeKey, StatType_type,
StatTypeKeyHash
MapStatType_type
 
typedef ObjectWithChecksum
< Common::FrTOC, checksum_type
self_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
enum  query_info_type { TOC_CHANNEL_NAMES, TOC_DETECTOR, TOC_FR_STRUCTS }
 
typedef INT_8U cmn_position_type
 
typedef INT_4U channel_id_type
 
typedef boost::shared_ptr
< FrameSpec::Object > 
object_type
 
typedef std::vector< STRING
< INT_2U > > 
cmn_name_container_type
 
typedef std::vector< REAL_8 > cmn_dt_container_type
 
typedef std::vector< INT_4U > cmn_GTimeS_container_type
 
typedef std::vector< INT_4U > cmn_GTimeN_container_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef INT_4U data_quality_type
 
typedef REAL_8 dt_type
 
typedef INT_4U frame_type
 
typedef INT_4U gtimen_type
 
typedef INT_4U gtimes_type
 
typedef STRING namedetector_type
 
typedef INT_4U ndetector_type
 
typedef INT_8U nfirstadc_type
 
typedef INT_8U nfirstmsg_type
 
typedef INT_8U nfirstser_type
 
typedef INT_8U nfirsttable_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_4S runs_type
 
typedef INT_2U shid_type
 
typedef STRING shname_type
 
typedef FR_TOC_ULEAPS_TYPE uleaps_type
 
typedef std::vector
< data_quality_type
data_quality_container_type
 Array of integer QA words from each FrameH. More...
 
typedef std::vector< dt_typedt_container_type
 Array of frame durations in seconds. More...
 
typedef std::vector< frame_typeframe_container_type
 Array of frame numbers. More...
 
typedef std::vector< gtimen_typegtimen_container_type
 Array of integer GPS residual nanoseconds for the frame. More...
 
typedef std::vector< gtimes_typegtimes_container_type
 Array of integer GPS frame times. More...
 
typedef std::vector
< namedetector_type
namedetector_container_type
 Array of FrDetector names. More...
 
typedef std::vector
< nfirstadc_type
nfirstadc_container_type
 Array of first FrADCData positions. More...
 
typedef std::vector
< nfirstmsg_type
nfirstmsg_container_type
 Array of first FrMsg positions. More...
 
typedef std::vector
< nfirstser_type
nfirstser_container_type
 Array of first FrSerData positions. More...
 
typedef std::vector
< nfirsttable_type
nfirsttable_container_type
 Array of first FrTable positions. More...
 
typedef std::vector
< positiondetector_type
positiondetector_container_type
 Array of FrDetector positions. More...
 
typedef std::vector
< positionh_type
positionh_container_type
 Array of FrSH IDs. More...
 
typedef std::vector< runs_typeruns_container_type
 Array of FrameH positions. More...
 
typedef std::vector< shid_typeshid_container_type
 Array of FrSH IDs. More...
 
typedef std::vector< shname_typeshname_container_type
 Array of FrSH names. More...
 
typedef STRING name_type
 
typedef INT_4U nstat_type
 
typedef STRING detector_type
 
typedef INT_4U nstat_instance_type
 
typedef INT_4U tstart_type
 
typedef INT_4U tend_type
 
typedef INT_4U version_type
 
typedef INT_8U positionStat_type
 
typedef std::vector
< stat_instance_type
stat_instance_container_type
 
typedef std::map< name_type,
stat_type
stat_container_type
 
typedef
Previous::FrTOCAdcData::nadc_type 
nadc_type
 
typedef
Previous::FrTOCAdcData::name_type 
name_type
 
typedef
Previous::FrTOCAdcData::channel_id_type 
channel_id_type
 
typedef
Previous::FrTOCAdcData::group_id_type 
group_id_type
 
typedef
Previous::FrTOCAdcData::adc_info_type 
adc_info_type
 
typedef std::vector< name_typekey_container_type
 
typedef std::map< name_type,
adc_info_type
MapADC_type
 Container of indexed FrAdcData elements. More...
 
typedef INT_4U nproc_type
 
typedef STRING name_type
 
typedef std::vector< name_typekey_container_type
 
typedef std::vector
< position_type
proc_info_type
 
typedef std::map< name_type,
proc_info_type
MapProc_type
 
typedef INT_4U frame_count_type
 
typedef INT_4U n_type
 
typedef std::vector
< position_type
info_type
 
typedef std::map< name_type,
info_type
Map_type
 
typedef INT_4U nsim_type
 
typedef STRING name_type
 
typedef std::vector
< position_type
sim_info_type
 
typedef std::map< name_type,
sim_info_type
MapSim_type
 
typedef FrTOCPosition::n_type nser_type
 
typedef FrTOCPosition::info_type ser_info_type
 
typedef FrTOCPosition::Map_type MapSer_type
 
typedef FrTOCPosition::n_type nsummary_type
 
typedef FrTOCPosition::info_type summary_info_type
 
typedef FrTOCPosition::Map_type MapSummary_type
 
typedef INT_4U nevent_type
 
typedef STRING name_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 std::vector< event_typeevents_container_type
 
typedef std::map< name_type,
events_container_type
nameEvent_container_type
 
typedef INT_4U nevent_type
 
typedef STRING name_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::vector< event_typeevents_container_type
 
typedef std::map< name_type,
events_container_type
nameSimEvent_container_type
 

Public Member Functions

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

Static Public Member Functions

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

Public Attributes

position_type m_positions_start
 

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, Common::IStream *Stream) const
 Demotes object to previous version of the frame spec. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, Common::IStream *Stream) const
 Promotes object to another version of the frame spec. More...
 
virtual
Common::FrameSpec::size_type 
pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual FrTOCpCreate (Common::IStream &Stream) const
 Virtual constructor. More...
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream. More...
 
virtual 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_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_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. 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
 
void setAdcDataPoisitions ()
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void write (Common::OStream &Stream) const
 Write the structure to the stream. More...
 
void write (Common::OStream &Stream) const
 Write the structure to the stream. More...
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void cachePositions (istream_type &Stream)
 Cache where the positions of the Adc channels. More...
 
void seekPositions (istream_type &Stream, channel_id_type Channel)
 Advance to the specified Adc channel. More...
 
void seekPositions (istream_type &Stream, const std::string &Channel)
 Advance to the specified Adc channel. More...
 
void write (Common::OStream &Stream) const
 Write the structure to the stream. More...
 
bool operator== (const PositionWithCache &RHS) const
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void write (Common::OStream &Stream) const
 Write the structure to the stream. More...
 
const Map_typegetInfo () const
 
Map_type::const_iterator getInfo (const std::string &Name) const
 
Map_type::const_iterator getInfo (INT_4U Index) const
 
void cachePositions (istream_type &Stream)
 TOC optimization. More...
 
void setPositionsOffset (istream_type &Stream)
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void write (Common::OStream &Stream) const
 Write the structure to the stream. More...
 
void write (Common::OStream &Stream) const
 Write the structure to the stream. More...
 
void write (Common::OStream &Stream) const
 Write the structure to the stream. More...
 
void write (Common::OStream &Stream) const
 Write the structure to the stream. More...
 
void write (Common::OStream &Stream) const
 Write the structure to the stream. More...
 

Protected Attributes

uleaps_type m_ULeapS
 From the first FrameH in the file. More...
 
data_quality_container_type m_dataQuality
 Array of integer QA words from each FrameH (size of nFrame) More...
 
gtimes_container_type m_GTimeS
 Array of integer GPS frame times (size of nFrame). More...
 
gtimen_container_type m_GTimeN
 Array of integer GPS residual nanoseconds for the frame (size of nFrame). More...
 
dt_container_type m_dt
 Array of frame durations in seconds (size of nFrame). More...
 
runs_container_type m_runs
 Array of run numbers. More...
 
frame_container_type m_frame
 Array of frame numbers (size of nFrame). More...
 
positiondetector_container_type m_positionDetector
 Array of FrDetector positions. More...
 
positionh_container_type m_positionH
 Array of FrameH positions, in bytes, from beginning of file. The size of this array is specified by nFrame. More...
 
namedetector_container_type m_nameDetector
 Array of FrDetector names. More...
 
nfirstadc_container_type m_nFirstADC
 Array of first FrADCData positions. More...
 
nfirstser_container_type m_nFirstSer
 Array of first FrSerData positions. More...
 
nfirsttable_container_type m_nFirstTable
 Array of first FrTable positions. More...
 
nfirstmsg_container_type m_nFirstMsg
 Array of first FrMsg positions. More...
 
shid_container_type m_SHid
 Array of FrSH IDs. More...
 
shname_container_type m_SHname
 Array of FrSH names. The size of array is specified by nSH. More...
 
stat_container_type m_info
 
key_container_type m_keys
 
MapADC_type m_info
 
key_container_type m_keys
 
MapProc_type m_info
 
key_container_type m_keys
 
MapSim_type m_info
 
nameEvent_container_type m_info
 
nameSimEvent_container_type m_info
 

Detailed Description

Table of Contents Data Structure Definition.

Member Typedef Documentation

typedef Previous::FrTOCAdcData::adc_info_type FrameCPP::Version_8::FrTOCAdcData::adc_info_type
inherited
typedef INT_4U FrameCPP::Common::FrTOC::channel_id_type
inherited
typedef Previous::FrTOCAdcData::channel_id_type FrameCPP::Version_8::FrTOCAdcData::channel_id_type
inherited
typedef std::vector< REAL_8 > FrameCPP::Common::FrTOC::cmn_dt_container_type
inherited
typedef std::vector< INT_4U > FrameCPP::Common::FrTOC::cmn_GTimeN_container_type
inherited
typedef std::vector< INT_4U > FrameCPP::Common::FrTOC::cmn_GTimeS_container_type
inherited
typedef std::vector< STRING< INT_2U > > FrameCPP::Common::FrTOC::cmn_name_container_type
inherited

Array of integer QA words from each FrameH.

Array of frame durations in seconds.

typedef REAL_8 FrameCPP::Version_8::FrTOCData::dt_type
inherited

Array of frame numbers.

typedef Previous::FrTOCAdcData::group_id_type FrameCPP::Version_8::FrTOCAdcData::group_id_type
inherited

Array of integer GPS residual nanoseconds for the frame.

Array of integer GPS frame times.

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

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.

typedef FrTOCPosition::Map_type FrameCPP::Version_8::FrTOCSerData::MapSer_type
inherited
typedef FrTOCPosition::Map_type FrameCPP::Version_8::FrTOCSummary::MapSummary_type
inherited
typedef Previous::FrTOCAdcData::nadc_type FrameCPP::Version_8::FrTOCAdcData::nadc_type
inherited
typedef Previous::FrTOCAdcData::name_type FrameCPP::Version_8::FrTOCAdcData::name_type
inherited

Array of FrDetector names.

Array of first FrADCData positions.

Array of first FrMsg positions.

Array of first FrSerData positions.

Array of first FrTable positions.

typedef FrTOCPosition::n_type FrameCPP::Version_8::FrTOCSerData::nser_type
inherited
typedef INT_4U FrameCPP::Version_8::FrTOCData::nsh_type
inherited
typedef FrTOCPosition::n_type FrameCPP::Version_8::FrTOCSummary::nsummary_type
inherited
typedef boost::shared_ptr< FrameSpec::Object > FrameCPP::Common::FrTOC::object_type
inherited

Array of FrDetector positions.

Array of FrSH IDs.

Array of FrameH positions.

typedef FrTOCPosition::info_type FrameCPP::Version_8::FrTOCSerData::ser_info_type
inherited

Array of FrSH IDs.

Array of FrSH names.

typedef FrTOCPosition::info_type FrameCPP::Version_8::FrTOCSummary::summary_info_type
inherited

Member Enumeration Documentation

Enumerator
TOC_CHANNEL_NAMES 
TOC_DETECTOR 
TOC_FR_STRUCTS 

Constructor & Destructor Documentation

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

Default constructor.

Returns
A new instance of this object.
FrameCPP::Version_8::FrTOC::FrTOC ( const FrameCPP::Common::FrTOC Source)
explicit

Constructor.

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

Member Function Documentation

Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCSimData::Bytes ( const Common::StreamBase Stream) const
inlineinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.
Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCProcData::Bytes ( const Common::StreamBase Stream) const
inlineinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.
Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCAdcData::Bytes ( const Common::StreamBase Stream) const
inlineinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.
Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCSimEvent::Bytes ( const Common::StreamBase Stream) const
inlineinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.
Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCEvent::Bytes ( const Common::StreamBase Stream) const
inlineinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.
Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCStatData::Bytes ( const Common::StreamBase Stream) const
inlineinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.
Common::FrameSpec::size_type FrameCPP::Version_8::FrTOCData::Bytes ( const Common::StreamBase Stream) const
inlineinherited
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC , checksum_type >::Bytes ( const StreamBase Stream) const
virtualinherited

Return the number of bytes for this object.

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

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

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

Cache where the positions of the Adc channels.

Parameters
[in,out]StreamThe Stream being read

Implements FrameCPP::Common::FrTOC.

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

Cache where the positions of the Adc channels.

Parameters
[in,out]StreamThe Stream being read
void FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCTypes::position_type >::cachePositions ( istream_type Stream)
inlineprotectedinherited

TOC optimization.

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

static const char* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC , checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

static const char* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC , checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

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

Virtual constructor.

Returns
A new instance of this object.

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

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

Virtual constructor.

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

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

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

Demotes object to previous version of the frame spec.

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

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

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.
template<typename SE >
void FrameCPP::Version_8::FrTOCSerData::Description ( Common::Description Desc)
staticinherited

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.
template<typename SE >
void FrameCPP::Version_8::FrTOCSummary::Description ( Common::Description Desc)
staticinherited

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.
template<typename SE >
void FrameCPP::Version_8::FrTOCSimData::Description ( Common::Description Desc)
staticinherited

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.
template<typename SE >
void FrameCPP::Version_8::FrTOCSimEvent::Description ( Common::Description Desc)
staticinherited

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Descriptio nobject which describes this structure as specified by the frame specification.
template<typename SE >
void FrameCPP::Version_8::FrTOCEvent::Description ( Common::Description Desc)
staticinherited

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.
template<typename SE >
void FrameCPP::Version_8::FrTOCStatData::Description ( Common::Description Desc)
staticinherited

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.
template<typename SE >
void FrameCPP::Version_8::FrTOCProcData::Description ( Common::Description Desc)
staticinherited

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.
template<typename SE >
void FrameCPP::Version_8::FrTOCAdcData::Description ( Common::Description Desc)
staticinherited

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.
template<typename SE >
void FrameCPP::Version_8::FrTOCData::Description ( Common::Description Desc)
staticinherited

The description of structure.

Parameters
[out]DescStorage for the description of the structure.
Returns
A Description object which describes this structure as specified by the frame specification.
const FrTOC::cmn_dt_container_type & FrameCPP::Version_8::FrTOC::dt ( ) const
protectedvirtual
void FrameCPP::Version_8::FrTOC::ForEach ( query_info_type  Info,
FunctionBase Action 
) const
virtual

Iterate over elements of the Table of Contents.

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

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

Todo:
Need to finish the list of channel names

Reimplemented from FrameCPP::Common::FrTOC.

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

Iterate over contents.

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

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

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

Iterate over contents.

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

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

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

Iterate over contents.

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

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

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

Iterate over contents.

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

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

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

Retieve FrStatData data.

Parameters
[in]NamePatternRegular expression describing the FrStatData name of interest.
[in]StartTimeThe lower bound GPS time of the FrStatData start time.
[in]EndTimeThe upper bound GPS time of the FrStatData end time.
[in]VersionThe FrStatData version of interest.
[out]ResultAll FrStatData information that matched the query.

Implements FrameCPP::Common::FrTOC.

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

Return all channels.

Returns
Constant container to the indexed FrAdcData elements.
FrTOCAdcData::MapADC_type::const_iterator FrameCPP::Version_8::FrTOCAdcData::GetADC ( const std::string &  Name) const
inherited

Return the indexed data for a named channel.

Parameters
[in]NameThe name of the channel.
Returns
Constant iterator to the indexed FrAdcData element.
FrTOCAdcData::MapADC_type::const_iterator FrameCPP::Version_8::FrTOCAdcData::GetADC ( INT_4U  index) const
inherited

Return the indexed data for an indexed channel.

Parameters
[in]indexThe numeric offset of the channel.
Returns
Constant iterator to the indexed FrAdcData element.
FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inlineinherited

Retrieve the class identifier.

Returns
The class identifier.
FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

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

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

Retreive array of integer QA words from each FrameH.

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.

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

Retrieve array of frame durations in seconds.

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

Return all events.

Returns
Constant container to the indexed FrEvent elements.
const FrTOCData::frame_container_type & FrameCPP::Version_8::FrTOCData::GetFrame ( ) const
inlineinherited

Retrieve array of frame numbers.

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

Retrieve array of integer GPS residual nanoseconds for the frame.

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

Retrieve array of integer GPS frame times.

const Map_type& FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCTypes::position_type >::getInfo ( ) const
inlineprotectedinherited
Map_type::const_iterator FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCTypes::position_type >::getInfo ( const std::string &  Name) const
inlineprotectedinherited
Map_type::const_iterator FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCTypes::position_type >::getInfo ( INT_4U  Index) const
inlineprotectedinherited
const FrTOCProcData::key_container_type & FrameCPP::Version_8::FrTOCProcData::GetKeys ( ) const
inlineinherited

Retrieve the keys.

Returns
Constant container of keys.
const FrTOCAdcData::key_container_type & FrameCPP::Version_8::FrTOCAdcData::GetKeys ( ) const
inlineinherited

Retrieve the keys.

Returns
Constant container of keys.
const FrTOCData::namedetector_container_type & FrameCPP::Version_8::FrTOCData::GetNameDetector ( ) const
inlineinherited

Retrieve array of FrDetector names.

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

Retrieve array of first FrADCData positions.

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

Retrieve array of first FrMsg positions.

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

Retrieve array of first FrSerData positions.

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

Retrieve array of first FrTable positions.

FrTOCData::nFrame_type FrameCPP::Version_8::FrTOCData::GetNFrame ( ) const
inlineinherited
INT_4U FrameCPP::Version_8::FrTOCStatData::GetNTotalStat ( ) const
inlineinherited

Return number of FrStatData structures.

Returns
The number of FrStatData structures.
const FrTOCData::positiondetector_container_type & FrameCPP::Version_8::FrTOCData::GetPositionDetector ( ) const
inlineinherited

Retrieve array of FrDetector positions.

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

Retrieve array of FrameH positions.

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

Return all channels.

Returns
Constant container to the indexed FrProcData elements.
FrTOCProcData::MapProc_type::const_iterator FrameCPP::Version_8::FrTOCProcData::GetProc ( const std::string &  Name) const
inherited

Return the indexed data for a named channel.

Parameters
[in]NameThe name of the channel.
Returns
Constant iterator to the indexed FrProcData element.
FrTOCProcData::MapProc_type::const_iterator FrameCPP::Version_8::FrTOCProcData::GetProc ( INT_4U  index) const
inherited

Return the indexed data for a named channel.

Parameters
[in]indexThe numeric offset of the channel.
Returns
Constant iterator to the indexed FrProcData element.
const FrTOCData::runs_container_type & FrameCPP::Version_8::FrTOCData::GetRuns ( ) const
inlineinherited
const FrTOCSerData::MapSer_type & FrameCPP::Version_8::FrTOCSerData::GetSer ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrSerData elements.
FrTOCSerData::MapSer_type::const_iterator FrameCPP::Version_8::FrTOCSerData::GetSer ( const std::string &  Name) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]NameThe name of the channel.
Returns
Constant iterator to the indexed FrSerData element.
FrTOCSerData::MapSer_type::const_iterator FrameCPP::Version_8::FrTOCSerData::GetSer ( INT_4U  index) const
inlineinherited

Return the indexed data for a named channel.

Parameters
[in]indexThe numeric offset of the channel.
Returns
Constant iterator to the indexed FrSerData element.
const FrTOCData::shid_container_type & FrameCPP::Version_8::FrTOCData::GetSHid ( ) const
inlineinherited

Retrieve array of FrSH IDs.

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

Retrieve array of FrSH names.

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

Return all channels.

Returns
Constant container to the indexed FrSimData elements.
FrTOCSimData::MapSim_type::const_iterator FrameCPP::Version_8::FrTOCSimData::GetSim ( const std::string &  Name) const
inherited

Return the indexed data for a named channel.

Parameters
[in]NameThe name of the channel.
Returns
Constant iterator to the indexed FrSimData element.
FrTOCSimData::MapSim_type::const_iterator FrameCPP::Version_8::FrTOCSimData::GetSim ( INT_4U  index) const
inherited

Return the indexed data for a named channel.

Parameters
[in]indexThe numeric offset of the channel.
Returns
Constant iterator to the indexed FrSimData element.
const FrTOCSimEvent::nameSimEvent_container_type & FrameCPP::Version_8::FrTOCSimEvent::GetSimEvent ( ) const
inlineinherited

Return all events.

Returns
Constant container to the indexed FrSimEvent elements.
const FrTOCStatData::stat_container_type & FrameCPP::Version_8::FrTOCStatData::GetStat ( ) const
inlineinherited

Return all channels.

Returns
Constant container to the indexed FrStatData elements.
const FrTOC::MapStatType_type & FrameCPP::Version_8::FrTOC::GetStatType ( ) const
inline
const FrTOCSummary::MapSummary_type & FrameCPP::Version_8::FrTOCSummary::GetSummary ( ) const
inlineinherited

Return all summary elements.

Returns
Constant container to the indexed FrSummary elements.
FrTOCSummary::MapSummary_type::const_iterator FrameCPP::Version_8::FrTOCSummary::GetSummary ( const std::string &  Name) const
inlineinherited

Return the indexed data for a named summary elemnet.

Parameters
[in]NameThe name of the summary elment.
Returns
Constant iterator to the indexed FrSummary element.
FrTOCSummary::MapSummary_type::const_iterator FrameCPP::Version_8::FrTOCSummary::GetSummary ( INT_4U  index) const
inlineinherited

Return the indexed data for an index summary element.

Parameters
[in]indexThe numeric offset of the summary element.
Returns
Constant iterator to the indexed FrSummary element.
FrTOCData::uleaps_type FrameCPP::Version_8::FrTOCData::GetULeapS ( ) const
inlineinherited

Retrieve the number of leap seconds.

const FrTOC::cmn_GTimeN_container_type & FrameCPP::Version_8::FrTOC::GTimeN ( ) const
protectedvirtual
const FrTOC::cmn_GTimeS_container_type & FrameCPP::Version_8::FrTOC::GTimeS ( ) const
protectedvirtual
void FrameCPP::Version_8::FrTOC::IndexObject ( object_type  Object,
std::streampos  Position 
)
virtual

Place information about an object into the TOC.

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

Implements FrameCPP::Common::FrTOC.

const FrTOC::cmn_name_container_type & FrameCPP::Version_8::FrTOC::nameADC ( ) const
protectedvirtual
const FrTOC::cmn_name_container_type & FrameCPP::Version_8::FrTOC::nameProc ( ) const
protectedvirtual
const FrTOC::cmn_name_container_type & FrameCPP::Version_8::FrTOC::nameSer ( ) const
protectedvirtual
const FrTOC::cmn_name_container_type & FrameCPP::Version_8::FrTOC::nameSim ( ) const
protectedvirtual
INT_4U FrameCPP::Version_8::FrTOC::nFrame ( ) const
protectedvirtual
INT_4U FrameCPP::Version_8::FrTOC::nSH ( ) const
protectedvirtual
const char * FrameCPP::Version_8::FrTOC::ObjectStructName ( ) const
virtual

The name structure name of this object.

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

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

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

equality operator

Parameters
[in]RHSThe FrTOCAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.
bool FrameCPP::Version_8::FrTOCSummary::operator== ( const FrTOCSummary RHS) const
inherited

equality operator

Parameters
[in]RHSThe FrTOCAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.
bool FrameCPP::Version_8::FrTOCSimData::operator== ( const FrTOCSimData RHS) const
inherited

equality operator

Parameters
[in]RHSThe FrTOCAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.
bool FrameCPP::Version_8::FrTOCSimEvent::operator== ( const FrTOCSimEvent RHS) const
inherited

equality operator

Parameters
[in]RHSThe FrTOCAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.
bool FrameCPP::Version_8::FrTOCStatData::operator== ( const FrTOCStatData RHS) const
inherited

equality operator

Parameters
[in]RHSThe FrTOCAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.
bool FrameCPP::Version_8::FrTOCEvent::operator== ( const FrTOCEvent RHS) const
inherited

equality operator

Parameters
[in]RHSThe FrTOCAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.
bool FrameCPP::Version_8::FrTOCProcData::operator== ( const FrTOCProcData RHS) const
inherited

equality operator

Parameters
[in]RHSThe FrTOCAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.
bool FrameCPP::Version_8::FrTOCAdcData::operator== ( const FrTOCAdcData RHS) const
inherited

equality operator

Parameters
[in]RHSThe FrTOCAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.
bool FrameCPP::Version_8::FrTOCData::operator== ( const FrTOCData RHS) const
inlineinherited

equality operator

Parameters
[in]RHSThe FrTOCData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.
bool FrameCPP::Version_8::FrTOC::operator== ( const Common::FrameSpec::Object RHS) const
virtual

equality operator

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

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

bool FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCTypes::position_type >::operator== ( const PositionWithCache< STRING, FrTOCTypes::position_type > &  RHS) const
inlineprotectedinherited
Common::FrameSpec::size_type FrameCPP::Version_8::FrTOC::pBytes ( const Common::StreamBase Stream) const
protectedvirtual

Number of bytes needed to write this structure.

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

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

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

Virtual constructor.

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

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

FrTOC::cmn_position_type FrameCPP::Version_8::FrTOC::positionADC ( INT_4U  FrameIndex,
const std::string &  Channel 
) const
protectedvirtual
FrTOC::cmn_position_type FrameCPP::Version_8::FrTOC::positionADC ( INT_4U  FrameIndex,
INT_4U  Channel 
) const
protectedvirtual
FrTOC::cmn_position_type FrameCPP::Version_8::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.

FrTOC::cmn_position_type FrameCPP::Version_8::FrTOC::positionEvent ( INT_4U  FrameIndex,
const std::string &  Event 
) const
protectedvirtual
FrTOC::cmn_position_type FrameCPP::Version_8::FrTOC::positionEvent ( const std::string &  Event,
INT_4U  Index 
) const
protectedvirtual
FrTOC::cmn_position_type FrameCPP::Version_8::FrTOC::positionH ( INT_4U  FrameIndex) const
protectedvirtual
FrTOC::cmn_position_type FrameCPP::Version_8::FrTOC::positionProc ( INT_4U  FrameIndex,
const std::string &  Channel 
) const
protectedvirtual
FrTOC::cmn_position_type FrameCPP::Version_8::FrTOC::positionProc ( INT_4U  FrameIndex,
INT_4U  Channel 
) const
protectedvirtual
FrTOC::cmn_position_type FrameCPP::Version_8::FrTOC::positionSer ( INT_4U  FrameIndex,
const std::string &  Channel 
) const
protectedvirtual
FrTOC::cmn_position_type FrameCPP::Version_8::FrTOC::positionSim ( INT_4U  FrameIndex,
const std::string &  Channel 
) const
protectedvirtual
FrTOC::cmn_position_type FrameCPP::Version_8::FrTOC::positionSimEvent ( INT_4U  FrameIndex,
const std::string &  SimEvent 
) const
protectedvirtual
FrTOC::cmn_position_type FrameCPP::Version_8::FrTOC::positionSimEvent ( const std::string &  EventType,
INT_4U  Index 
) const
protectedvirtual
void FrameCPP::Version_8::FrTOC::procDataCachePositions ( istream_type Stream)
protectedvirtual

Cache where the positions of the FrProcData channels.

Parameters
[in,out]StreamThe Stream being read

Implements FrameCPP::Common::FrTOC.

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

Promotes object to another version of the frame spec.

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

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

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.
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.
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
void FrameCPP::Version_8::FrTOC::pWrite ( Common::OStream Stream) const
protectedvirtual

Write the structure to the stream.

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

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

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

Gather TOC info for FrAdcData being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.
void FrameCPP::Version_8::FrTOCEvent::QueryEvent ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

Gather TOC info for FrEvent being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.
void FrameCPP::Version_8::FrTOCProcData::QueryProc ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

Gather TOC info for FrProcData being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.
void FrameCPP::Version_8::FrTOCSerData::QuerySer ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

Gather TOC info for FrSerData being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.
void FrameCPP::Version_8::FrTOCSimData::QuerySim ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

Gather TOC info for FrSimData being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.
void FrameCPP::Version_8::FrTOCSimEvent::QuerySimEvent ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

Gather TOC info for FrSimEvent being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.
void FrameCPP::Version_8::FrTOCStatData::QueryStatData ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

Gather TOC info for FrStatData being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.
void FrameCPP::Version_8::FrTOCSummary::QuerySum ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited

Gather TOC info for FrSummary being written.

Parameters
[in]InfoInformation
[in]FrameOffsetThe frame offset of the frame being written. The frame offsets start at 0 (zero).
[in]PositionThe byte offset from the start of the file where the structure is written.
void FrameCPP::Version_8::FrTOC::seekAdcDataPositions ( istream_type Stream,
Common::FrTOC::channel_id_type  Channel 
)
protectedvirtual

Advance to the specified Adc channel.

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

Implements FrameCPP::Common::FrTOC.

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

Advance to the specified Adc channel.

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

Implements FrameCPP::Common::FrTOC.

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

Advance to the specified Adc channel.

Parameters
[in,out]StreamThe Stream being read
[in]ChannelThe requested channel
void FrameCPP::Version_8::FrTOCAdcData::seekPositions ( istream_type Stream,
const std::string &  Channel 
)
inlineprotectedinherited

Advance to the specified Adc channel.

Parameters
[in,out]StreamThe Stream being read
[in]ChannelThe requested channel
void FrameCPP::Common::FrTOC::setAdcDataPoisitions ( )
protectedinherited
void FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCTypes::position_type >::setPositionsOffset ( istream_type Stream)
inlineprotectedinherited
INT_2U FrameCPP::Version_8::FrTOC::SHid ( INT_4U  Offset) const
protectedvirtual
const std::string & FrameCPP::Version_8::FrTOC::SHname ( INT_4U  Offset) const
protectedvirtual
const Common::Description * FrameCPP::Version_8::FrTOC::StructDescription ( )
static

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.
const char * FrameCPP::Version_8::FrTOC::StructName ( )
inlinestatic

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.
void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited
void FrameCPP::Version_8::FrTOCSerData::write ( Common::OStream Stream) const
inlineprotectedinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.
void FrameCPP::Version_8::FrTOCSummary::write ( Common::OStream Stream) const
inlineprotectedinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.
void FrameCPP::Version_8::FrTOCSimData::write ( Common::OStream Stream) const
protectedinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.
void FrameCPP::Version_8::FrTOCStatData::write ( Common::OStream Stream) const
protectedinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.
void FrameCPP::Version_8::FrTOCProcData::write ( Common::OStream Stream) const
protectedinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.
void FrameCPP::Version_8::FrTOCSimEvent::write ( Common::OStream Stream) const
protectedinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.
void FrameCPP::Version_8::FrTOCEvent::write ( Common::OStream Stream) const
protectedinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.
void FrameCPP::Version_8::FrTOCAdcData::write ( Common::OStream Stream) const
protectedinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.
void FrameCPP::Version_8::FrTOCData::write ( Common::OStream Stream) const
protectedinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC , checksum_type >::Write ( ostream_type Stream) const
virtualinherited

Write object to the stream.

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

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

const int FrameCPP::Version_8::FrTOCEvent::event_type_size
staticinherited
Initial value:
= sizeof( gtimesEvent_type )
+ sizeof( gtimenEvent_type )
+ sizeof( amplitudeEvent_type )
+ sizeof( positionEvent_type )
const int FrameCPP::Version_8::FrTOCSimEvent::event_type_size
staticinherited
Initial value:
= sizeof( gtimesSim_type )
+ sizeof( gtimenSim_type )
data_quality_container_type FrameCPP::Version_8::FrTOCData::m_dataQuality
protectedinherited

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

dt_container_type FrameCPP::Version_8::FrTOCData::m_dt
protectedinherited

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

frame_container_type FrameCPP::Version_8::FrTOCData::m_frame
protectedinherited

Array of frame numbers (size of nFrame).

gtimen_container_type FrameCPP::Version_8::FrTOCData::m_GTimeN
protectedinherited

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

gtimes_container_type FrameCPP::Version_8::FrTOCData::m_GTimeS
protectedinherited

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

MapSim_type FrameCPP::Version_8::FrTOCSimData::m_info
protectedinherited
nameSimEvent_container_type FrameCPP::Version_8::FrTOCSimEvent::m_info
protectedinherited
nameEvent_container_type FrameCPP::Version_8::FrTOCEvent::m_info
protectedinherited
MapProc_type FrameCPP::Version_8::FrTOCProcData::m_info
protectedinherited
MapADC_type FrameCPP::Version_8::FrTOCAdcData::m_info
protectedinherited
stat_container_type FrameCPP::Version_8::FrTOCStatData::m_info
protectedinherited
key_container_type FrameCPP::Version_8::FrTOCSimData::m_keys
protectedinherited
key_container_type FrameCPP::Version_8::FrTOCProcData::m_keys
protectedinherited
key_container_type FrameCPP::Version_8::FrTOCAdcData::m_keys
protectedinherited
namedetector_container_type FrameCPP::Version_8::FrTOCData::m_nameDetector
protectedinherited

Array of FrDetector names.

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

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

Array of first FrADCData positions.

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

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

Array of first FrMsg positions.

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

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

Array of first FrSerData positions.

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

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

Array of first FrTable positions.

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

Note
The pointer is to the first table associated with FrRawData for each frame.
positiondetector_container_type FrameCPP::Version_8::FrTOCData::m_positionDetector
protectedinherited

Array of FrDetector positions.

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

Note
Only the first occurrence for each type of FrDetector is captured.
positionh_container_type FrameCPP::Version_8::FrTOCData::m_positionH
protectedinherited

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

position_type FrameCPP::Version_8::FrTOCAdcData::m_positions_start
inherited
runs_container_type FrameCPP::Version_8::FrTOCData::m_runs
protectedinherited

Array of run numbers.

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

shid_container_type FrameCPP::Version_8::FrTOCData::m_SHid
protectedinherited

Array of FrSH IDs.

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

shname_container_type FrameCPP::Version_8::FrTOCData::m_SHname
protectedinherited

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

uleaps_type FrameCPP::Version_8::FrTOCData::m_ULeapS
protectedinherited

From the first FrameH in the file.

const INT_4U FrameCPP::Version_8::FrTOC::NO_DATA_AVAILABLE = 0xFFFFFFFF
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: