ldas-tools-framecpp  2.7.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
FrameCPP::Version_8::FrRawData Class Reference

Raw Data Structgure Definition. More...

#include <FrRawData.hh>

Inherits FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, and FrameCPP::Version_8::ObjectWithChecksum< ObjectType >.

Public Member Functions

 FrRawData ()
 Default constructor. More...
 
 FrRawData (const FrRawData &rawData)
 Copy Constructor. More...
 
 FrRawData (const std::string &name)
 Constructor. More...
 
 FrRawData (Previous::FrRawData &Source, Common::IStream *Stream)
 Promotion Constructor. More...
 
 ~FrRawData ()
 Destructor.
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
const std::string & GetName () const
 Return the name associate with the FrRawData structure. More...
 
const firstSer_typeRefFirstSer () const
 Identifier for first serial data structure. More...
 
firstSer_typeRefFirstSer ()
 Identifier for first serial data structure. More...
 
const firstAdc_typeRefFirstAdc () const
 Identifier for first ADC data structure. More...
 
firstAdc_typeRefFirstAdc ()
 Identifier for first ADC data structure. More...
 
const firstTable_typeRefFirstTable () const
 Identifier for first table data structure. More...
 
firstTable_typeRefFirstTable ()
 Identifier for first table data structure. More...
 
const logMsg_typeRefLogMsg () const
 Identifier for first error message data structure. More...
 
logMsg_typeRefLogMsg ()
 Identifier for first error message data structure. More...
 
const more_typeRefMore () const
 Identifier for additional user-defined data structure. More...
 
more_typeRefMore ()
 Identifier for additional user-defined data structure. More...
 
bool operator== (const FrRawData &RHS) const
 equality operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type More...
 
 FrRawData ()
 Default constructor. More...
 
 FrRawData (const FrRawData &rawData)
 Copy Constructor. More...
 
 FrRawData (const std::string &name)
 Constructor. More...
 
 FrRawData (Previous::FrRawData &Source, Common::IStream *Stream)
 Promotion Constructor. More...
 
 ~FrRawData ()
 Destructor.
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
const std::string & GetName () const
 Return the name associate with the FrRawData structure. More...
 
const firstSer_typeRefFirstSer () const
 Identifier for first serial data structure. More...
 
firstSer_typeRefFirstSer ()
 Identifier for first serial data structure. More...
 
const firstAdc_typeRefFirstAdc () const
 Identifier for first ADC data structure. More...
 
firstAdc_typeRefFirstAdc ()
 Identifier for first ADC data structure. More...
 
const firstTable_typeRefFirstTable () const
 Identifier for first table data structure. More...
 
firstTable_typeRefFirstTable ()
 Identifier for first table data structure. More...
 
const logMsg_typeRefLogMsg () const
 Identifier for first error message data structure. More...
 
logMsg_typeRefLogMsg ()
 Identifier for first error message data structure. More...
 
const more_typeRefMore () const
 Identifier for additional user-defined data structure. More...
 
more_typeRefMore ()
 Identifier for additional user-defined data structure. More...
 
bool operator== (const FrRawData &RHS) const
 equality operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type More...
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
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. More...
 
static const char * StructName ()
 The name structure name of this object. More...
 
static const Common::Description * StructDescription ()
 The description of structure. More...
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, Common::IStream *Stream)
 Promote previous version of object to this version. More...
 
static const char * StructName ()
 The name structure name of this object. More...
 
static const Common::Description * StructDescription ()
 The description of structure. More...
 
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.
 

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. More...
 
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. More...
 
virtual cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual FrRawDatapCreate (Common::IStream &Stream) const
 Virtual constructor. More...
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream. More...
 
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. More...
 
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. More...
 
virtual cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual FrRawDatapCreate (Common::IStream &Stream) const
 Virtual constructor. More...
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream. More...
 

Detailed Description

Raw Data Structgure Definition.

Constructor & Destructor Documentation

◆ FrRawData() [1/8]

FrRawData::FrRawData ( )

Default constructor.

Returns
A new instance of this object.

◆ FrRawData() [2/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() [3/8]

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

Constructor.

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

◆ FrRawData() [4/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() [5/8]

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

Default constructor.

Returns
A new instance of this object.

◆ FrRawData() [6/8]

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() [7/8]

FrameCPP::Version_8::FrRawData::FrRawData ( const std::string &  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,
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

Member Function Documentation

◆ Bytes() [1/2]

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

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

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

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]

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, checksum_type >.

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

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

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

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

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

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

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