Contains field information of a dictionary structure.
More...
#include <FrSE.hh>
Inherits FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, and FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >.
|
| FrSE () |
| Default constructor.
|
|
| FrSE (const name_type &Name, const classId_type &ClassId, const comment_type &Comment="") |
| constructor More...
|
|
virtual | ~FrSE () |
| Desctructor.
|
|
| FrSE () |
| Default constructor.
|
|
| FrSE (const name_type &Name, const classId_type &ClassId, const comment_type &Comment="") |
| constructor More...
|
|
virtual | ~FrSE () |
| Desctructor.
|
|
| FrSE () |
| Default constructor.
|
|
| FrSE (const name_type &Name, const classId_type &ClassId, const comment_type &Comment="") |
| constructor More...
|
|
virtual | ~FrSE () |
| Desctructor.
|
|
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
| comparison operator
|
|
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
| comparison operator
|
|
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
| comparison operator
|
|
bool | operator== (const Data &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_type * | Create (istream_type &Stream) const |
| Virtual constructor. More...
|
|
virtual self_type * | Create (istream_type &Stream) const |
| Virtual constructor. More...
|
|
virtual self_type * | Create (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 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.
|
|
|
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_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.
|
|
virtual self_type * | pCreate (istream_type &Stream) const |
| Create a new instance of the object based on the input stream.
|
|
|
STRING | name |
|
STRING | classId |
| The string representation of data type of the element.
|
|
STRING | comment |
| Description of the element.
|
|
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
◆ FrSE() [1/3]
FrSE::FrSE |
( |
const name_type & |
Name, |
|
|
const classId_type & |
ClassId, |
|
|
const comment_type & |
Comment = "" |
|
) |
| |
constructor
- Parameters
-
[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. |
◆ FrSE() [2/3]
FrameCPP::Version_8::FrSE::FrSE |
( |
const name_type & |
Name, |
|
|
const classId_type & |
ClassId, |
|
|
const comment_type & |
Comment = "" |
|
) |
| |
constructor
- Parameters
-
[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. |
◆ FrSE() [3/3]
FrameCPP::Version_8::FrSE::FrSE |
( |
const name_type & |
Name, |
|
|
const classId_type & |
ClassId, |
|
|
const comment_type & |
Comment = "" |
|
) |
| |
constructor
- Parameters
-
[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. |
◆ Bytes() [1/3]
Return the number of bytes for this object.
- Parameters
-
[in] | Stream | Stream 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]
Return the number of bytes for this object.
- Parameters
-
[in] | Stream | Stream 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]
Return the number of bytes for this object.
- Parameters
-
[in] | Stream | Stream 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 constructor.
- Parameters
-
[in] | Stream | The input stream from where the object is being read. |
- Returns
- Return pointer to the newly allocated resource.
◆ Create() [2/3]
Virtual constructor.
- Parameters
-
[in] | Stream | The input stream from where the object is being read. |
- Returns
- Return pointer to the newly allocated resource.
◆ Create() [3/3]
Virtual constructor.
- Parameters
-
[in] | Stream | The 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.
◆ name
STRING FrameCPP::Version_8::FrSEImpl::Data::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:
- /build/ldas-tools-framecpp-2.8.1/debian/tmp/usr/include/framecpp/Version8/FrSE.hh
- /build/ldas-tools-framecpp-2.8.1/obj-x86_64-linux-gnu/include/framecpp/Version8/FrSE.hh
- /build/ldas-tools-framecpp-2.8.1/src/Version8/FrSE.hh
- /build/ldas-tools-framecpp-2.8.1/src/Version8/FrSE.cc