ldas-tools-framecpp  2.6.5
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | 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:
FrameCPP::Version_8::ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > FrameCPP::Common::FrameSpec::Object FrameCPP::Common::FrameSpec::ObjectInterface

Public Types

typedef Common::SearchContainer< FrSerData, &FrSerData::GetNamefirstSer_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::GetNameSlowfirstAdc_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::GetNameSlowfirstTable_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::GetAlarmlogMsg_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::GetNamemore_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< Common::FrameSpec::Object, checksum_typeself_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 object_type promote_arg_type
 
typedef object_type promote_ret_type
 

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. More...
 
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 self_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectClone () const
 constructor - virtual copy constructor More...
 
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, IStream *Stream)
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 

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

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. 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 class_type getClass () const
 Retrieve the class identifier. More...
 

Detailed Description

Raw Data Structgure Definition.

Member Typedef Documentation

◆ const_firstAdc_hash_iterator

◆ const_firstAdc_iterator

◆ const_firstSer_hash_iterator

◆ const_firstSer_iterator

◆ const_firstTable_hash_iterator

◆ const_firstTable_iterator

◆ const_logMsg_hash_iterator

◆ const_logMsg_iterator

◆ const_more_hash_iterator

◆ const_more_iterator

◆ demote_arg_type

◆ demote_ret_type

◆ firstAdc_hash_iterator

◆ firstAdc_iterator

◆ firstAdc_type

◆ firstSer_hash_iterator

◆ firstSer_iterator

◆ firstSer_type

◆ firstTable_hash_iterator

◆ firstTable_iterator

◆ firstTable_type

◆ frame_spec_version_type

◆ istream_type

◆ logMsg_hash_iterator

◆ logMsg_iterator

◆ logMsg_type

◆ more_hash_iterator

◆ more_iterator

◆ more_type

◆ ostream_type

◆ promote_arg_type

◆ promote_ret_type

◆ self_type

◆ unique_object_type

Constructor & Destructor Documentation

◆ FrRawData() [1/4]

FrRawData::FrRawData ( )

Default constructor.

Returns
A new instance of this object.

◆ FrRawData() [2/4]

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

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

Constructor.

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

◆ FrRawData() [4/4]

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()

FrRawData::~FrRawData ( )

Destructor.

Member Function Documentation

◆ Bytes()

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()

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()

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

Comment to be used in comment field of FrSE.

◆ Clone()

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

◆ Create()

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.

◆ demote()

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.

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

◆ DemoteObject()

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

◆ GetClass()

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass()

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

Retrieve the class identifier.

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

◆ GetDescription()

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.

◆ GetName()

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

Return the name associate with the FrRawData structure.

Returns
The name associated with the FrRawData structure

◆ ObjectStructName()

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.

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

◆ operator==() [1/2]

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

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

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

◆ pBytes()

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< Common::FrameSpec::Object, checksum_type >.

◆ pCreate()

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< Common::FrameSpec::Object, checksum_type >.

◆ Promote()

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()

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.

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

◆ PromoteObject() [1/3]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_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/3]

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,
istream_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/3]

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,
IStream Stream 
)
inherited

◆ pWrite()

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< Common::FrameSpec::Object, checksum_type >.

◆ RefFirstAdc() [1/2]

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

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

Identifier for first ADC data structure.

Returns
A reference to the first ADC data structure.

◆ RefFirstSer() [1/2]

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

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

Identifier for first serial data structure.

Returns
A reference to the first serial data structure.

◆ RefFirstTable() [1/2]

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

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

Identifier for first table data structure.

Returns
A reference to the first table data structure.

◆ RefLogMsg() [1/2]

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

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.

◆ RefMore() [1/2]

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

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.

◆ StructDescription()

const Description * FrRawData::StructDescription ( )
static

The description of structure.

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

◆ StructName()

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.

◆ VerifyObject()

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

◆ Write()

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()

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

◆ CLASS_ID

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

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