ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
FrameCPP::Version_8::FrRawData Class Reference

Simulated Data Structure Definition. More...

#include <FrRawData.hh>

Public Member Functions

 FrRawData ()=default
 Default constructor.
 
 FrRawData (const FrRawData &rawData)=default
 Copy Constructor.
 
 FrRawData (const name_type &name)
 Constructor.
 
 FrRawData (Previous::FrRawData &Source, stream_base_type *Stream)
 Promotion Constructor.
 
const name_type & GetName () const
 Return the name associate with the FrRawData structure.
 
bool operator== (const FrRawData &RHS) const
 equality operator
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type
 
 FrRawData ()=default
 Default constructor.
 
 FrRawData (const FrRawData &rawData)=default
 Copy Constructor.
 
 FrRawData (const name_type &name)
 Constructor.
 
 FrRawData (Previous::FrRawData &Source, stream_base_type *Stream)
 Promotion Constructor.
 
const name_type & GetName () const
 Return the name associate with the FrRawData structure.
 
bool operator== (const FrRawData &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 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 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 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 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 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 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 self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
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.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
const firstSer_typeRefFirstSer () const
 Identifier for first serial data structure.
 
firstSer_typeRefFirstSer ()
 Identifier for first serial data structure.
 
const firstAdc_typeRefFirstAdc () const
 Identifier for first ADC data structure.
 
firstAdc_typeRefFirstAdc ()
 Identifier for first ADC data structure.
 
const firstTable_typeRefFirstTable () const
 Identifier for first table data structure.
 
firstTable_typeRefFirstTable ()
 Identifier for first table data structure.
 
const logMsg_typeRefLogMsg () const
 Identifier for first error message data structure.
 
logMsg_typeRefLogMsg ()
 Identifier for first error message data structure.
 
const more_typeRefMore () const
 Identifier for additional user-defined data structure.
 
more_typeRefMore ()
 Identifier for additional user-defined data structure.
 

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::Description * StructDescription ()
 The description of structure.
 
static const Common::Description * StructDescription ()
 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 * 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 * 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 * 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 * 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 * 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 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 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 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 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 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 struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
 

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 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 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 (Common::OStream &Stream) const
 Write the structure to the stream.
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream.
 

Protected Attributes

name_type name
 Name of raw data.
 
firstSer_type firstSer
 
firstAdc_type firstAdc
 
firstTable_type firstTable
 
logMsg_type logMsg
 
more_type more
 

Detailed Description

Simulated Data Structure Definition.

Constructor & Destructor Documentation

◆ FrRawData() [1/8]

FrameCPP::Version_8::FrRawData::FrRawData ( )
default

Default constructor.

Returns
A new instance of this object.

◆ FrRawData() [2/8]

FrameCPP::Version_8::FrRawData::FrRawData ( const FrRawData & rawData)
default

Copy Constructor.

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

◆ FrRawData() [3/8]

FrameCPP::Version_8::FrRawData::FrRawData ( const name_type & name)

Constructor.

Parameters
[in]nameNamne of raw data.
Returns
A new instance of the object.

◆ FrRawData() [4/8]

FrameCPP::Version_8::FrRawData::FrRawData ( Previous::FrRawData & Source,
stream_base_type * Stream )

Promotion Constructor.

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

◆ FrRawData() [5/8]

FrameCPP::Version_8::FrRawData::FrRawData ( )
default

Default constructor.

Returns
A new instance of this object.

◆ FrRawData() [6/8]

FrameCPP::Version_8::FrRawData::FrRawData ( const FrRawData & rawData)
default

Copy Constructor.

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

◆ FrRawData() [7/8]

FrameCPP::Version_8::FrRawData::FrRawData ( const name_type & name)

Constructor.

Parameters
[in]nameNamne of raw data.
Returns
A new instance of the object.

◆ FrRawData() [8/8]

FrameCPP::Version_8::FrRawData::FrRawData ( Previous::FrRawData & Source,
stream_base_type * Stream )

Promotion Constructor.

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

Member Function Documentation

◆ Bytes() [1/12]

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

◆ Bytes() [2/12]

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

◆ Bytes() [3/12]

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

◆ Bytes() [4/12]

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

◆ Bytes() [5/12]

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

◆ Bytes() [6/12]

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

◆ Bytes() [7/12]

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

◆ Bytes() [8/12]

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

◆ Bytes() [9/12]

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

◆ Bytes() [10/12]

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

◆ Bytes() [11/12]

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

◆ Bytes() [12/12]

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

◆ Create() [1/12]

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

◆ Create() [2/12]

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

◆ Create() [3/12]

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

◆ Create() [4/12]

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

◆ Create() [5/12]

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

◆ Create() [6/12]

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

◆ Create() [7/12]

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

◆ Create() [8/12]

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

◆ Create() [9/12]

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

◆ Create() [10/12]

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

◆ Create() [11/12]

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

◆ Create() [12/12]

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

◆ demote() [1/2]

template<typename T>
virtual demote_ret_type FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >::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() [2/2]

template<typename T>
virtual demote_ret_type FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >::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.

◆ GetName() [1/2]

const name_type & FrameCPP::Version_8::FrRawData::GetName ( ) const

Return the name associate with the FrRawData structure.

Returns
The name associated with the FrRawData structure

◆ GetName() [2/2]

const name_type & FrameCPP::Version_8::FrRawData::GetName ( ) const

Return the name associate with the FrRawData structure.

Returns
The name associated with the FrRawData structure

◆ ObjectStructName() [1/2]

template<typename T>
virtual const char * FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

◆ ObjectStructName() [2/2]

template<typename T>
virtual const char * FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

◆ operator==() [1/4]

virtual bool FrameCPP::Version_8::FrRawData::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.

◆ operator==() [2/4]

virtual bool FrameCPP::Version_8::FrRawData::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.

◆ operator==() [3/4]

bool FrameCPP::Version_8::FrRawData::operator== ( const FrRawData & RHS) const
inline

equality operator

Parameters
[in]RHSThe FrRawData 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_8::FrRawData::operator== ( const FrRawData & RHS) const
inline

equality operator

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

◆ pBytes() [1/2]

template<typename T>
virtual cmn_streamsize_type FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >::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.

◆ pBytes() [2/2]

template<typename T>
virtual cmn_streamsize_type FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >::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.

◆ pCreate() [1/2]

template<typename T>
virtual self_type * FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

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

◆ pCreate() [2/2]

template<typename T>
virtual self_type * FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

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

◆ Promote() [1/2]

template<typename T>
static promote_ret_type FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
inlinestaticinherited

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]

