ldas-tools-framecpp  2.5.8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
FrameCPP::Version_8::FrSE Class Reference

Contains field information of a dictionary structure. More...

#include <FrSE.hh>

Inheritance diagram for FrameCPP::Version_8::FrSE:
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 ObjectWithChecksum
< Common::FrameSpec::Object,
checksum_type
self_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

 FrSE ()
 Default constructor. More...
 
 FrSE (const std::string &Name, const std::string &ClassId, const std::string &Comment="")
 constructor More...
 
virtual ~FrSE ()
 Desctructor. More...
 
virtual const char * ObjectStructName () const
 Dictionary class name. More...
 
std::string GetClass () const
 Return class of object. More...
 
std::string GetComment () const
 Return comment of object. More...
 
std::string GetName () const
 Return name of object. More...
 
virtual FrSEClone () const
 Create a new instance of the object based on self. More...
 
bool operator== (const FrSE &RHS) const
 comparison operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator 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...
 
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...
 
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 const char * StructName ()
 Return the dictionary name of the 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...
 

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, Common::IStream *Stream) const
 Down grade an object. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, Common::IStream *Stream) const
 Upgrade an object. More...
 
virtual INT_8U pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual FrSEpCreate (Common::IStream &Stream) const
 Create a new instance of the object based on the input stream. 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

Contains field information of a dictionary structure.

This class gives information describing a single field of the class structure being described. In a dicitionary structure, there may be multiple occurances of FrSE. The order of the FrSE corresponds to the order of the fields as written to the stream.

See also
FrSH

Member Typedef Documentation

Constructor & Destructor Documentation

FrSE::FrSE ( )

Default constructor.

FrSE::FrSE ( const std::string &  Name,
const std::string &  ClassId,
const std::string &  Comment = "" 
)

constructor

Parameters
[in]NameName of an element of the structure being described by this dictionary structure.
[in]ClassIdThe data type of the element being described by this dictionary structure.
[in]CommentDescription of the element being described by this dictionary strucutre.
FrSE::~FrSE ( )
virtual

Desctructor.

Member Function Documentation

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.

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

Data class to be used in class field of FrSE.

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

Comment to be used in comment field of FrSE.

FrSE * FrSE::Clone ( ) const
virtual

Create a new instance of the object based on self.

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

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.

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

Down grade an object.

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

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.
std::string FrameCPP::Version_8::FrSE::GetClass ( ) const
inline

Return class of object.

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

Retrieve the class identifier.

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

std::string FrameCPP::Version_8::FrSE::GetComment ( ) const
inline

Return comment of object.

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.

std::string FrSE::GetName ( ) const

Return name of object.

const char * FrSE::ObjectStructName ( ) const
virtual

Dictionary class name.

Returns
The dictionary class name for this structure.

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

bool FrSE::operator== ( const FrSE RHS) const

comparison operator

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

comparison operator

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

INT_8U FrSE::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 >.

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

Create a new instance of the object based on the input stream.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.

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

Upgrade an object.

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

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.
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.
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
void FrSE::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 >.

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

Return the dictionary name of the structure.

void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited
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.

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.

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