ldas-tools-framecpp  2.6.5
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
FrameCPP::Common::FrTOC Class Referenceabstract

#include <FrTOC.hh>

Inheritance diagram for FrameCPP::Common::FrTOC:
FrameCPP::Common::FrameSpec::Object FrameCPP::Common::FrameSpec::ObjectInterface FrameCPP::Version_4::FrTOC FrameCPP::Version_6::FrTOC FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type > FrameCPP::Version_8::ObjectWithChecksum< Common::FrTOC > FrameCPP::Version_8::FrTOC

Classes

class  FunctionBase
 
class  FunctionC
 Function class used by ForEach method. More...
 
class  FunctionSI
 
class  FunctionString
 
class  PositionWithCache
 Used for TOC optimization of channel offsets. More...
 

Public Types

enum  query_info_type { TOC_CHANNEL_NAMES, TOC_DETECTOR, TOC_FR_STRUCTS }
 
typedef INT_8U cmn_position_type
 
typedef INT_4U channel_id_type
 
typedef boost::shared_ptr< FrameSpec::Objectobject_type
 
typedef std::vector< STRING< INT_2U > > cmn_name_container_type
 
typedef std::vector< REAL_8 > cmn_dt_container_type
 
typedef std::vector< INT_4U > cmn_GTimeS_container_type
 
typedef std::vector< INT_4U > cmn_GTimeN_container_type
 
typedef std::vector< INT_4S > cmn_runs_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
 

Public Member Functions

 FrTOC (const Description *Desc)
 
virtual ~FrTOC ()
 
virtual void ForEach (query_info_type Info, FunctionBase &Action) const
 
virtual void IndexObject (object_type Obj, std::streampos Position)=0
 
virtual void FrStatDataQuery (const std::string &NamePattern, const LDASTools::AL::GPSTime &StartTime, const LDASTools::AL::GPSTime &EndTime, const INT_4U Version, FrStatData::Query &Result) const =0
 
virtual INT_4U nFrame () const =0
 
virtual const cmn_dt_container_typedt () const =0
 
virtual const cmn_GTimeS_container_typeGTimeS () const =0
 
virtual const cmn_GTimeN_container_typeGTimeN () const =0
 
virtual cmn_position_type positionDetector (const std::string &Name) const =0
 Retrieve the stream position for the detector. More...
 
virtual cmn_position_type positionH (INT_4U FrameIndex) const =0
 
virtual const cmn_name_container_typenameADC () const =0
 
virtual cmn_position_type positionADC (INT_4U FrameIndex, const std::string &Channel) const =0
 
virtual cmn_position_type positionADC (INT_4U FrameIndex, channel_id_type Channel) const =0
 
virtual cmn_position_type positionEvent (INT_4U FrameIndex, const std::string &Channel) const =0
 
virtual cmn_position_type positionEvent (const std::string &EventType, INT_4U Index) const =0
 
virtual const cmn_name_container_typenameProc () const =0
 
virtual cmn_position_type positionProc (INT_4U FrameIndex, const std::string &Channel) const =0
 
virtual cmn_position_type positionProc (INT_4U FrameIndex, channel_id_type Channel) const =0
 
virtual const cmn_name_container_typenameSim () const =0
 
virtual cmn_position_type positionSim (INT_4U FrameIndex, const std::string &Channel) const =0
 
virtual const cmn_name_container_typenameSer () const =0
 
virtual cmn_position_type positionSer (INT_4U FrameIndex, const std::string &Channel) const =0
 
virtual cmn_position_type positionSimEvent (INT_4U FrameIndex, const std::string &Channel) const =0
 
virtual cmn_position_type positionSimEvent (const std::string &EventType, INT_4U Index) const =0
 
virtual cmn_runs_container_type const & runs () const =0
 
virtual INT_4U nSH () const =0
 
virtual INT_2U SHid (INT_4U Offset) const =0
 
virtual const std::string & SHname (INT_4U Offset) const =0
 
virtual void cacheAdcDataPositions (istream_type &Stream)=0
 Cache where the positions of the Adc channels. More...
 
virtual void seekAdcDataPositions (istream_type &Stream, channel_id_type Channel)=0
 Advance to the specified Adc channel. More...
 
virtual void seekAdcDataPositions (istream_type &Stream, const std::string &Channel)=0
 Advance to the specified Adc channel. More...
 
virtual void procDataCachePositions (istream_type &Stream)=0
 Cache where the positions of the FrProcData channels. 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 streamsize_type Bytes (const StreamBase &Stream) const =0
 Return the number of bytes for this object. More...
 
virtual ObjectCreate () const
 constructor - virtual More...
 
virtual ObjectCreate (istream_type &Stream) const =0
 constructor - virtual More...
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
virtual bool operator== (const Object &Obj) const =0
 comparison operator More...
 