template<typename T>
static promote_ret_type FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
inlinestaticinherited

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

template<typename T>
virtual promote_ret_type FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >::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() [2/2]

template<typename T>
virtual promote_ret_type FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >::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.

◆ pWrite() [1/2]

template<typename T>
virtual void FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >::pWrite ( Common::OStream & Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

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

◆ pWrite() [2/2]

template<typename T>
virtual void FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >::pWrite ( Common::OStream & Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

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

◆ RefFirstAdc() [1/2]

firstAdc_type & FrameCPP::Version_8::FrRawDataImpl::Data::RefFirstAdc ( )
inlineinherited

Identifier for first ADC data structure.

Returns
A reference to the first ADC data structure.

◆ RefFirstAdc() [2/2]

const firstAdc_type & FrameCPP::Version_8::FrRawDataImpl::Data::RefFirstAdc ( ) const
inlineinherited

Identifier for first ADC data structure.

Returns
A constant reference to the first ADC data structure.

◆ RefFirstSer() [1/2]

firstSer_type & FrameCPP::Version_8::FrRawDataImpl::Data::RefFirstSer ( )
inlineinherited

Identifier for first serial data structure.

Returns
A reference to the first serial data structure.

◆ RefFirstSer() [2/2]

const firstSer_type & FrameCPP::Version_8::FrRawDataImpl::Data::RefFirstSer ( ) const
inlineinherited

Identifier for first serial data structure.

Returns
A constant reference to the first serial data structure.

◆ RefFirstTable() [1/2]

firstTable_type & FrameCPP::Version_8::FrRawDataImpl::Data::RefFirstTable ( )
inlineinherited

Identifier for first table data structure.

Returns
A reference to the first table data structure.

◆ RefFirstTable() [2/2]

const firstTable_type & FrameCPP::Version_8::FrRawDataImpl::Data::RefFirstTable ( ) const
inlineinherited

Identifier for first table data structure.

Returns
A constant reference to the first table data structure.

◆ RefLogMsg() [1/2]

logMsg_type & FrameCPP::Version_8::FrRawDataImpl::Data::RefLogMsg ( )
inlineinherited

Identifier for first error message data structure.

Returns
A reference to the first error message data structure.

◆ RefLogMsg() [2/2]

const logMsg_type & FrameCPP::Version_8::FrRawDataImpl::Data::RefLogMsg ( ) const
inlineinherited

Identifier for first error message data structure.

Returns
A constant reference to the first error message data structure.

◆ RefMore() [1/2]

more_type & FrameCPP::Version_8::FrRawDataImpl::Data::RefMore ( )
inlineinherited

Identifier for additional user-defined data structure.

Returns
A reference to the additional user-defined data structure.

◆ RefMore() [2/2]

const more_type & FrameCPP::Version_8::FrRawDataImpl::Data::RefMore ( ) const
inlineinherited

Identifier for additional user-defined data structure.

Returns
A constant reference to the additional user-defined data structure.

◆ StructDescription() [1/2]

template<typename T>
static const Common::Description * FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ StructDescription() [2/2]

template<typename T>
static const Common::Description * FrameCPP::Version_8::FrRawDataImpl::ClassicIO< T >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

Member Data Documentation

◆ firstAdc

firstAdc_type FrameCPP::Version_8::FrRawDataImpl::Data::firstAdc
protectedinherited

Identifier for first ADC data structure in the linked list.

◆ firstSer

firstSer_type FrameCPP::Version_8::FrRawDataImpl::Data::firstSer
protectedinherited

Identifier for first serial data structure in the linked list.

◆ firstTable

firstTable_type FrameCPP::Version_8::FrRawDataImpl::Data::firstTable
protectedinherited

Identifier for first table data structure in the linked list.

◆ logMsg

logMsg_type FrameCPP::Version_8::FrRawDataImpl::Data::logMsg
protectedinherited

Identifier for first error message data structure in the linked list.

◆ more

more_type FrameCPP::Version_8::FrRawDataImpl::Data::more
protectedinherited

Identifier for the additional user-defined data structure in the linked list.


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