ldas-tools-framecpp 2.7.0
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
FrameCPP::Version_8::FrRawData Class Reference

Raw Data Structgure Definition. More...

#include <FrRawData.hh>

Inheritance diagram for FrameCPP::Version_8::FrRawData:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_8::FrRawData:
Collaboration graph
[legend]

Classes

struct  fr_raw_data_type
 

Public Types

typedef Common::SearchContainer< FrSerData, &FrSerData::GetName > firstSer_type
 
typedef firstSer_type::iterator firstSer_iterator
 
typedef firstSer_type::const_iterator const_firstSer_iterator
 
typedef firstSer_type::hash_iterator firstSer_hash_iterator
 
typedef firstSer_type::const_hash_iterator const_firstSer_hash_iterator
 
typedef Common::SearchContainer< FrAdcData, &FrAdcData::GetNameSlow > firstAdc_type
 
typedef firstAdc_type::iterator firstAdc_iterator
 
typedef firstAdc_type::const_iterator const_firstAdc_iterator
 
typedef firstAdc_type::hash_iterator firstAdc_hash_iterator
 
typedef firstAdc_type::const_hash_iterator const_firstAdc_hash_iterator
 
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > firstTable_type
 
typedef firstTable_type::iterator firstTable_iterator
 
typedef firstTable_type::const_iterator const_firstTable_iterator
 
typedef firstTable_type::hash_iterator firstTable_hash_iterator
 
typedef firstTable_type::const_hash_iterator const_firstTable_hash_iterator
 
typedef Common::SearchContainer< FrMsg, &FrMsg::GetAlarm > logMsg_type
 
typedef logMsg_type::iterator logMsg_iterator
 
typedef logMsg_type::const_iterator const_logMsg_iterator
 
typedef logMsg_type::hash_iterator logMsg_hash_iterator
 
typedef logMsg_type::const_hash_iterator const_logMsg_hash_iterator
 
typedef Common::SearchContainer< FrVect, &FrVect::GetName > more_type
 
typedef more_type::iterator more_iterator
 
typedef more_type::const_iterator const_more_iterator
 
typedef more_type::hash_iterator more_hash_iterator
 
typedef more_type::const_hash_iterator const_more_hash_iterator
 
typedef Common::SearchContainer< FrSerData, &FrSerData::GetName > firstSer_type
 
typedef firstSer_type::iterator firstSer_iterator
 
typedef firstSer_type::const_iterator const_firstSer_iterator
 
typedef firstSer_type::hash_iterator firstSer_hash_iterator
 
typedef firstSer_type::const_hash_iterator const_firstSer_hash_iterator
 
typedef Common::SearchContainer< FrAdcData, &FrAdcData::GetNameSlow > firstAdc_type
 
typedef firstAdc_type::iterator firstAdc_iterator
 
typedef firstAdc_type::const_iterator const_firstAdc_iterator
 
typedef firstAdc_type::hash_iterator firstAdc_hash_iterator
 
typedef firstAdc_type::const_hash_iterator const_firstAdc_hash_iterator
 
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > firstTable_type
 
typedef firstTable_type::iterator firstTable_iterator
 
typedef firstTable_type::const_iterator const_firstTable_iterator
 
typedef firstTable_type::hash_iterator firstTable_hash_iterator
 
typedef firstTable_type::const_hash_iterator const_firstTable_hash_iterator
 
typedef Common::SearchContainer< FrMsg, &FrMsg::GetAlarm > logMsg_type
 
typedef logMsg_type::iterator logMsg_iterator
 
typedef logMsg_type::const_iterator const_logMsg_iterator
 
typedef logMsg_type::hash_iterator logMsg_hash_iterator
 
typedef logMsg_type::const_hash_iterator const_logMsg_hash_iterator
 
typedef Common::SearchContainer< FrVect, &FrVect::GetName > more_type
 
typedef more_type::iterator more_iterator
 
typedef more_type::const_iterator const_more_iterator
 
typedef more_type::hash_iterator more_hash_iterator
 
typedef more_type::const_hash_iterator const_more_hash_iterator
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 

Public Member Functions

 FrRawData ()
 Default constructor.
 
 FrRawData (const FrRawData &rawData)
 Copy Constructor.
 
 FrRawData (const std::string &name)
 Constructor.
 
 FrRawData (Previous::FrRawData &Source, Common::IStream *Stream)
 Promotion Constructor.
 
 ~FrRawData ()
 Destructor.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
