Contains field information of a dictionary structure. More...
#include <FrSE.hh>
Public Types | |
typedef STRING | io_name_type |
typedef STRING | io_name_type |
typedef STRING | io_id_type |
typedef STRING | io_id_type |
typedef STRING | io_comment_type |
typedef STRING | io_comment_type |
typedef ObjectWithChecksum< ObjectType, ChecksumType > | self_type |
typedef ObjectWithChecksum< ObjectType, ChecksumType > | self_type |
typedef IStream | istream_type |
typedef IStream | istream_type |
typedef OStream | ostream_type |
typedef OStream | ostream_type |
typedef const char *const | struct_name_type |
typedef const char *const | struct_desc_type |
typedef INT_2U const | struct_id_type |
typedef std::string | name_type |
typedef std::string | classId_type |
typedef std::string | comment_type |
Public Member Functions | |
FrSE () | |
Default constructor. | |
FrSE (const name_type &Name, const classId_type &ClassId, const comment_type &Comment="") | |
constructor | |
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 | |
virtual | ~FrSE () |
Desctructor. | |
bool | operator== (const FrSE &RHS) const |
comparison operator | |
bool | operator== (const Common::FrameSpec::Object &Obj) const |
Common::FrameSpec::Object * | Clone () const |
Common::FrameSpec::Object * | Clone () const |
virtual const char * | ObjectStructName () const |
virtual const char * | ObjectStructName () const |
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_type * | Create (istream_type &Stream) const |
Virtual constructor. | |
virtual self_type * | Create (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. | |
bool | operator== (const FrSE &RHS) const |
comparison operator | |
const name_type & | GetName () const |
Return name of object. | |
const classId_type & | GetClass () const |
Return class of object. | |
const comment_type & | GetComment () const |
Return comment of object. | |
Static Public Member Functions | |
static const Common::Description * | StructDescription () |
The description of structure. | |
static const Common::Description * | StructDescription () |
The description of 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. | |
static struct_name_type | FrameSpecName () |
static struct_name_type | StructName () |
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 Public Attributes | |
static struct_name_type | struct_name |
static struct_desc_type | struct_desc |
static struct_id_type | struct_id |
Protected Types | |
typedef ObjectWithChecksum< Common::FrameSpec::Object > | object_type |
typedef ObjectWithChecksum< Common::FrameSpec::Object > | object_type |
Protected Member Functions | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const |
Down grade an object. | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const |
Down grade an object. | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const |
Upgrade an object. | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const |
Upgrade an object. | |
virtual cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. | |
virtual cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. | |
virtual self_type * | pCreate (istream_type &Stream) const |
Create a new instance of the object based on the input stream. | |
virtual self_type * | pCreate (istream_type &Stream) const |
Create a new instance of the object based on the input stream. | |
void | pWrite (Common::OStream &Stream) const |
Write the structure to the stream. | |
void | pWrite (Common::OStream &Stream) const |
Write the structure to the 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. | |
Private Member Functions | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
void | save (Archive &ar, const unsigned int version) const |
void | save (Archive &ar, const unsigned int version) const |
void | load (Archive &ar, const unsigned int version) |
void | load (Archive &ar, const unsigned int version) |
Private Attributes | |
ChecksumType | m_chkSum |
Structure checksum. | |
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.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
protectedinherited |
|
protectedinherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
FrameCPP::Version_8::FrSE::FrSE | ( | ) |
Default constructor.
FrSE::FrSE | ( | const name_type & | Name, |
const classId_type & | ClassId, | ||
const comment_type & | Comment = "" ) |
constructor
[in] | Name | Name of an element of the structure being described by this dictionary structure. |
[in] | ClassId | The data type of the element being described by this dictionary structure. |
[in] | Comment | Description of the element being described by this dictionary strucutre. |
|
virtual |
Desctructor.
FrameCPP::Version_8::FrSE::FrSE | ( | ) |
Default constructor.
FrameCPP::Version_8::FrSE::FrSE | ( | const name_type & | Name, |
const classId_type & | ClassId, | ||
const comment_type & | Comment = "" ) |
constructor
[in] | Name | Name of an element of the structure being described by this dictionary structure. |
[in] | ClassId | The data type of the element being described by this dictionary structure. |
[in] | Comment | Description of the element being described by this dictionary strucutre. |
|
virtual |
Desctructor.
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
inlineinherited |
|
inlineinherited |
|
inlineprivatevirtualinherited |
Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.
|
inlineprivatevirtualinherited |
Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
inlineprivatevirtualinherited |
constructor - virtual
|
inlineprivatevirtualinherited |
constructor - virtual
|
inlineprotectedvirtualinherited |
Down grade an object.
|
inlineprotectedvirtualinherited |
Down grade an object.
|
inlinestaticinherited |
Return the dictionary name of the structure.
|
inlinestaticinherited |
Return the dictionary name of the structure.
|
inlinestaticinherited |
|
inlineinherited |
Return class of object.
|
inlineinherited |
Return comment of object.
|
inlineinherited |
Return name of object.
|
inlineprivateinherited |
|
inlineprivateinherited |
|
inlinevirtualinherited |
|
inlinevirtualinherited |
|
inlineinherited |
comparison operator
|
inline |
comparison operator
|
inline |
comparison operator
|
inherited |
|
inlineprotectedvirtualinherited |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inlineprotectedvirtualinherited |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inlineprotectedvirtualinherited |
Create a new instance of the object based on the input stream.
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inlineprotectedvirtualinherited |
Create a new instance of the object based on the input stream.
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inlineprotectedvirtualinherited |
Upgrade an object.
|
inlineprotectedvirtualinherited |
Upgrade an object.
|
inlineprotectedvirtualinherited |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inlineprotectedvirtualinherited |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inlineprivateinherited |
|
inlineprivateinherited |
|
inlinestaticinherited |
The description of structure.
|
inlinestaticinherited |
The description of structure.
|
inlinestaticinherited |
|
virtualinherited |
Write object to the stream.
|
virtualinherited |
Write object to the stream.
|
protectedinherited |
The string representation of data type of the element.
|
protectedinherited |
Description of the element.
|
privateinherited |
Structure checksum.
The checksum for the structure when the structure is contained in a stream.
|
protectedinherited |
Name of an element of the structure being described. All element names within the structure must be unique.
|
staticinherited |
|
staticinherited |
|
staticinherited |