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

Table Data Structure Definition. More...

#include <FrTable.hh>

Inheritance diagram for FrameCPP::Version_9::FrTable:
Collaboration diagram for FrameCPP::Version_9::FrTable:

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 std::string name_type
 
typedef std::string comment_type
 
typedef INT_2U nColumn_type
 
typedef INT_4U nRow_type
 

Public Member Functions

 FrTable ()
 Default constructor.
 
 FrTable (const FrTable &Source)
 Copy Constructor.
 
 FrTable (const name_type &name, nRow_type nrows)
 Constructor.
 
 FrTable (Previous::FrTable &Source, stream_base_type *Stream)
 Promotion Constructor.
 
virtual ~FrTable ()
 Destructor.
 
const name_typeGetNameSlow () const
 Retrieve the name of the table.
 
FrTableMerge (const FrTable &RHS)
 Merge with another FrTable.
 
FrTableoperator+= (const FrTable &RHS)
 Concatinate with another FrTable.
 
bool operator== (const FrTable &RHS) const
 equality operator
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type
 
 FrTable ()
 Default constructor.
 
 FrTable (const FrTable &Source)
 Copy Constructor.
 
 FrTable (const name_type &name, nRow_type nrows)
 Constructor.
 
 FrTable (Previous::FrTable &Source, stream_base_type *Stream)
 Promotion Constructor.
 
virtual ~FrTable ()
 Destructor.
 
const name_typeGetNameSlow () const
 Retrieve the name of the table.
 
FrTableMerge (const FrTable &RHS)
 Merge with another FrTable.
 
FrTableoperator+= (const FrTable &RHS)
 Concatinate with another FrTable.
 
bool operator== (const FrTable &RHS) const
 equality operator
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type
 
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.
 

Static Public Member Functions

static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 Promote previous version of object to this version.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 Promote previous version of object to this version.
 
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.
 

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 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
 The data structure description.
 
virtual const Common::DescriptionGetDescription (ostream_type &Stream) const
 The data structure description.
 
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 (Common::IStream &Stream) const
 Virtual constructor.
 
virtual self_typepCreate (Common::IStream &Stream) const
 Virtual constructor.
 
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 void pWrite (Common::OStream &Stream) const
 Write the structure to the stream.
 
