ldas-tools-framecpp 2.9.2
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | 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::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::SerialIO< FR_SE_T >, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::SerialIO< FR_SE_T >, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, and FrameCPP::Version_8::FrSEImpl::SerialIO< FR_SE_T >.

Public Member Functions

 FrSE ()
 Default constructor.
 
 FrSE (const name_type &Name, const classId_type &ClassId, const comment_type &Comment="")
 constructor More...
 
virtual ~FrSE ()
 Desctructor.
 
bool operator== (const FrSE &RHS) const
 comparison operator
 
 FrSE ()
 Default constructor.
 
 FrSE (const name_type &Name, const classId_type &ClassId, const comment_type &Comment="")
 constructor More...
 
virtual ~FrSE ()
 Desctructor.
 
bool operator== (const FrSE &RHS) const
 comparison operator
 
 FrSE ()
 Default constructor.
 
 FrSE (const name_type &Name, const classId_type &ClassId, const comment_type &Comment="")
 constructor More...
 
virtual ~FrSE ()
 Desctructor.
 
bool operator== (const FrSE &RHS) const
 comparison operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
 
bool operator== (const FrSE &RHS) const
 comparison operator
 
const name_type & GetName () const
 Return name of object.
 
const name_type & GetName () const
 Return name of object.
 
const name_type & GetName () const
 Return name of object.
 
const classId_type & GetClass () const
 Return class of object.
 
const classId_type & GetClass () const
 Return class of object.
 
const classId_type & GetClass () const
 Return class of object.
 
const comment_type & GetComment () const
 Return comment of object.
 
const comment_type & GetComment () const
 Return comment of object.
 
const comment_type & GetComment () const
 Return comment of object.
 
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 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 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.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 

Static Public Member Functions

static const Common::Description * StructDescription ()
 The description of structure. More...
 
static const Common::Description * StructDescription ()
 The description of structure. More...
 
static const Common::Description * StructDescription ()
 The description of structure. More...
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
 
static struct_id_type FrameSpecId ()
 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 * 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.
 
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 demote_ret_type demote (INT_2U Target, demote_arg_type Obj, Common::IStream *Stream) const
 Down grade an object.
 
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 promote_ret_type promote (INT_2U Target, promote_arg_type Obj, Common::IStream *Stream) const
 Upgrade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, Common::IStream *Stream) const
 Upgrade an object.
 
virtual self_typepCreate (istream_type &Stream) const
 Create a new instance of the object based on the input stream.
 
virtual self_typepCreate (istream_type &Stream) const
 Create a new instance of the object based on the input stream.
 
virtual self_typepCreate (istream_type &Stream) const
 Create a new instance of the object based on the input stream.
 

Protected Attributes

name_type name
 
classId_type classId
 The string representation of data type of the element.
 
comment_type comment
 Description of the element.
 

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

FrSE::FrSE ( const name_type &  Name,
const classId_type &  ClassId,
const comment_type &  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/3]

FrameCPP::Version_8::FrSE::FrSE ( const name_type &  Name,
const classId_type &  ClassId,
const comment_type &  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() [3/3]

FrameCPP::Version_8::FrSE::FrSE ( const name_type &  Name,
const classId_type &  ClassId,
const comment_type &  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/3]

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

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

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

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

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

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.

◆ StructDescription() [1/3]

template<typename BASE_TYPE >
static const Common::Description * FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ StructDescription() [2/3]

template<typename BASE_TYPE >
static const Common::Description * FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ StructDescription() [3/3]

template<typename BASE_TYPE >
static const Common::Description * FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

Member Data Documentation

◆ name

name_type FrameCPP::v3::FrSE::name
protectedinherited

Name of an element of the structure being described. All element names within the structure must be unique.


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