ldas-tools-framecpp 2.7.0
|
Contains field information of a dictionary structure. More...
#include <FrSE.hh>
Classes | |
struct | image_t |
Public Types | |
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 |
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 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 | |
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 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. | |
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. | |
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 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. | |
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 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. | |
Private Types | |
typedef ObjectWithChecksum< Common::FrameSpec::Object > | object_type |
typedef ObjectWithChecksum< Common::FrameSpec::Object > | object_type |
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > | object_base_type |
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > | object_base_type |
Private Member Functions | |
FrSE (Common::IStream &Stream) | |
Constructor (Stream) | |
FrSE (Common::IStream &Stream) | |
Constructor (Stream) | |
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 | |
Private Attributes | |
struct FrameCPP::Version_8::FrSE::image_t | m_data |
ChecksumType | m_chkSum |
Structure checksum. | |
Static Private Attributes | |
static const Common::FrameSpec::Info::frame_object_types | s_object_id = Common::FrameSpec::Info::FSI_FR_SE |
Dictionary class id for this structure. | |
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 |
|
privateinherited |
|
privateinherited |
|
private |
|
private |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
FrSE::FrSE | ( | ) |
Default constructor.
FrSE::FrSE | ( | const std::string & | Name, |
const std::string & | ClassId, | ||
const std::string & | 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.
|
private |
FrameCPP::Version_8::FrSE::FrSE | ( | ) |
Default constructor.
FrameCPP::Version_8::FrSE::FrSE | ( | const std::string & | Name, |
const std::string & | ClassId, | ||
const std::string & | 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.
|
private |
|
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.
|
virtual |
Create a new instance of the object based on self.
|
virtual |
Create a new instance of the object based on self.
|
inlineprivatevirtualinherited |
Reimplemented in FrameCPP::Version_8::FrTOC, and FrameCPP::Version_8::FrTOC.
|
inlineprivatevirtualinherited |
Reimplemented in FrameCPP::Version_8::FrTOC, and FrameCPP::Version_8::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
|
protectedvirtual |
Down grade an object.
|
protectedvirtual |
Down grade an object.
|
inline |
Return class of object.
std::string FrameCPP::Version_8::FrSE::GetClass | ( | ) | const |
Return class of object.
|
inline |
Return comment of object.
std::string FrameCPP::Version_8::FrSE::GetComment | ( | ) | const |
Return comment of object.
std::string FrSE::GetName | ( | ) | const |
Return name of object.
std::string FrameCPP::Version_8::FrSE::GetName | ( | ) | const |
Return name of object.
|
virtual |
Dictionary class name.
|
virtual |
Dictionary class name.
|
virtual |
comparison operator
|
virtual |
comparison operator
bool FrSE::operator== | ( | const FrSE & | RHS | ) | const |
comparison operator
bool FrameCPP::Version_8::FrSE::operator== | ( | const FrSE & | RHS | ) | const |
comparison operator
|
protectedvirtual |
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 >.
|
protectedvirtual |
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 >.
|
protectedvirtual |
Create a new instance of the object based on the input stream.
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
protectedvirtual |
Create a new instance of the object based on the input stream.
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
protectedvirtual |
Upgrade an object.
|
protectedvirtual |
Upgrade an object.
|
protectedvirtual |
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 >.
|
protectedvirtual |
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 >.
|
inlinestatic |
Return the dictionary name of the structure.
|
static |
Return the dictionary name of the structure.
|
virtualinherited |
Write object to the stream.
|
virtualinherited |
Write object to the stream.
|
privateinherited |
Structure checksum.
The checksum for the structure when the structure is contained in a stream.
|
private |
|
staticprivate |
Dictionary class id for this structure.