const std::string & GetName () const
 Return the name associate with the FrRawData structure.
 
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.
 
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 constructor.
 
 FrRawData (const FrRawData &rawData)
 Copy Constructor.
 
 FrRawData (const std::string &name)
 Constructor.
 
 FrRawData (Previous::FrRawData &Source, Common::IStream *Stream)
 Promotion Constructor.
 
 ~FrRawData ()
 Destructor.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
const std::string & GetName () const
 Return the name associate with the FrRawData structure.
 
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.
 
bool operator== (const FrRawData &RHS) const
 equality operator
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type
 
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.
 

Static Public Member Functions

static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, Common::IStream *Stream)
 Promote previous version of object to this version.
 
static const char * StructName ()
 The name structure name of this object.
 
static const Common::DescriptionStructDescription ()
 The description of structure.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, Common::IStream *Stream)
 Promote previous version of object to this version.
 
static const char * StructName ()
 The name structure name of this object.
 
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 Public Attributes

static const Common::FrameSpec::Info::frame_object_types CLASS_ID
 

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, Common::IStream *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, Common::IStream *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 FrRawDatapCreate (Common::IStream &Stream) const
 Virtual constructor.
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream.
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, Common::IStream *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, Common::IStream *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 FrRawDatapCreate (Common::IStream &Stream) const
 Virtual constructor.
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream.
 

Private Types

typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 
typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 

Private Member Functions

 FrRawData (Common::IStream &Stream)
 Stream Constructor.
 
 FrRawData (const Previous::FrRawData &Source)
 Promotion Constructor.
 
 FrRawData (Common::IStream &Stream)
 Stream Constructor.
 
 FrRawData (const Previous::FrRawData &Source)
 Promotion Constructor.
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 

Private Attributes

fr_raw_data_type m_data
 
ChecksumType m_chkSum
 Structure checksum.
 

Detailed Description

Raw Data Structgure Definition.

Member Typedef Documentation

◆ const_firstAdc_hash_iterator [1/2]

typedef firstAdc_type::const_hash_iterator FrameCPP::Version_8::FrRawData::const_firstAdc_hash_iterator

◆ const_firstAdc_hash_iterator [2/2]

typedef firstAdc_type::const_hash_iterator FrameCPP::Version_8::FrRawData::const_firstAdc_hash_iterator

◆ const_firstAdc_iterator [1/2]

typedef firstAdc_type::const_iterator FrameCPP::Version_8::FrRawData::const_firstAdc_iterator

◆ const_firstAdc_iterator [2/2]

typedef firstAdc_type::const_iterator FrameCPP::Version_8::FrRawData::const_firstAdc_iterator

◆ const_firstSer_hash_iterator [1/2]

typedef firstSer_type::const_hash_iterator FrameCPP::Version_8::FrRawData::const_firstSer_hash_iterator

◆ const_firstSer_hash_iterator [2/2]

typedef firstSer_type::const_hash_iterator FrameCPP::Version_8::FrRawData::const_firstSer_hash_iterator

◆ const_firstSer_iterator [1/2]

typedef firstSer_type::const_iterator FrameCPP::Version_8::FrRawData::const_firstSer_iterator

◆ const_firstSer_iterator [2/2]

typedef firstSer_type::const_iterator FrameCPP::Version_8::FrRawData::const_firstSer_iterator

◆ const_firstTable_hash_iterator [1/2]

typedef firstTable_type::const_hash_iterator FrameCPP::Version_8::FrRawData::const_firstTable_hash_iterator

◆ const_firstTable_hash_iterator [2/2]

typedef firstTable_type::const_hash_iterator FrameCPP::Version_8::FrRawData::const_firstTable_hash_iterator

◆ const_firstTable_iterator [1/2]

typedef firstTable_type::const_iterator FrameCPP::Version_8::FrRawData::const_firstTable_iterator

◆ const_firstTable_iterator [2/2]

typedef firstTable_type::const_iterator FrameCPP::Version_8::FrRawData::const_firstTable_iterator

◆ const_logMsg_hash_iterator [1/2]

typedef logMsg_type::const_hash_iterator FrameCPP::Version_8::FrRawData::const_logMsg_hash_iterator