virtual void pWrite (Common::OStream &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.
 

Private Types

typedef STRING io_name_type
 
typedef STRING io_comment_type
 
typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 Object with checksum data.
 
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
 

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

Table Data Structure Definition.

Member Typedef Documentation

◆ comment_type

◆ demote_arg_type

◆ demote_ret_type

◆ demote_stream_type

◆ frame_spec_version_type

◆ io_comment_type

typedef STRING FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >::io_comment_type
privateinherited

◆ io_name_type

typedef STRING FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >::io_name_type
privateinherited

◆ istream_type

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

◆ name_type

◆ nColumn_type

◆ nRow_type

◆ 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

◆ self_type

◆ unique_object_type

Constructor & Destructor Documentation

◆ FrTable() [1/8]

FrameCPP::Version_9::FrTable::FrTable ( )

Default constructor.

Returns
A new instance of this object.

◆ FrTable() [2/8]

FrTable::FrTable ( const FrTable & Source)

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
Returns
A new instance of this object.

◆ FrTable() [3/8]

FrTable::FrTable ( const name_type & name,
nRow_type nrows )

Constructor.

Parameters
[in]nameThe of this table.
[in]nrowsNumber of rows in table.
Returns
A new instance of the object.

◆ FrTable() [4/8]

FrTable::FrTable ( Previous::FrTable & Source,
stream_base_type * Stream )

Promotion Constructor.

Parameters
[in]SourceAn FrTable structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrTable structure was read.
Returns
A new instance of the object.

◆ ~FrTable() [1/2]

FrTable::~FrTable ( )
virtual

Destructor.

◆ FrTable() [5/8]

FrameCPP::Version_9::FrTable::FrTable ( )

Default constructor.

Returns
A new instance of this object.

◆ FrTable() [6/8]

FrameCPP::Version_9::FrTable::FrTable ( const FrTable & Source)

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
Returns
A new instance of this object.

◆ FrTable() [7/8]

FrameCPP::Version_9::FrTable::FrTable ( const name_type & name,
nRow_type nrows )

Constructor.

Parameters
[in]nameThe of this table.
[in]nrowsNumber of rows in table.
Returns
A new instance of the object.

◆ FrTable() [8/8]

FrameCPP::Version_9::FrTable::FrTable ( Previous::FrTable & Source,
stream_base_type * Stream )

Promotion Constructor.

Parameters
[in]SourceAn FrTable structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrTable structure was read.
Returns
A new instance of the object.

◆ ~FrTable() [2/2]

virtual FrameCPP::Version_9::FrTable::~FrTable ( )
virtual

Destructor.

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::FrTableImpl::ClassicIO< FrTable >::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::FrTableImpl::ClassicIO< FrTable >::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::FrTableImpl::ClassicIO< FrTable >::GetDescription ( ostream_type & Stream) const
inlineprotectedvirtualinherited

The data structure description.

Returns
The description of the data structure used to represent this object when written to a GWF stream

Reimplemented from FrameCPP::Common::FrameSpec::Object.

◆ GetDescription() [3/3]

virtual const Common::Description * FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >::GetDescription ( ostream_type & Stream) const
inlineprotectedvirtualinherited

The data structure description.

Returns
The description of the data structure used to represent this object when written to a GWF stream

Reimplemented from FrameCPP::Common::FrameSpec::Object.

◆ GetNameSlow() [1/2]

const std::string & FrTable::GetNameSlow ( ) const

Retrieve the name of the table.

Returns
The name of the table.

◆ GetNameSlow() [2/2]

const name_type & FrameCPP::Version_9::FrTable::GetNameSlow ( ) const

Retrieve the name of the table.

Returns
The name of the table.

◆ Merge() [1/2]

FrTable & FrTable::Merge ( const FrTable & RHS)

Merge with another FrTable.

Parameters
[in]RHSThe source of the information to append to this FrTable structure.
Returns
A reference to this object

◆ Merge() [2/2]

FrTable & FrameCPP::Version_9::FrTable::Merge ( const FrTable & RHS)

Merge with another FrTable.

Parameters
[in]RHSThe source of the information to append to this FrTable structure.
Returns
A reference to this object

◆ ObjectStructName() [1/2]

virtual const char * FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >::ObjectStructName ( ) const
inlineprotectedvirtualinherited

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::FrTableImpl::ClassicIO< FrTable >::ObjectStructName ( ) const
inlineprotectedvirtualinherited

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/2]

FrTable & FrTable::operator+= ( const FrTable & RHS)

Concatinate with another FrTable.

Parameters
[in]RHSThe source of the information to append to this FrTable structure.
Returns
A reference to this object

◆ operator+=() [2/2]

FrTable & FrameCPP::Version_9::FrTable::operator+= ( const FrTable & RHS)

Concatinate with another FrTable.

Parameters
[in]RHSThe source of the information to append to this FrTable structure.
Returns
A reference to this object

◆ operator==() [1/4]

bool FrTable::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::FrTable::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::FrTable::operator== ( const FrTable & RHS) const
inline

equality operator

Tests the equality of two tables.

Parameters
[in]RHSThe FrTable object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.
Parameters
[in]RHSRight hand side of equality expression.
Returns
True if the two tables are equivelant, false otherwise.

◆ operator==() [4/4]

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

equality operator

Parameters
[in]RHSThe FrTable 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::FrTableImpl::ClassicIO< FrTable >::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::FrTableImpl::ClassicIO< FrTable >::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::FrTableImpl::ClassicIO< FrTable >::pCreate ( Common::IStream & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

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

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

◆ pCreate() [2/2]

virtual self_type * FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >::pCreate ( Common::IStream & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

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

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

◆ Promote() [1/2]

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ Promote() [2/2]

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ 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::FrTableImpl::ClassicIO< FrTable >::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::FrTableImpl::ClassicIO< FrTable >::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::FrTableImpl::ClassicIO< FrTable >::pWrite ( Common::OStream & 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::FrTableImpl::ClassicIO< FrTable >::pWrite ( Common::OStream & 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 >.

◆ StructDescription() [1/2]

static const Common::Description * FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >::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::FrTableImpl::ClassicIO< FrTable >::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

◆ 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.

◆ 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.


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