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

#include <FrTOC.hh>

Inheritance diagram for FrameCPP::Version_6::FrTOC:
FrameCPP::Version_6::FrTOCSimEvent FrameCPP::Version_6::FrTOCEvent FrameCPP::Version_6::FrTOCSimData FrameCPP::Version_6::FrTOCProcData FrameCPP::Version_6::FrTOCAdcData FrameCPP::Version_6::FrTOCStatData FrameCPP::Version_6::FrTOCData FrameCPP::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
 
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
LDASTools::AL::SharedPtr
< 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 INT_4U 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 INT_2S uleaps_type
 
typedef std::vector
< data_quality_type
data_quality_container_type
 
typedef std::vector< dt_typedt_container_type
 
typedef std::vector< frame_typeframe_container_type
 
typedef std::vector< gtimen_typegtimen_container_type
 
typedef std::vector< gtimes_typegtimes_container_type
 
typedef std::vector
< namedetector_type
namedetector_container_type
 
typedef std::vector
< nfirstadc_type
nfirstadc_container_type
 
typedef std::vector
< nfirstmsg_type
nfirstmsg_container_type
 
typedef std::vector
< nfirstser_type
nfirstser_container_type
 
typedef std::vector
< nfirsttable_type
nfirsttable_container_type
 
typedef std::vector
< positiondetector_type
positiondetector_container_type
 
typedef std::vector
< positionh_type
positionh_container_type
 
typedef std::vector< runs_typeruns_container_type
 
typedef std::vector< shid_typeshid_container_type
 
typedef std::vector< shname_typeshname_container_type
 
typedef STRING name_type
 
typedef INT_4U nstat_type
 
typedef STRING detector_type
 
typedef INT_4U nstat_instance_type
 
typedef INT_4U tstart_type
 
typedef INT_4U tend_type
 
typedef INT_4U version_type
 
typedef 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 INT_4U nadc_type
 
typedef STRING name_type
 
typedef INT_4U channel_id_type
 
typedef INT_4U group_id_type
 
typedef std::vector< name_typekey_container_type
 
typedef std::map< name_type,
adc_info_type
MapADC_type
 
typedef
Common::FrTOC::PositionWithCache
< STRING,
FrTOCTypes::position_type
base_type
 
typedef FrTOCTypes::n_type nproc_type
 
typedef
FrTOCTypes::position_container_type 
proc_info_type
 
typedef
FrTOCTypes::ordered_position_container_type 
MapProc_type
 
typedef INT_4U frame_count_type
 
typedef INT_4U n_type
 
typedef STRING name_type
 
typedef std::vector
< position_type
info_type
 
typedef std::map< name_type,
info_type
Map_type
 
typedef std::vector< name_typekey_container_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 INT_4U nevent_type
 
typedef STRING name_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 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 ()
 
 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
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
virtual ObjectClone () const
 constructor - virtual copy constructor More...
 
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *Stream)
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 
const data_quality_container_typeGetDataQuality () const
 
const dt_container_typeGetDt () const
 
const frame_container_typeGetFrame () const
 
const gtimes_container_typeGetGTimeN () const
 
const gtimen_container_typeGetGTimeS () const
 
const nfirstadc_container_typeGetNFirstADC () const
 
const nfirstmsg_container_typeGetNFirstMsg () const
 
const nfirstser_container_typeGetNFirstSer () const
 
const nfirsttable_container_typeGetNFirstTable () const
 
nframe_type GetNFrame () const
 
const positionh_container_typeGetPositionH () const
 
const runs_container_typeGetRuns () const
 
const shid_container_typeGetSHid () const
 
const shname_container_typeGetSHname () const
 
uleaps_type GetULeapS () const
 
const namedetector_container_typeGetNameDetector () const
 
const
positiondetector_container_type
GetPositionDetector () const
 
bool operator== (const FrTOCData &RHS) const
 
const stat_container_typeGetStat () const
 
bool operator== (const FrTOCStatData &RHS) const
 