◆ const_logMsg_hash_iterator [2/2]

typedef logMsg_type::const_hash_iterator FrameCPP::Version_8::FrRawData::const_logMsg_hash_iterator

◆ const_logMsg_iterator [1/2]

typedef logMsg_type::const_iterator FrameCPP::Version_8::FrRawData::const_logMsg_iterator

◆ const_logMsg_iterator [2/2]

typedef logMsg_type::const_iterator FrameCPP::Version_8::FrRawData::const_logMsg_iterator

◆ const_more_hash_iterator [1/2]

typedef more_type::const_hash_iterator FrameCPP::Version_8::FrRawData::const_more_hash_iterator

◆ const_more_hash_iterator [2/2]

typedef more_type::const_hash_iterator FrameCPP::Version_8::FrRawData::const_more_hash_iterator

◆ const_more_iterator [1/2]

typedef more_type::const_iterator FrameCPP::Version_8::FrRawData::const_more_iterator

◆ const_more_iterator [2/2]

typedef more_type::const_iterator FrameCPP::Version_8::FrRawData::const_more_iterator

◆ firstAdc_hash_iterator [1/2]

typedef firstAdc_type::hash_iterator FrameCPP::Version_8::FrRawData::firstAdc_hash_iterator

◆ firstAdc_hash_iterator [2/2]

typedef firstAdc_type::hash_iterator FrameCPP::Version_8::FrRawData::firstAdc_hash_iterator

◆ firstAdc_iterator [1/2]

typedef firstAdc_type::iterator FrameCPP::Version_8::FrRawData::firstAdc_iterator

◆ firstAdc_iterator [2/2]

typedef firstAdc_type::iterator FrameCPP::Version_8::FrRawData::firstAdc_iterator

◆ firstAdc_type [1/2]

typedef Common::SearchContainer< FrAdcData, &FrAdcData::GetNameSlow > FrameCPP::Version_8::FrRawData::firstAdc_type

◆ firstAdc_type [2/2]

typedef Common::SearchContainer< FrAdcData, &FrAdcData::GetNameSlow > FrameCPP::Version_8::FrRawData::firstAdc_type

◆ firstSer_hash_iterator [1/2]

typedef firstSer_type::hash_iterator FrameCPP::Version_8::FrRawData::firstSer_hash_iterator

◆ firstSer_hash_iterator [2/2]

typedef firstSer_type::hash_iterator FrameCPP::Version_8::FrRawData::firstSer_hash_iterator

◆ firstSer_iterator [1/2]

typedef firstSer_type::iterator FrameCPP::Version_8::FrRawData::firstSer_iterator

◆ firstSer_iterator [2/2]

typedef firstSer_type::iterator FrameCPP::Version_8::FrRawData::firstSer_iterator

◆ firstSer_type [1/2]

typedef Common::SearchContainer< FrSerData, &FrSerData::GetName > FrameCPP::Version_8::FrRawData::firstSer_type

◆ firstSer_type [2/2]

typedef Common::SearchContainer< FrSerData, &FrSerData::GetName > FrameCPP::Version_8::FrRawData::firstSer_type

◆ firstTable_hash_iterator [1/2]

typedef firstTable_type::hash_iterator FrameCPP::Version_8::FrRawData::firstTable_hash_iterator

◆ firstTable_hash_iterator [2/2]

typedef firstTable_type::hash_iterator FrameCPP::Version_8::FrRawData::firstTable_hash_iterator

◆ firstTable_iterator [1/2]

typedef firstTable_type::iterator FrameCPP::Version_8::FrRawData::firstTable_iterator

◆ firstTable_iterator [2/2]

typedef firstTable_type::iterator FrameCPP::Version_8::FrRawData::firstTable_iterator

◆ firstTable_type [1/2]

typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > FrameCPP::Version_8::FrRawData::firstTable_type

◆ firstTable_type [2/2]

typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > FrameCPP::Version_8::FrRawData::firstTable_type

◆ istream_type [1/2]

template<typename ObjectType , typename ChecksumType >
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ istream_type [2/2]

template<typename ObjectType , typename ChecksumType >
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ logMsg_hash_iterator [1/2]

typedef logMsg_type::hash_iterator FrameCPP::Version_8::FrRawData::logMsg_hash_iterator

◆ logMsg_hash_iterator [2/2]

