ldas-tools-framecpp 2.7.0
Loading...
Searching...
No Matches
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>

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

Public Member Functions

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

Protected Member Functions

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

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

Constructor & Destructor Documentation

◆ FrSE() [1/2]

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

FrameCPP::Version_8::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.

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.

◆ ObjectStructName() [1/2]

const char * FrSE::ObjectStructName ( ) const
virtual

Dictionary class name.

Returns
The dictionary class name for this structure.

◆ ObjectStructName() [2/2]

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

Dictionary class name.

Returns
The dictionary class name for this structure.

◆ pBytes() [1/2]

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

◆ pBytes() [2/2]

virtual INT_8U FrameCPP::Version_8::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< ObjectType, checksum_type >.

◆ pWrite() [1/2]

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

◆ pWrite() [2/2]

virtual void FrameCPP::Version_8::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< ObjectType, checksum_type >.


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