Contains field information of a dictionary structure.
More...
#include <FrSE.hh>
Inherits FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, and FrameCPP::Version_8::ObjectWithChecksum< ObjectType >.
|
| FrSE () |
| Default constructor.
|
|
| FrSE (const std::string &Name, const std::string &ClassId, const std::string &Comment="") |
| constructor More...
|
|
virtual | ~FrSE () |
| Desctructor.
|
|
virtual const char * | ObjectStructName () const |
| Dictionary class name. More...
|
|
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 FrSE * | Clone () 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 More...
|
|
virtual | ~FrSE () |
| Desctructor.
|
|
virtual const char * | ObjectStructName () const |
| Dictionary class name. More...
|
|
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 FrSE * | Clone () 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. 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 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 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.
|
|
|
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. More...
|
|
virtual FrSE * | pCreate (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. More...
|
|
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. More...
|
|
virtual FrSE * | pCreate (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. More...
|
|
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/2]
FrSE::FrSE |
( |
const std::string & |
Name, |
|
|
const std::string & |
ClassId, |
|
|
const std::string & |
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/2]
FrameCPP::Version_8::FrSE::FrSE |
( |
const std::string & |
Name, |
|
|
const std::string & |
ClassId, |
|
|
const std::string & |
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/2]
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/2]
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/2]
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/2]
Virtual constructor.
- Parameters
-
[in] | Stream | The 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 |
◆ pBytes() [2/2]
virtual INT_8U FrameCPP::Version_8::FrSE::pBytes |
( |
const Common::StreamBase & |
Stream | ) |
const |
|
protectedvirtual |
◆ pWrite() [1/2]
virtual void FrameCPP::Version_8::FrSE::pWrite |
( |
Common::OStream & |
Stream | ) |
const |
|
protectedvirtual |
◆ pWrite() [2/2]
void FrSE::pWrite |
( |
Common::OStream & |
Stream | ) |
const |
|
protectedvirtual |
The documentation for this class was generated from the following files:
- /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-2.7.0/include/framecpp/Version8/FrSE.hh
- Version8/FrSE.cc