ldas-tools-framecpp  2.6.2
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
FrameCPP::Version_3::FrRawData Class Reference

#include <FrRawData.hh>

Inheritance diagram for FrameCPP::Version_3::FrRawData:
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< 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 FrameSpec::version_type frame_spec_version_type
 
typedef boost::shared_ptr< Objectobject_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 ()
 
 FrRawData (const FrRawData &rawData)
 
 FrRawData (const std::string &name)
 
 ~FrRawData ()
 
virtual cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual FrRawDataCreate (istream_type &Stream) const
 constructor - virtual More...
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
const std::string & GetName () const
 
const firstSer_typeRefFirstSer () const
 
firstSer_typeRefFirstSer ()
 
const firstAdc_typeRefFirstAdc () const
 
firstAdc_typeRefFirstAdc ()
 
const logMsg_typeRefLogMsg () const
 
logMsg_typeRefLogMsg ()
 
const more_typeRefMore () const
 
more_typeRefMore ()
 
bool operator== (const FrRawData &RHS) const
 comparison operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator 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 ObjectCreate () const
 constructor - virtual More...
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual 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, istream_type *Stream)
 
static const char * StructName ()
 
static const Common::DescriptionStructDescription ()
 
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 = Common::FrameSpec::Info::FSI_FR_RAW_DATA
 

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object. More...
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 

Member Typedef Documentation

◆ const_firstAdc_hash_iterator

◆ const_firstAdc_iterator

◆ const_firstSer_hash_iterator

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

◆ frame_spec_version_type

◆ logMsg_hash_iterator

◆ logMsg_iterator

◆ logMsg_type

◆ more_hash_iterator

◆ more_iterator

◆ more_type

◆ object_type

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ promote_arg_type

◆ promote_ret_type

◆ unique_object_type

Constructor & Destructor Documentation

◆ FrRawData() [1/3]

FrRawData::FrRawData ( )

◆ FrRawData() [2/3]

FrRawData::FrRawData ( const FrRawData rawData)

◆ FrRawData() [3/3]

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

◆ ~FrRawData()

FrRawData::~FrRawData ( )

Member Function Documentation

◆ Bytes()

FrameCPP::cmn_streamsize_type FrRawData::Bytes ( const Common::StreamBase Stream) const
virtual

Return the number of bytes for this object.

Parameters
[in]StreamThe stream on which the object will be written or read.
Returns
The number of bytes required by this object for the specified stream.

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

◆ Clone()

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

◆ Create() [1/3]

FrRawData * FrRawData::Create ( istream_type Stream) const
virtual

constructor - virtual

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

◆ Create() [2/3]

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

◆ Create() [3/3]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( std::istream &  Buffer) const
virtualinherited

constructor - virtual

Reimplemented in FrameCPP::Version_8::FrHeader, and FrameCPP::Version_3::FrHeader.

◆ demote()

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

Down grade an object.

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

◆ ObjectStructName()

const char * FrRawData::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

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

◆ operator==() [1/2]

bool FrameCPP::Version_3::FrRawData::operator== ( const FrRawData RHS) const
inline

comparison operator

◆ operator==() [2/2]

bool FrRawData::operator== ( const Common::FrameSpec::Object Obj) const
virtual

comparison operator

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

◆ Promote()

FrRawData::promote_ret_type FrameCPP::Version_3::FrRawData::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
inlinestatic

◆ promote()

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

Upgrade an object.

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

◆ RefFirstAdc() [1/2]

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

◆ RefFirstAdc() [2/2]

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

◆ RefFirstSer() [1/2]

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

◆ RefFirstSer() [2/2]

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

◆ RefLogMsg() [1/2]

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

◆ RefLogMsg() [2/2]

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

◆ RefMore() [1/2]

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

◆ RefMore() [2/2]

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

◆ StructDescription()

const Description * FrRawData::StructDescription ( )
static

◆ StructName()

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

◆ VerifyObject()

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

◆ Write()

void FrRawData::Write ( ostream_type Stream) const
virtual

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

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_3::FrRawData::CLASS_ID = Common::FrameSpec::Info::FSI_FR_RAW_DATA
static

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