virtual ObjectClone () const
 constructor - virtual copy constructor More...
 
virtual const char * ObjectStructName () const =0
 Retrieve the class name of the object. More...
 
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *Stream)
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 
virtual void Write (ostream_type &Stream) const =0
 Write object to the stream. More...
 

Static Public Member Functions

static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 

Static Public Attributes

static const Common::FrameSpec::Info::frame_object_types s_object_id = Common::FrameSpec::Info::FSI_FR_TOC
 

Protected Member Functions

void setAdcDataPoisitions ()
 
virtual void loadHeader (Common::IStream &Stream)=0
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 
virtual demote_ret_type demote (frame_spec_version_type Target, demote_arg_type Obj, istream_type *Stream) const =0
 Demotes object to previous version of the frame spec. More...
 
virtual promote_ret_type promote (frame_spec_version_type Target, promote_arg_type Obj, istream_type *Stream) const =0
 Promotes object to another version of the frame spec. More...
 

Friends

class IFrameStream
 

Member Typedef Documentation

◆ channel_id_type

◆ cmn_dt_container_type

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

◆ cmn_GTimeN_container_type

◆ cmn_GTimeS_container_type

◆ cmn_name_container_type

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

◆ cmn_position_type

◆ cmn_runs_container_type

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

◆ demote_arg_type

◆ demote_ret_type

◆ frame_spec_version_type

◆ object_type

◆ promote_arg_type

◆ promote_ret_type

◆ unique_object_type

Member Enumeration Documentation

◆ query_info_type

Enumerator
TOC_CHANNEL_NAMES 
TOC_DETECTOR 
TOC_FR_STRUCTS 

Constructor & Destructor Documentation

◆ FrTOC()

FrameCPP::Common::FrTOC::FrTOC ( const Description Desc)

◆ ~FrTOC()

FrameCPP::Common::FrTOC::~FrTOC ( )
virtual

Member Function Documentation

◆ Bytes()

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectInterface::Bytes ( const StreamBase Stream) const
pure virtualinherited

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.

Implemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrTable, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Version_6::FrEvent, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrTrigData, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_6::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrProcData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrSimData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_6::FrSimData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_6::FrTOC, FrameCPP::Version_7::FrameH, FrameCPP::Version_4::FrTOC, FrameCPP::Version_8::FrHeader, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_6::FrDetector, FrameCPP::Version_3::FrRawData, FrameCPP::Version_4::FrDetector, FrameCPP::Version_7::FrSerData, FrameCPP::Version_3::FrDetector, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSummary, FrameCPP::Version_3::FrSerData, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrMsg, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrMsg, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, and FrameCPP::Version_3::FrHistory.

◆ cacheAdcDataPositions()

virtual void FrameCPP::Common::FrTOC::cacheAdcDataPositions ( istream_type Stream)
pure virtual

Cache where the positions of the Adc channels.

Parameters
[in,out]StreamThe Stream being read

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

◆ Clone()

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

◆ Create() [1/3]

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

◆ Create() [2/3]

virtual Object* FrameCPP::Common::FrameSpec::ObjectInterface::Create ( istream_type Stream) const
pure virtualinherited

constructor - virtual

Implemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrTable, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Version_6::FrEvent, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrSimEvent, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrProcData, FrameCPP::Version_4::FrVect, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrSimData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_6::FrSimData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrTOC, FrameCPP::Version_7::FrameH, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrDetector, FrameCPP::Version_3::FrRawData, FrameCPP::Version_4::FrDetector, FrameCPP::Version_7::FrSerData, FrameCPP::Version_3::FrDetector, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSummary, FrameCPP::Version_3::FrSerData, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSH, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrSE, FrameCPP::Version_6::FrMsg, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, and FrameCPP::Version_3::FrHistory.

◆ Create() [3/3]

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

constructor - virtual

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

◆ demote()

virtual demote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::demote ( frame_spec_version_type  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
protectedpure virtualinherited

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.

Implemented in FrameCPP::Version_4::FrStatData, FrameCPP::Version_8::FrVect, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrEvent, FrameCPP::Version_3::FrVect, FrameCPP::Version_8::FrDetector, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_7::FrEvent, FrameCPP::Version_8::FrProcData, FrameCPP::Version_6::FrProcData, FrameCPP::Version_7::FrSimEvent, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrVect, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_4::FrVect, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrAdcData, FrameCPP::Version_8::FrSerData, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEvent, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrMsg, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTable, FrameCPP::Version_3::FrProcData, FrameCPP::Version_8::FrHistory, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_3::FrSimData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_6::FrSimData, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrDetector, FrameCPP::Version_6::FrTOC, FrameCPP::Version_8::FrEndOfFrame, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrSH, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_4::FrDetector, FrameCPP::Version_8::FrSE, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrDetector, FrameCPP::Version_7::FrSerData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSummary, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrMsg, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrSerData, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrEndOfFrame, and FrameCPP::Version_4::FrEndOfFrame.

◆ DemoteObject()

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

Down grade an object.

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

◆ dt()

virtual const cmn_dt_container_type& FrameCPP::Common::FrTOC::dt ( ) const
pure virtual

◆ ForEach()

void FrameCPP::Common::FrTOC::ForEach ( query_info_type  Info,
FunctionBase Action 
) const
virtual
Todo:
Need to decide if this functions should throw an exception when called to indicate that it is not implemented for the calling version of the frame specification.

Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_6::FrTOC, and FrameCPP::Version_4::FrTOC.

◆ FrStatDataQuery()

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

◆ GetClass()

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass()

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

Retrieve the class identifier.

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

◆ GetDescription()

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

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

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

◆ GTimeN()

virtual const cmn_GTimeN_container_type& FrameCPP::Common::FrTOC::GTimeN ( ) const
pure virtual

◆ GTimeS()

virtual const cmn_GTimeS_container_type& FrameCPP::Common::FrTOC::GTimeS ( ) const
pure virtual

◆ IndexObject()

virtual void FrameCPP::Common::FrTOC::IndexObject ( object_type  Obj,
std::streampos  Position 
)
pure virtual

◆ loadHeader()

virtual void FrameCPP::Common::FrTOC::loadHeader ( Common::IStream Stream)
protectedpure virtual

◆ nameADC()

virtual const cmn_name_container_type& FrameCPP::Common::FrTOC::nameADC ( ) const
pure virtual

◆ nameProc()

virtual const cmn_name_container_type& FrameCPP::Common::FrTOC::nameProc ( ) const
pure virtual

◆ nameSer()

virtual const cmn_name_container_type& FrameCPP::Common::FrTOC::nameSer ( ) const
pure virtual

◆ nameSim()

virtual const cmn_name_container_type& FrameCPP::Common::FrTOC::nameSim ( ) const
pure virtual

◆ nFrame()

virtual INT_4U FrameCPP::Common::FrTOC::nFrame ( ) const
pure virtual

◆ nSH()

virtual INT_4U FrameCPP::Common::FrTOC::nSH ( ) const
pure virtual

◆ ObjectStructName()

virtual const char* FrameCPP::Common::FrameSpec::ObjectInterface::ObjectStructName ( ) const
pure virtualinherited

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

Implemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrEvent, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_7::FrEvent, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_8::FrVect, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_8::FrProcData, FrameCPP::Version_3::FrVect, FrameCPP::Version_6::FrProcData, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_6::FrVect, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrAdcData, FrameCPP::Version_8::FrameH, FrameCPP::Version_4::FrVect, FrameCPP::Version_8::FrTOC, FrameCPP::Version_3::FrSimData, FrameCPP::Version_8::FrEvent, FrameCPP::Version_7::FrSimData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrDetector, FrameCPP::Version_6::FrSimData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrTOC, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrHistory, FrameCPP::Version_4::FrTOC, FrameCPP::Version_8::FrSerData, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrMsg, FrameCPP::Version_4::FrProcData, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFrame, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrDetector, FrameCPP::Version_3::FrRawData, FrameCPP::Version_4::FrDetector, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, FrameCPP::Version_3::FrHeader, FrameCPP::Version_7::FrSerData, FrameCPP::Version_3::FrDetector, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSummary, FrameCPP::Version_3::FrSerData, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_6::FrMsg, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_3::FrSummary, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, and FrameCPP::Version_3::FrHistory.

◆ operator==()

virtual bool FrameCPP::Common::FrameSpec::ObjectInterface::operator== ( const Object Obj) const
pure virtualinherited

comparison operator

Implemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrEvent, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrDetector, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrSimEvent, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_3::FrVect, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrProcData, FrameCPP::Version_8::FrEvent, FrameCPP::Version_8::FrameH, FrameCPP::Version_6::FrVect, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrMsg, FrameCPP::Version_3::FrSimData, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTOC, FrameCPP::Version_4::FrVect, FrameCPP::Version_8::FrHistory, FrameCPP::Version_7::FrSimData, FrameCPP::Version_6::FrProcData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_8::FrAdcData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_4::FrSimData, FrameCPP::Version_6::FrSimData, FrameCPP::Version_6::FrDetector, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_7::FrameH, FrameCPP::Version_4::FrTOC, FrameCPP::Version_8::FrEndOfFrame, FrameCPP::Version_8::FrSH, FrameCPP::Version_4::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_4::FrDetector, FrameCPP::Version_3::FrRawData, FrameCPP::Version_8::FrSE, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_7::FrSerData, FrameCPP::Version_3::FrDetector, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_4::FrSummary, FrameCPP::Version_6::FrMsg, FrameCPP::Version_3::FrMsg, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_3::FrSerData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSummary, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, and FrameCPP::Version_4::FrEndOfFile.

◆ positionADC() [1/2]

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

◆ positionADC() [2/2]

virtual cmn_position_type FrameCPP::Common::FrTOC::positionADC ( INT_4U  FrameIndex,
channel_id_type  Channel 
) const
pure virtual

◆ positionDetector()

virtual cmn_position_type FrameCPP::Common::FrTOC::positionDetector ( const std::string &  Name) const
pure virtual

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.

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

◆ positionEvent() [1/2]

virtual cmn_position_type FrameCPP::Common::FrTOC::positionEvent ( INT_4U  FrameIndex,
const std::string &  Channel 
) const
pure virtual

◆ positionEvent() [2/2]

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

◆ positionH()

virtual cmn_position_type FrameCPP::Common::FrTOC::positionH ( INT_4U  FrameIndex) const
pure virtual

◆ positionProc() [1/2]

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

◆ positionProc() [2/2]

virtual cmn_position_type FrameCPP::Common::FrTOC::positionProc ( INT_4U  FrameIndex,
channel_id_type  Channel 
) const
pure virtual

◆ positionSer()

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

◆ positionSim()

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

◆ positionSimEvent() [1/2]

virtual cmn_position_type FrameCPP::Common::FrTOC::positionSimEvent ( INT_4U  FrameIndex,
const std::string &  Channel 
) const
pure virtual

◆ positionSimEvent() [2/2]

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

◆ procDataCachePositions()

virtual void FrameCPP::Common::FrTOC::procDataCachePositions ( istream_type Stream)
pure virtual

Cache where the positions of the FrProcData channels.

Parameters
[in,out]StreamThe Stream being read

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

◆ promote()

virtual promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::promote ( frame_spec_version_type  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
protectedpure virtualinherited

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.

Implemented in FrameCPP::Version_4::FrStatData, FrameCPP::Version_8::FrVect, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrEvent, FrameCPP::Version_3::FrVect, FrameCPP::Version_8::FrDetector, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_8::FrProcData, FrameCPP::Version_6::FrProcData, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrSimEvent, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_6::FrVect, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_4::FrVect, FrameCPP::Version_8::FrAdcData, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_8::FrEvent, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrMsg, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrHistory, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrSimData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_6::FrSimData, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrDetector, FrameCPP::Version_8::FrEndOfFrame, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrSH, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_4::FrDetector, FrameCPP::Version_8::FrSE, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrDetector, FrameCPP::Version_7::FrSerData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSummary, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrMsg, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrSerData, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrEndOfFrame, and FrameCPP::Version_4::FrEndOfFrame.

◆ PromoteObject() [1/3]

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

Upgrade an object.

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

◆ PromoteObject() [2/3]

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

Upgrade an object.

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

◆ PromoteObject() [3/3]

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

◆ runs()

virtual cmn_runs_container_type const& FrameCPP::Common::FrTOC::runs ( ) const
pure virtual

◆ seekAdcDataPositions() [1/2]

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

Advance to the specified Adc channel.

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

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

◆ seekAdcDataPositions() [2/2]

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

Advance to the specified Adc channel.

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

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

◆ setAdcDataPoisitions()

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

◆ SHid()

virtual INT_2U FrameCPP::Common::FrTOC::SHid ( INT_4U  Offset) const
pure virtual

◆ SHname()

virtual const std::string& FrameCPP::Common::FrTOC::SHname ( INT_4U  Offset) const
pure virtual

◆ VerifyObject()

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

◆ Write()

virtual void FrameCPP::Common::FrameSpec::ObjectInterface::Write ( ostream_type Stream) const
pure virtualinherited

Write object to the stream.

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

Implemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrTable, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Version_6::FrEvent, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrSimEvent, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrProcData, FrameCPP::Version_4::FrVect, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrSimData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_4::FrSimData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_6::FrSimData, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrTOC, FrameCPP::Version_4::FrTOC, FrameCPP::Version_7::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrDetector, FrameCPP::Version_3::FrRawData, FrameCPP::Version_4::FrDetector, FrameCPP::Version_3::FrHeader, FrameCPP::Version_7::FrSerData, FrameCPP::Version_3::FrDetector, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSummary, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_3::FrSerData, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_6::FrMsg, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_3::FrSummary, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, and FrameCPP::Version_3::FrHistory.

◆ WriteNext()

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

Write a next pointer to the parent to the stream.

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

Friends And Related Function Documentation

◆ IFrameStream

friend class IFrameStream
friend

Member Data Documentation

◆ s_object_id

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

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