typedef logMsg_type::hash_iterator FrameCPP::Version_8::FrRawData::logMsg_hash_iterator

◆ logMsg_iterator [1/2]

typedef logMsg_type::iterator FrameCPP::Version_8::FrRawData::logMsg_iterator

◆ logMsg_iterator [2/2]

typedef logMsg_type::iterator FrameCPP::Version_8::FrRawData::logMsg_iterator

◆ logMsg_type [1/2]

typedef Common::SearchContainer< FrMsg, &FrMsg::GetAlarm > FrameCPP::Version_8::FrRawData::logMsg_type

◆ logMsg_type [2/2]

typedef Common::SearchContainer< FrMsg, &FrMsg::GetAlarm > FrameCPP::Version_8::FrRawData::logMsg_type

◆ more_hash_iterator [1/2]

typedef more_type::hash_iterator FrameCPP::Version_8::FrRawData::more_hash_iterator

◆ more_hash_iterator [2/2]

typedef more_type::hash_iterator FrameCPP::Version_8::FrRawData::more_hash_iterator

◆ more_iterator [1/2]

typedef more_type::iterator FrameCPP::Version_8::FrRawData::more_iterator

◆ more_iterator [2/2]

typedef more_type::iterator FrameCPP::Version_8::FrRawData::more_iterator

◆ more_type [1/2]

typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::Version_8::FrRawData::more_type

◆ more_type [2/2]

typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::Version_8::FrRawData::more_type

◆ object_base_type [1/2]

◆ object_base_type [2/2]

◆ object_type [1/2]

typedef ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_8::FrRawData::object_type
private

◆ object_type [2/2]

typedef ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_8::FrRawData::object_type
private

◆ ostream_type [1/2]

template<typename ObjectType , typename ChecksumType >
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ ostream_type [2/2]

template<typename ObjectType , typename ChecksumType >
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ self_type [1/2]

template<typename ObjectType , typename ChecksumType >
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ self_type [2/2]

template<typename ObjectType , typename ChecksumType >
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

Constructor & Destructor Documentation

◆ FrRawData() [1/12]

FrRawData::FrRawData ( )

Default constructor.

Returns
A new instance of this object.

◆ FrRawData() [2/12]

FrRawData::FrRawData ( const FrRawData rawData)

Copy Constructor.

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

◆ FrRawData() [3/12]

FrRawData::FrRawData ( const std::string &  name)

Constructor.

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

◆ FrRawData() [4/12]

FrRawData::FrRawData ( Previous::FrRawData Source,
Common::IStream 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() [1/2]

FrRawData::~FrRawData ( )

Destructor.

◆ FrRawData() [5/12]

FrRawData::FrRawData ( Common::IStream Stream)
private

Stream Constructor.

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

◆ FrRawData() [6/12]

FrRawData::FrRawData ( const Previous::FrRawData Source)
private

Promotion Constructor.

Parameters
[in]SourceAn FrRawData structure from a previous frame specification.
Returns
A new instance of an FrRawData object

◆ FrRawData() [7/12]

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

Default constructor.

Returns
A new instance of this object.

◆ FrRawData() [8/12]

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

Copy Constructor.

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

◆ FrRawData() [9/12]

FrameCPP::Version_8::FrRawData::FrRawData ( const std::string &  name)

Constructor.

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

◆ FrRawData() [10/12]

FrameCPP::Version_8::FrRawData::FrRawData ( Previous::FrRawData Source,
Common::IStream 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() [2/2]

FrameCPP::Version_8::FrRawData::~FrRawData ( )

Destructor.

◆ FrRawData() [11/12]

FrameCPP::Version_8::FrRawData::FrRawData ( Common::IStream Stream)
private

Stream Constructor.

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

◆ FrRawData() [12/12]

FrameCPP::Version_8::FrRawData::FrRawData ( const Previous::FrRawData Source)
private

Promotion Constructor.

Parameters
[in]SourceAn FrRawData structure from a previous frame specification.
Returns
A new instance of an FrRawData object

Member Function Documentation

◆ Bytes() [1/2]

template<typename ObjectType , typename ChecksumType >
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::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/2]

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

◆ CheckSumDataClass() [1/2]

template<typename ObjectType , typename ChecksumType >
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

template<typename ObjectType , typename ChecksumType >
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/2]

template<typename ObjectType , typename ChecksumType >
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

template<typename ObjectType , typename ChecksumType >
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ Create() [1/6]

template<typename ObjectType , typename ChecksumType >
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [2/6]

template<typename ObjectType , typename ChecksumType >
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [3/6]

template<typename ObjectType , typename ChecksumType >
virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::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/6]

template<typename ObjectType , typename ChecksumType >
virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::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/6]

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

constructor - virtual

◆ Create() [6/6]

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

constructor - virtual

◆ demote() [1/2]

FrRawData::demote_ret_type FrRawData::demote ( INT_2U  Target,
demote_arg_type  Obj,
Common::IStream Stream 
) const
protectedvirtual

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]

virtual demote_ret_type FrameCPP::Version_8::FrRawData::demote ( INT_2U  Target,
demote_arg_type  Obj,
Common::IStream Stream 
) const
protectedvirtual

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 std::string & FrRawData::GetName ( ) const

Return the name associate with the FrRawData structure.

Returns
The name associated with the FrRawData structure

◆ GetName() [2/2]

const std::string & 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]

const char * FrRawData::ObjectStructName ( ) const
virtual

The name structure name of this object.

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

◆ ObjectStructName() [2/2]

virtual const char * FrameCPP::Version_8::FrRawData::ObjectStructName ( ) const
virtual

The name structure name of this object.

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

◆ operator==() [1/4]

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

comparison operator

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

comparison operator

◆ 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

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]

FrameCPP::cmn_streamsize_type FrRawData::pBytes ( const Common::StreamBase Stream) const
protectedvirtual

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< ObjectType, ChecksumType >.

◆ pBytes() [2/2]

virtual cmn_streamsize_type FrameCPP::Version_8::FrRawData::pBytes ( const Common::StreamBase Stream) const
protectedvirtual

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< ObjectType, ChecksumType >.

◆ pCreate() [1/2]

FrRawData * FrRawData::pCreate ( Common::IStream Stream) const
protectedvirtual

Virtual constructor.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pCreate() [2/2]

virtual FrRawData * FrameCPP::Version_8::FrRawData::pCreate ( Common::IStream Stream) const
protectedvirtual

Virtual constructor.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ Promote() [1/2]

FrRawData::promote_ret_type FrameCPP::Version_8::FrRawData::Promote ( INT_2U  Source,
promote_arg_type  Obj,
Common::IStream Stream 
)
inlinestatic

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]

static promote_ret_type FrameCPP::Version_8::FrRawData::Promote ( INT_2U  Source,
promote_arg_type  Obj,
Common::IStream Stream 
)
static

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]

FrRawData::promote_ret_type FrRawData::promote ( INT_2U  Target,
promote_arg_type  Obj,
Common::IStream Stream 
) const
protectedvirtual

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]

virtual promote_ret_type FrameCPP::Version_8::FrRawData::promote ( INT_2U  Target,
promote_arg_type  Obj,
Common::IStream Stream 
) const
protectedvirtual

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]

void FrRawData::pWrite ( Common::OStream Stream) const
protectedvirtual

Write the structure to the stream.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pWrite() [2/2]

virtual void FrameCPP::Version_8::FrRawData::pWrite ( Common::OStream Stream) const
protectedvirtual

Write the structure to the stream.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ RefFirstAdc() [1/4]

FrRawData::firstAdc_type & FrameCPP::Version_8::FrRawData::RefFirstAdc ( )
inline

Identifier for first ADC data structure.

Returns
A reference to the first ADC data structure.

◆ RefFirstAdc() [2/4]

firstAdc_type & FrameCPP::Version_8::FrRawData::RefFirstAdc ( )

Identifier for first ADC data structure.

Returns
A reference to the first ADC data structure.

◆ RefFirstAdc() [3/4]

const FrRawData::firstAdc_type & FrameCPP::Version_8::FrRawData::RefFirstAdc ( ) const
inline

Identifier for first ADC data structure.

Returns
A constant reference to the first ADC data structure.

◆ RefFirstAdc() [4/4]

const firstAdc_type & FrameCPP::Version_8::FrRawData::RefFirstAdc ( ) const

Identifier for first ADC data structure.

Returns
A constant reference to the first ADC data structure.

◆ RefFirstSer() [1/4]

FrRawData::firstSer_type & FrameCPP::Version_8::FrRawData::RefFirstSer ( )
inline