void QueryStatData (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
const MapADC_typeGetADC () const
 
MapADC_type::const_iterator GetADC (const std::string &Name) const
 
MapADC_type::const_iterator GetADC (INT_4U index) const
 
const key_container_typeGetKeys () const
 Retrieve the keys. More...
 
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
 
void QueryProc (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
bool operator== (const FrTOCProcData &RHS) const
 
const key_container_typeGetPositionKeys () const
 
const MapSim_typeGetSim () const
 
MapSim_type::const_iterator GetSim (const std::string &Name) const
 
MapSim_type::const_iterator GetSim (INT_4U index) const
 
void QuerySim (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
bool operator== (const FrTOCSimData &RHS) const
 
const nameEvent_container_typeGetEvent () const
 
void QueryEvent (const Common::TOCInfo &Info, INT_4U FrameOffset, INT_8U Position)
 
bool operator== (const FrTOCEvent &RHS) const
 
const nameSimEvent_container_typeGetSimEvent () const
 
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 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)
 
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_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 &EventType, 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
 
void write (Common::OStream &Stream) const
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void cachePositions (istream_type &Stream)
 
void seekPositions (istream_type &Stream, channel_id_type Channel)
 
void seekPositions (istream_type &Stream, const std::string &Channel)
 
void write (Common::OStream &Stream) const
 
bool operator== (const PositionWithCache &RHS) const
 
void forEach (Common::FrTOC::query_info_type Info, Common::FrTOC::FunctionBase &Action) const
 Iterate over contents. More...
 
void write (Common::OStream &Stream) const
 
const Map_typegetInfo () const
 
Map_type::const_iterator getInfo (const std::string &Name) const
 
Map_type::const_iterator getInfo (INT_4U Index) const
 
void cachePositions (istream_type &Stream)
 TOC optimization. More...
 
void setPositionsOffset (istream_type &Stream)
 
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
 
Map_type m_info
 
key_container_type m_keys
 
MapSim_type m_info
 
nameEvent_container_type m_info
 
nameSimEvent_container_type m_info
 

Member Typedef Documentation

typedef INT_4U FrameCPP::Common::FrTOC::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
typedef REAL_8 FrameCPP::Version_6::FrTOCData::dt_type
inherited
typedef std::vector< name_type > FrameCPP::Version_6::FrTOCSimData::key_container_type
protectedinherited
typedef INT_4U FrameCPP::Version_6::FrTOCData::nsh_type
inherited
typedef LDASTools::AL::SharedPtr< FrameSpec::Object > FrameCPP::Common::FrTOC::object_type
inherited

Member Enumeration Documentation

Enumerator
TOC_CHANNEL_NAMES 
TOC_DETECTOR 
TOC_FR_STRUCTS 

Constructor & Destructor Documentation

FrameCPP::Version_6::FrTOC::FrTOC ( )
FrameCPP::Version_6::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_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.

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.

void FrameCPP::Version_6::FrTOCAdcData::cachePositions ( istream_type Stream)
inlineprotectedinherited
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.

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

constructor - virtual

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

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

constructor - virtual

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

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

constructor - virtual

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

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.

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_6::FrTOCProcData::Description ( Common::Description Desc)
staticinherited
template<typename SE >
void FrameCPP::Version_6::FrTOCSimData::Description ( Common::Description Desc)
staticinherited
template<typename SE >
void FrameCPP::Version_6::FrTOCStatData::Description ( Common::Description Desc)
staticinherited
template<typename SE >
void FrameCPP::Version_6::FrTOCSimEvent::Description ( Common::Description Desc)
staticinherited
template<typename SE >
void FrameCPP::Version_6::FrTOCEvent::Description ( Common::Description Desc)
staticinherited
template<typename SE >
void FrameCPP::Version_6::FrTOCData::Description ( Common::Description Desc)
staticinherited
template<typename SE >
void FrameCPP::Version_6::FrTOCAdcData::Description ( Common::Description Desc)
staticinherited
const FrTOC::cmn_dt_container_type & FrameCPP::Version_6::FrTOC::dt ( ) const
protectedvirtual
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.

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.

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.

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.

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.

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
const FrTOCAdcData::MapADC_type & FrameCPP::Version_6::FrTOCAdcData::GetADC ( ) const
inlineinherited
FrTOCAdcData::MapADC_type::const_iterator FrameCPP::Version_6::FrTOCAdcData::GetADC ( const std::string &  Name) const
inherited
FrTOCAdcData::MapADC_type::const_iterator FrameCPP::Version_6::FrTOCAdcData::GetADC ( INT_4U  index) const
inherited
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_6::FrTOCData::GetDataQuality ( ) const
inlineinherited
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_6::FrTOCData::GetDt ( ) const
inlineinherited
const FrTOCEvent::nameEvent_container_type & FrameCPP::Version_6::FrTOCEvent::GetEvent ( ) const
inlineinherited
const FrTOCData::frame_container_type & FrameCPP::Version_6::FrTOCData::GetFrame ( ) const
inlineinherited
const FrTOCData::gtimen_container_type & FrameCPP::Version_6::FrTOCData::GetGTimeN ( ) const
inlineinherited
const FrTOCData::gtimes_container_type & FrameCPP::Version_6::FrTOCData::GetGTimeS ( ) const
inlineinherited
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_6::FrTOCProcData::GetKeys ( ) const
inlineinherited
const FrTOCAdcData::key_container_type & FrameCPP::Version_6::FrTOCAdcData::GetKeys ( ) const
inlineinherited

Retrieve the keys.

Returns
Constant container of keys.
const FrTOCData::namedetector_container_type & FrameCPP::Version_6::FrTOCData::GetNameDetector ( ) const
inlineinherited
const FrTOCData::nfirstadc_container_type & FrameCPP::Version_6::FrTOCData::GetNFirstADC ( ) const
inlineinherited
const FrTOCData::nfirstmsg_container_type & FrameCPP::Version_6::FrTOCData::GetNFirstMsg ( ) const
inlineinherited
const FrTOCData::nfirstser_container_type & FrameCPP::Version_6::FrTOCData::GetNFirstSer ( ) const
inlineinherited
const FrTOCData::nfirsttable_container_type & FrameCPP::Version_6::FrTOCData::GetNFirstTable ( ) const
inlineinherited
FrTOCData::nframe_type FrameCPP::Version_6::FrTOCData::GetNFrame ( ) const
inlineinherited
const FrTOCData::positiondetector_container_type & FrameCPP::Version_6::FrTOCData::GetPositionDetector ( ) const
inlineinherited
const FrTOCData::positionh_container_type & FrameCPP::Version_6::FrTOCData::GetPositionH ( ) const
inlineinherited
const FrTOCProcData::MapProc_type & FrameCPP::Version_6::FrTOCProcData::GetProc ( ) const
inlineinherited
FrTOCProcData::MapProc_type::const_iterator FrameCPP::Version_6::FrTOCProcData::GetProc ( const std::string &  Name) const
inherited
FrTOCProcData::MapProc_type::const_iterator FrameCPP::Version_6::FrTOCProcData::GetProc ( INT_4U  index) const
inherited
const FrTOCData::runs_container_type & FrameCPP::Version_6::FrTOCData::GetRuns ( ) const
inlineinherited
const FrTOCData::shid_container_type & FrameCPP::Version_6::FrTOCData::GetSHid ( ) const
inlineinherited
const FrTOCData::shname_container_type & FrameCPP::Version_6::FrTOCData::GetSHname ( ) const
inlineinherited
const FrTOCSimData::MapSim_type & FrameCPP::Version_6::FrTOCSimData::GetSim ( ) const
inlineinherited
FrTOCSimData::MapSim_type::const_iterator FrameCPP::Version_6::FrTOCSimData::GetSim ( const std::string &  Name) const
inherited
FrTOCSimData::MapSim_type::const_iterator FrameCPP::Version_6::FrTOCSimData::GetSim ( INT_4U  index) const
inherited
const FrTOCSimEvent::nameSimEvent_container_type & FrameCPP::Version_6::FrTOCSimEvent::GetSimEvent ( ) const
inlineinherited
const FrTOCStatData::stat_container_type & FrameCPP::Version_6::FrTOCStatData::GetStat ( ) const
inlineinherited
const FrTOC::MapStatType_type & FrameCPP::Version_6::FrTOC::GetStatType ( ) const
inline
FrTOCData::uleaps_type FrameCPP::Version_6::FrTOCData::GetULeapS ( ) const
inlineinherited
const FrTOC::cmn_GTimeN_container_type & FrameCPP::Version_6::FrTOC::GTimeN ( ) const
protectedvirtual
const FrTOC::cmn_GTimeS_container_type & FrameCPP::Version_6::FrTOC::GTimeS ( ) const
protectedvirtual
void FrameCPP::Version_6::FrTOC::IndexObject ( object_type  Object,
std::streampos  Position 
)
virtual
const FrTOC::cmn_name_container_type & FrameCPP::Version_6::FrTOC::nameADC ( ) const
protectedvirtual
const FrTOC::cmn_name_container_type & FrameCPP::Version_6::FrTOC::nameProc ( ) const
protectedvirtual
const FrTOC::cmn_name_container_type & FrameCPP::Version_6::FrTOC::nameSer ( ) const
protectedvirtual
const FrTOC::cmn_name_container_type & FrameCPP::Version_6::FrTOC::nameSim ( ) const
protectedvirtual
INT_4U FrameCPP::Version_6::FrTOC::nFrame ( ) const
protectedvirtual
INT_4U FrameCPP::Version_6::FrTOC::nSH ( ) const
protectedvirtual
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.

bool FrameCPP::Version_6::FrTOCSimData::operator== ( const FrTOCSimData RHS) const
inherited
bool FrameCPP::Version_6::FrTOCStatData::operator== ( const FrTOCStatData RHS) const
inherited
bool FrameCPP::Version_6::FrTOCProcData::operator== ( const FrTOCProcData RHS) const
inherited
bool FrameCPP::Version_6::FrTOCSimEvent::operator== ( const FrTOCSimEvent RHS) const
inherited
bool FrameCPP::Version_6::FrTOCEvent::operator== ( const FrTOCEvent RHS) const
inherited
bool FrameCPP::Version_6::FrTOCData::operator== ( const FrTOCData RHS) const
inlineinherited
bool FrameCPP::Version_6::FrTOCAdcData::operator== ( const FrTOCAdcData RHS) const
inherited
bool FrameCPP::Version_6::FrTOC::operator== ( const Common::FrameSpec::Object Obj) const
virtual

comparison operator

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

bool FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCTypes::position_type >::operator== ( const PositionWithCache< STRING, FrTOCTypes::position_type > &  RHS) const
inlineprotectedinherited
FrTOC::cmn_position_type FrameCPP::Version_6::FrTOC::positionADC ( INT_4U  FrameIndex,
const std::string &  Channel 
) const
protectedvirtual
FrTOC::cmn_position_type FrameCPP::Version_6::FrTOC::positionADC ( INT_4U  FrameIndex,
INT_4U  Channel 
) const
protectedvirtual
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.

FrTOC::cmn_position_type FrameCPP::Version_6::FrTOC::positionEvent ( INT_4U  FrameIndex,
const std::string &  Event 
) const
protectedvirtual
FrTOC::cmn_position_type FrameCPP::Version_6::FrTOC::positionEvent ( const std::string &  EventType,
INT_4U  Index 
) const
protectedvirtual
FrTOC::cmn_position_type FrameCPP::Version_6::FrTOC::positionH ( INT_4U  FrameIndex) const
protectedvirtual
FrTOC::cmn_position_type FrameCPP::Version_6::FrTOC::positionProc ( INT_4U  FrameIndex,
const std::string &  Channel 
) const
protectedvirtual
FrTOC::cmn_position_type FrameCPP::Version_6::FrTOC::positionProc ( INT_4U  FrameIndex,
INT_4U  Channel 
) const
protectedvirtual
FrTOC::cmn_position_type FrameCPP::Version_6::FrTOC::positionSer ( INT_4U  FrameIndex,
const std::string &  Channel 
) const
protectedvirtual
FrTOC::cmn_position_type FrameCPP::Version_6::FrTOC::positionSim ( INT_4U  FrameIndex,
const std::string &  Channel 
) const
protectedvirtual
FrTOC::cmn_position_type FrameCPP::Version_6::FrTOC::positionSimEvent ( INT_4U  FrameIndex,
const std::string &  SimEvent 
) const
protectedvirtual
FrTOC::cmn_position_type FrameCPP::Version_6::FrTOC::positionSimEvent ( const std::string &  EventType,
INT_4U  Index 
) const
protectedvirtual
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.

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.

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_6::FrTOCAdcData::QueryAdc ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited
void FrameCPP::Version_6::FrTOCEvent::QueryEvent ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited
void FrameCPP::Version_6::FrTOCProcData::QueryProc ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited
void FrameCPP::Version_6::FrTOCSimData::QuerySim ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited
void FrameCPP::Version_6::FrTOCSimEvent::QuerySimEvent ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited
void FrameCPP::Version_6::FrTOCStatData::QueryStatData ( const Common::TOCInfo Info,
INT_4U  FrameOffset,
INT_8U  Position 
)
inherited
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

Implements FrameCPP::Common::FrTOC.

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.

void FrameCPP::Version_6::FrTOCAdcData::seekPositions ( istream_type Stream,
channel_id_type  Channel 
)
inlineprotectedinherited
void FrameCPP::Version_6::FrTOCAdcData::seekPositions ( istream_type Stream,
const std::string &  Channel 
)
inlineprotectedinherited
void FrameCPP::Common::FrTOC::setAdcDataPoisitions ( )
protectedinherited
void FrameCPP::Common::FrTOC::PositionWithCache< STRING , FrTOCTypes::position_type >::setPositionsOffset ( istream_type Stream)
inlineprotectedinherited
INT_2U FrameCPP::Version_6::FrTOC::SHid ( INT_4U  Offset) const
protectedvirtual
const std::string & FrameCPP::Version_6::FrTOC::SHname ( INT_4U  Offset) const
protectedvirtual
const Common::Description * FrameCPP::Version_6::FrTOC::StructDescription ( )
static
const char * FrameCPP::Version_6::FrTOC::StructName ( )
inlinestatic
void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited
void FrameCPP::Version_6::FrTOCStatData::write ( Common::OStream Stream) const
protectedinherited
void FrameCPP::Version_6::FrTOCSimData::write ( Common::OStream Stream) const
protectedinherited
void FrameCPP::Version_6::FrTOCProcData::write ( Common::OStream Stream) const
inlineprotectedinherited
void FrameCPP::Version_6::FrTOCSimEvent::write ( Common::OStream Stream) const
protectedinherited
void FrameCPP::Version_6::FrTOCEvent::write ( Common::OStream Stream) const
protectedinherited
void FrameCPP::Version_6::FrTOCData::write ( Common::OStream Stream) const
protectedinherited
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.

void FrameCPP::Version_6::FrTOCAdcData::write ( Common::OStream Stream) const
protectedinherited
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_6::FrTOCEvent::event_type_size
staticinherited
Initial value:
= sizeof( gtimesEvent_type )
+ sizeof( gtimenEvent_type )
+ sizeof( amplitudeEvent_type )
+ sizeof( positionEvent_type )
const int FrameCPP::Version_6::FrTOCSimEvent::event_type_size
staticinherited
Initial value:
= sizeof( gtimesSim_type )
+ sizeof( gtimenSim_type )
data_quality_container_type FrameCPP::Version_6::FrTOCData::m_dataQuality
protectedinherited
dt_container_type FrameCPP::Version_6::FrTOCData::m_dt
protectedinherited
frame_container_type FrameCPP::Version_6::FrTOCData::m_frame
protectedinherited
gtimen_container_type FrameCPP::Version_6::FrTOCData::m_GTimeN
protectedinherited
gtimes_container_type FrameCPP::Version_6::FrTOCData::m_GTimeS
protectedinherited
MapSim_type FrameCPP::Version_6::FrTOCSimData::m_info
protectedinherited
stat_container_type FrameCPP::Version_6::FrTOCStatData::m_info
protectedinherited
nameSimEvent_container_type FrameCPP::Version_6::FrTOCSimEvent::m_info
protectedinherited
nameEvent_container_type FrameCPP::Version_6::FrTOCEvent::m_info
protectedinherited
MapADC_type FrameCPP::Version_6::FrTOCAdcData::m_info
protectedinherited
key_container_type FrameCPP::Version_6::FrTOCSimData::m_keys
protectedinherited
key_container_type FrameCPP::Version_6::FrTOCAdcData::m_keys
protectedinherited
namedetector_container_type FrameCPP::Version_6::FrTOCData::m_nameDetector
protectedinherited
nfirstadc_container_type FrameCPP::Version_6::FrTOCData::m_nFirstADC
protectedinherited
nfirstmsg_container_type FrameCPP::Version_6::FrTOCData::m_nFirstMsg
protectedinherited
nfirstser_container_type FrameCPP::Version_6::FrTOCData::m_nFirstSer
protectedinherited
nfirsttable_container_type FrameCPP::Version_6::FrTOCData::m_nFirstTable
protectedinherited
positiondetector_container_type FrameCPP::Version_6::FrTOCData::m_positionDetector
protectedinherited
positionh_container_type FrameCPP::Version_6::FrTOCData::m_positionH
protectedinherited
position_type FrameCPP::Version_6::FrTOCAdcData::m_positions_start
protectedinherited
runs_container_type FrameCPP::Version_6::FrTOCData::m_runs
protectedinherited
shid_container_type FrameCPP::Version_6::FrTOCData::m_SHid
protectedinherited
shname_container_type FrameCPP::Version_6::FrTOCData::m_SHname
protectedinherited
uleaps_type FrameCPP::Version_6::FrTOCData::m_ULeapS
protectedinherited
const INT_4U FrameCPP::Version_6::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: