ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_9::FrEndOfFrame Class Referenceabstract

End of Frame data structure. More...

#include <FrEndOfFrame.hh>

Inheritance diagram for FrameCPP::Version_9::FrEndOfFrame:
Collaboration diagram for FrameCPP::Version_9::FrEndOfFrame:

Public Types

typedef ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > self_type
 
typedef IStream istream_type
 
typedef OStream ostream_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 stream_base_type demote_stream_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef stream_base_type promote_stream_type
 
typedef INT_4S run_type
 Run number.
 
typedef INT_4U frame_type
 Frame number.
 
typedef INT_4U GTimeS_type
 Frame start time in GPS seconds.
 
typedef INT_4U GTimeN_type
 Frame start time residual.
 
typedef GPSTime GTime_type
 Frmae start time in GPS units.
 
typedef INT_4U v5_chkType_type
 File checksum.
 
typedef INT_4U v5_chkSum_type
 File checksum.
 

Public Member Functions

 FrEndOfFrame ()
 Default constructor.
 
 FrEndOfFrame (run_type Run, frame_type Frame)
 Constructor.
 
virtual ~FrEndOfFrame ()
 Desctructor.
 
bool operator== (const FrEndOfFrame &RHS) const
 equality operator
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type
 
 FrEndOfFrame ()
 Default constructor.
 
 FrEndOfFrame (run_type Run, frame_type Frame)
 Constructor.
 
virtual ~FrEndOfFrame ()
 Desctructor.
 
bool operator== (const FrEndOfFrame &RHS) const
 equality operator
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
virtual const Common::DescriptionGetDescription (ostream_type &Stream) const
 
virtual const Common::DescriptionGetDescription (ostream_type &Stream) const
 
virtual const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
class_type GetClass () const
 Retrieve the class identifier.
 
class_type GetClass () const
 Retrieve the class identifier.
 
frame_spec_version_type FrameSpecVersion () const
 
frame_spec_version_type FrameSpecVersion () const
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
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, promote_stream_type *Stream)
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 
run_type GetRun () const
 Run number of the frame.
 
frame_type GetFrame () const
 frame number
 
const GTime_typeGetGTime () const
 Get the GPS start time of this frame.
 

Static Public Member Functions

static const Common::DescriptionStructDescription ()
 The description of structure.
 
static const Common::DescriptionStructDescription ()
 The description of structure.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
 Down grade an object.
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
 Down grade an object.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 

Static Public Attributes

static run_type constexpr DEFAULT_RUN
 Default run number.
 
static frame_type constexpr DEFAULT_FRAME
 Default frame number.
 
static GTimeS_type constexpr DEFAULT_GTIME_S
 Default start time in GPS seconds.
 
static GTimeN_type constexpr DEFAULT_GTIME_N
 Default start time residual.
 

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual demote_ret_type demote (frame_spec_version_type Target, demote_arg_type Obj, demote_stream_type *Stream) const =0
 Demotes object to previous version of the frame spec.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Promotes object to another version of the frame spec.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Promotes object to another version of the frame spec.
 
virtual promote_ret_type promote (frame_spec_version_type Target, promote_arg_type Obj, promote_stream_type *Stream) const =0
 Promotes object to another version of the frame spec.
 
virtual cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream.
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 

Protected Attributes

run_type run
 
frame_type frame
 
GTime_type GTime
 Frame start time in GPS seconds.
 

Private Types

typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > object_base_type
 

Private Member Functions

virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
void load (Archive &archiver, const unsigned int version)
 
void load (Archive &archiver, const unsigned int version)
 
void save (Archive &archiver, const unsigned int version) const
 
void save (Archive &archiver, const unsigned int version) const
 

Private Attributes

checksum_type m_chkSum
 Structure checksum.
 
const class_type m_class
 Storage for the class identifier.
 
const Description *const m_desc
 Description for parent class.
 
const frame_spec_version_type frame_spec_version
 Version of the frame specification.
 

Detailed Description

End of Frame data structure.

Member Typedef Documentation

◆ demote_arg_type

◆ demote_ret_type

◆ demote_stream_type

◆ frame_spec_version_type

◆ frame_type

Frame number.

◆ GTime_type

Frmae start time in GPS units.

◆ GTimeN_type

Frame start time residual.

◆ GTimeS_type

Frame start time in GPS seconds.

◆ istream_type

typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::istream_type
inherited

◆ object_base_type

◆ object_type

◆ ostream_type

typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::ostream_type
inherited

◆ promote_arg_type

◆ promote_ret_type

◆ promote_stream_type

◆ run_type

Run number.

◆ self_type

◆ unique_object_type

◆ v5_chkSum_type

File checksum.

◆ v5_chkType_type

File checksum.

Constructor & Destructor Documentation

◆ FrEndOfFrame() [1/4]

FrameCPP::Version_9::FrEndOfFrame::FrEndOfFrame ( )

Default constructor.

◆ FrEndOfFrame() [2/4]

FrameCPP::Version_9::FrEndOfFrame::FrEndOfFrame ( run_type Run,
frame_type Frame )

Constructor.

◆ ~FrEndOfFrame() [1/2]

virtual FrameCPP::Version_9::FrEndOfFrame::~FrEndOfFrame ( )
virtual

Desctructor.

◆ FrEndOfFrame() [3/4]

FrameCPP::Version_9::FrEndOfFrame::FrEndOfFrame ( )

Default constructor.

◆ FrEndOfFrame() [4/4]

FrameCPP::Version_9::FrEndOfFrame::FrEndOfFrame ( run_type Run,
frame_type Frame )

Constructor.

◆ ~FrEndOfFrame() [2/2]

virtual FrameCPP::Version_9::FrEndOfFrame::~FrEndOfFrame ( )
virtual

Desctructor.

Member Function Documentation

◆ Bytes() [1/2]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, 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.

◆ Bytes() [2/2]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, 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.

◆ CheckSumDataClass() [1/2]

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

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

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

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/2]

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

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

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

Comment to be used in comment field of FrSE.

◆ Clone() [1/2]

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

constructor - virtual copy constructor

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

◆ Clone() [2/2]

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

constructor - virtual copy constructor

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

◆ Create() [1/6]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [2/6]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [3/6]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, 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.

◆ Create() [4/6]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, 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.

◆ Create() [5/6]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

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

◆ Create() [6/6]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

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

◆ demote() [1/3]

virtual demote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::demote ( frame_spec_version_type Target,
demote_arg_type Obj,
demote_stream_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::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrDetector, FrameCPP::Version_3::FrDetector, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSimData, FrameCPP::Version_3::FrSimData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrDetector, FrameCPP::Version_4::FrDetector, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrSummary, FrameCPP::Version_4::FrSummary, FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrDetector, FrameCPP::Version_6::FrDetector, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrEvent, FrameCPP::Version_6::FrEvent, FrameCPP::Version_6::FrMsg, FrameCPP::Version_6::FrMsg, FrameCPP::Version_6::FrProcData, FrameCPP::Version_6::FrProcData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSimData, FrameCPP::Version_6::FrSimData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_6::FrSummary, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_7::FrSerData, FrameCPP::Version_7::FrSerData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_8::FrameHImpl::ClassicIO< T >, FrameCPP::Version_8::FrameHImpl::ClassicIO< T >, FrameCPP::Version_8::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_8::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_8::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_8::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_8::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_8::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEventImpl::ClassicIO< T >, FrameCPP::Version_8::FrEventImpl::ClassicIO< T >, FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_8::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_8::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_8::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_8::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_8::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_8::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_8::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_8::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_8::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_8::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >, and FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >.

◆ demote() [2/3]

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

Demotes object to previous version of the frame spec.

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

◆ demote() [3/3]

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

Demotes object to previous version of the frame spec.

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

◆ DemoteObject() [1/2]

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

Down grade an object.

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

◆ DemoteObject() [2/2]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type Target,
object_type Obj,
demote_stream_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.

◆ FrameSpecVersion() [1/2]

FrameSpec::Object::frame_spec_version_type FrameCPP::Common::FrameSpec::Object::FrameSpecVersion ( ) const
inlineinherited

◆ FrameSpecVersion() [2/2]

frame_spec_version_type FrameCPP::Common::FrameSpec::Object::FrameSpecVersion ( ) const
inherited

◆ GetClass() [1/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ GetClass() [2/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [1/2]

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

Retrieve the class identifier.

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

◆ getClass() [2/2]

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

Retrieve the class identifier.

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

◆ GetDescription() [1/3]

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

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

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

◆ GetDescription() [2/3]

virtual const Common::Description * FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >::GetDescription ( ostream_type & Stream) const
inlinevirtualinherited

◆ GetDescription() [3/3]

virtual const Common::Description * FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >::GetDescription ( ostream_type & Stream) const
inlinevirtualinherited

◆ GetFrame()

frame_type FrameCPP::Version_9::FrEndOfFrameImpl::Data::GetFrame ( ) const
inlineinherited

frame number

Returns
The frame number. It is the same as the value in the FrameH frame datum.

◆ GetGTime()

const GTime_type & FrameCPP::Version_9::FrEndOfFrameImpl::Data::GetGTime ( ) const
inlineinherited

Get the GPS start time of this frame.

Returns
The start time of the frame.

◆ GetRun()

run_type FrameCPP::Version_9::FrEndOfFrameImpl::Data::GetRun ( ) const
inlineinherited

Run number of the frame.

Returns
The run number of frame. It is the same as the value in the FrameH run datum.

◆ load() [1/2]

void FrameCPP::Version_9::FrEndOfFrameImpl::SerialIO< FrEndOfFrame >::load ( Archive & archiver,
const unsigned int version )
inlineprivateinherited

◆ load() [2/2]

void FrameCPP::Version_9::FrEndOfFrameImpl::SerialIO< FrEndOfFrame >::load ( Archive & archiver,
const unsigned int version )
inlineprivateinherited

◆ ObjectStructName() [1/2]

virtual const char * FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

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

◆ ObjectStructName() [2/2]

virtual const char * FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

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

◆ operator==() [1/4]

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

equality operator for abstract data type

Parameters
[in]RHSThe 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.

◆ operator==() [2/4]

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

equality operator for abstract data type

Parameters
[in]RHSThe 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.

◆ operator==() [3/4]

bool FrameCPP::Version_9::FrEndOfFrame::operator== ( const FrEndOfFrame & RHS) const

equality operator

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

◆ operator==() [4/4]

bool FrameCPP::Version_9::FrEndOfFrame::operator== ( const FrEndOfFrame & RHS) const

equality operator

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

◆ pBytes() [1/2]

virtual cmn_streamsize_type FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtualinherited

Number of bytes needed to write this structure.

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

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

◆ pBytes() [2/2]

virtual cmn_streamsize_type FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtualinherited

Number of bytes needed to write this structure.

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

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

◆ pCreate() [1/2]

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

Virtual constructor.

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

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

◆ pCreate() [2/2]

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

Virtual constructor.

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

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

◆ promote() [1/3]

virtual promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::promote ( frame_spec_version_type Target,
promote_arg_type Obj,
promote_stream_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::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrDetector, FrameCPP::Version_3::FrDetector, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSimData, FrameCPP::Version_3::FrSimData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrDetector, FrameCPP::Version_4::FrDetector, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrSummary, FrameCPP::Version_4::FrSummary, FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrDetector, FrameCPP::Version_6::FrDetector, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrEvent, FrameCPP::Version_6::FrEvent, FrameCPP::Version_6::FrMsg, FrameCPP::Version_6::FrMsg, FrameCPP::Version_6::FrProcData, FrameCPP::Version_6::FrProcData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSimData, FrameCPP::Version_6::FrSimData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_6::FrSummary, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_7::FrSerData, FrameCPP::Version_7::FrSerData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_8::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_8::FrameHImpl::ClassicIO< T >, FrameCPP::Version_8::FrameHImpl::ClassicIO< T >, FrameCPP::Version_8::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_8::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_8::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_8::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_8::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_8::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEventImpl::ClassicIO< T >, FrameCPP::Version_8::FrEventImpl::ClassicIO< T >, FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_8::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_8::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_8::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_8::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_8::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_8::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_8::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_8::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_8::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_8::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >, and FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >.

◆ promote() [2/3]

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

Promotes object to another version of the frame spec.

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

◆ promote() [3/3]

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

Promotes object to another version of the frame spec.

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

◆ PromoteObject() [1/5]

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

Upgrade an object.

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

◆ PromoteObject() [2/5]

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,
stream_base_type * Stream )
staticinherited

Upgrade an object.

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

◆ PromoteObject() [3/5]

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

Upgrade an object.

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

◆ PromoteObject() [4/5]

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

Upgrade an object.

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

◆ PromoteObject() [5/5]

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

◆ pWrite() [1/2]

virtual void FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

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

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

◆ pWrite() [2/2]

virtual void FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

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

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

◆ save() [1/2]

void FrameCPP::Version_9::FrEndOfFrameImpl::SerialIO< FrEndOfFrame >::save ( Archive & archiver,
const unsigned int version ) const
inlineprivateinherited

◆ save() [2/2]

void FrameCPP::Version_9::FrEndOfFrameImpl::SerialIO< FrEndOfFrame >::save ( Archive & archiver,
const unsigned int version ) const
inlineprivateinherited

◆ StructDescription() [1/2]

static const Common::Description * FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ StructDescription() [2/2]

static const Common::Description * FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ VerifyObject() [1/2]

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

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.

◆ VerifyObject() [2/2]

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

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.

◆ Write() [1/2]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

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

◆ Write() [2/2]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

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

◆ WriteNext() [1/2]

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

Write a next pointer to the parent to the stream.

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

◆ WriteNext() [2/2]

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

Write a next pointer to the parent to the stream.

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

Member Data Documentation

◆ DEFAULT_FRAME

static frame_type constexpr FrameCPP::Version_9::FrEndOfFrameImpl::Data::DEFAULT_FRAME
staticconstexprinherited
Initial value:
{
0
}

Default frame number.

◆ DEFAULT_GTIME_N

static GTimeN_type constexpr FrameCPP::Version_9::FrEndOfFrameImpl::Data::DEFAULT_GTIME_N
staticconstexprinherited
Initial value:
{
0
}

Default start time residual.

◆ DEFAULT_GTIME_S

static GTimeS_type constexpr FrameCPP::Version_9::FrEndOfFrameImpl::Data::DEFAULT_GTIME_S
staticconstexprinherited
Initial value:
{
0
}

Default start time in GPS seconds.

◆ DEFAULT_RUN

static run_type constexpr FrameCPP::Version_9::FrEndOfFrameImpl::Data::DEFAULT_RUN
staticconstexprinherited
Initial value:
{
0
}

Default run number.

◆ frame

frame_type FrameCPP::Version_9::FrEndOfFrameImpl::Data::frame
protectedinherited

Frame number, monotonically increasing until end of run; This is the same as the FrameH::frame number datum.

◆ frame_spec_version

const frame_spec_version_type FrameCPP::Common::FrameSpec::Object::frame_spec_version
privateinherited

Version of the frame specification.

The version of the frame specification for which this object was created.

◆ GTime

GTime_type FrameCPP::Version_9::FrEndOfFrameImpl::Data::GTime
protectedinherited

Frame start time in GPS seconds.

◆ m_chkSum

checksum_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::m_chkSum
privateinherited

Structure checksum.

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

◆ m_class

const class_type FrameCPP::Common::FrameSpec::Object::m_class
privateinherited

Storage for the class identifier.

The class identifier uniquely identifies the parent class within the frame specification. All instances of parent class will have the same class identifier.

◆ m_desc

const Description *const FrameCPP::Common::FrameSpec::Object::m_desc
privateinherited

Description for parent class.

The description for the parent class composed of one FrSH and one or more FrSE elements.

◆ run

run_type FrameCPP::Version_9::FrEndOfFrameImpl::Data::run
protectedinherited

Run number. This is the same as the FrameH::rum member


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