Identifier for first serial data structure.

Returns
A reference to the first serial data structure.

◆ RefFirstSer() [2/4]

firstSer_type & FrameCPP::Version_8::FrRawData::RefFirstSer ( )

Identifier for first serial data structure.

Returns
A reference to the first serial data structure.

◆ RefFirstSer() [3/4]

const FrRawData::firstSer_type & FrameCPP::Version_8::FrRawData::RefFirstSer ( ) const
inline

Identifier for first serial data structure.

Returns
A constant reference to the first serial data structure.

◆ RefFirstSer() [4/4]

const firstSer_type & FrameCPP::Version_8::FrRawData::RefFirstSer ( ) const

Identifier for first serial data structure.

Returns
A constant reference to the first serial data structure.

◆ RefFirstTable() [1/4]

FrRawData::firstTable_type & FrameCPP::Version_8::FrRawData::RefFirstTable ( )
inline

Identifier for first table data structure.

Returns
A reference to the first table data structure.

◆ RefFirstTable() [2/4]

firstTable_type & FrameCPP::Version_8::FrRawData::RefFirstTable ( )

Identifier for first table data structure.

Returns
A reference to the first table data structure.

◆ RefFirstTable() [3/4]

const FrRawData::firstTable_type & FrameCPP::Version_8::FrRawData::RefFirstTable ( ) const
inline

Identifier for first table data structure.

Returns
A constant reference to the first table data structure.

◆ RefFirstTable() [4/4]

const firstTable_type & FrameCPP::Version_8::FrRawData::RefFirstTable ( ) const

Identifier for first table data structure.

Returns
A constant reference to the first table data structure.

◆ RefLogMsg() [1/4]

FrRawData::logMsg_type & FrameCPP::Version_8::FrRawData::RefLogMsg ( )
inline

Identifier for first error message data structure.

Returns
A reference to the first error message data structure.

◆ RefLogMsg() [2/4]

logMsg_type & FrameCPP::Version_8::FrRawData::RefLogMsg ( )

Identifier for first error message data structure.

Returns
A reference to the first error message data structure.

◆ RefLogMsg() [3/4]

const FrRawData::logMsg_type & FrameCPP::Version_8::FrRawData::RefLogMsg ( ) const
inline

Identifier for first error message data structure.

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

◆ RefLogMsg() [4/4]

const logMsg_type & FrameCPP::Version_8::FrRawData::RefLogMsg ( ) const

Identifier for first error message data structure.

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

◆ RefMore() [1/4]

FrRawData::more_type & FrameCPP::Version_8::FrRawData::RefMore ( )
inline

Identifier for additional user-defined data structure.

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

◆ RefMore() [2/4]

more_type & FrameCPP::Version_8::FrRawData::RefMore ( )

Identifier for additional user-defined data structure.

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

◆ RefMore() [3/4]

const FrRawData::more_type & FrameCPP::Version_8::FrRawData::RefMore ( ) const
inline

Identifier for additional user-defined data structure.

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

◆ RefMore() [4/4]

const more_type & FrameCPP::Version_8::FrRawData::RefMore ( ) const

Identifier for additional user-defined data structure.

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

◆ StructDescription() [1/2]

const Description * FrRawData::StructDescription ( )
static

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_8::FrRawData::StructDescription ( )
static

The description of structure.

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

◆ StructName() [1/2]

const char * FrameCPP::Version_8::FrRawData::StructName ( )
inlinestatic

The name structure name of this object.

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

◆ StructName() [2/2]

static const char * FrameCPP::Version_8::FrRawData::StructName ( )
static

The name structure name of this object.

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

◆ Write() [1/2]

template<typename ObjectType , typename ChecksumType >
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type Stream) const
virtualinherited

Write object to the stream.

◆ Write() [2/2]

template<typename ObjectType , typename ChecksumType >
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type Stream) const
virtualinherited

Write object to the stream.

Member Data Documentation

◆ CLASS_ID

static const Common::FrameSpec::Info::frame_object_types FrameCPP::Version_8::FrRawData::CLASS_ID
static
Initial value:

◆ m_chkSum

template<typename ObjectType , typename ChecksumType >
ChecksumType FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::m_chkSum
privateinherited

Structure checksum.

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

◆ m_data

fr_raw_data_type FrameCPP::Version_8::FrRawData::m_data
private

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