ldas-tools-framecpp 3.0.4
|
Contains class information of a dictionary structure. More...
#include <FrSH.hh>
Public Types | |
typedef std::string | name_type |
typedef std::string | comment_type |
Comment. | |
typedef INT_2U | class_type |
Class number of structure being described. |
Public Member Functions | |
FrSH () | |
Default constructor. | |
FrSH (const name_type &Name, class_type ClassId, const comment_type &Comment) | |
constructor | |
virtual | ~FrSH () |
Desctructor. | |
bool | operator== (const FrSH &RHS) const |
comparison operator | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator | |
FrSH () | |
Default constructor. | |
FrSH (const name_type &Name, class_type ClassId, const comment_type &Comment) | |
constructor | |
virtual | ~FrSH () |
Desctructor. | |
bool | operator== (const FrSH &RHS) const |
comparison operator | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. | |
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 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 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 self_type * | Create (istream_type &Stream) const |
Virtual constructor. | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. | |
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. | |
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. | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. | |
class_type | GetClass () const |
Return class of object. | |
const comment_type & | GetComment () const |
Return comment of object. | |
const name_type & | GetName () const |
Return name of object. |
Static Public Member Functions | |
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream) |
Promote previous version of object to this version. | |
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream) |
Promote previous version of object to this version. | |
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 * | 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 * | 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. | |
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. | |
static struct_desc_type | FrameSpecDescription () |
Return the dictionary name of the structure. | |
static struct_id_type | FrameSpecId () |
Return the dictionary name of the structure. |
Protected Member Functions | |
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
Answer requests for information as needed by TOC. | |
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
Answer requests for information as needed by TOC. | |
virtual void | assign (assign_stream_type &Stream) |
Assign the contents of the instance. | |
virtual void | assign (assign_stream_type &Stream) |
Assign the contents of the instance. | |
virtual const std::string & | name () const |
virtual const std::string & | name () const |
virtual demote_ret_type | demote (frame_spec_version_type Target, demote_arg_type Obj, demote_stream_type *Stream) const |
Demotes object to previous version of the frame spec. | |
virtual demote_ret_type | demote (frame_spec_version_type Target, demote_arg_type Obj, demote_stream_type *Stream) const |
Demotes object to previous version of the frame spec. | |
virtual promote_ret_type | promote (frame_spec_version_type Target, promote_arg_type Obj, promote_stream_type *Stream) const |
Promotes object to another version of the frame spec. | |
virtual promote_ret_type | promote (frame_spec_version_type Target, promote_arg_type Obj, promote_stream_type *Stream) const |
Promotes object to another version of the frame spec. | |
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. | |
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 |
Virtual constructor. | |
virtual self_type * | pCreate (istream_type &Stream) const |
Virtual constructor. | |
virtual void | pWrite (ostream_type &Stream) const |
Write the structure to the stream. | |
virtual void | pWrite (ostream_type &Stream) const |
Write the structure to the stream. |
Protected Attributes | |
name_type | name |
comment_type | comment |
class_type | klass |
Contains class information of a dictionary structure.
A dictionary structure is written to the output stream the imediately preceeding the first occurance of the frame structure it describes. This class gives information about the class structure being described. In a dictionary structure, there is only one occurance of FrSH. It must be the first element of the dictionary structure.
|
inherited |
Name of structure being described by this dictionary structure
FrameCPP::Version_9::FrSH::FrSH | ( | const name_type & | Name, |
class_type | ClassId, | ||
const comment_type & | Comment ) |
constructor
[in] | Name | Name of structure being described by this dictionary structure. |
[in] | ClassId | Class number of structure being described |
[in] | Comment | Comment describing the class. |
FrameCPP::Version_9::FrSH::FrSH | ( | const name_type & | Name, |
class_type | ClassId, | ||
const comment_type & | Comment ) |
constructor
[in] | Name | Name of structure being described by this dictionary structure. |
[in] | ClassId | Class number of structure being described |
[in] | Comment | Comment describing the class. |
|
inlineprotectedvirtualinherited |
Assign the contents of the instance.
[in] | Stream | An input stream from which to read information for the instance. |
|
inlineprotectedvirtualinherited |
Assign the contents of the instance.
[in] | Stream | An input stream from which to read information for the instance. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
inlineprotectedvirtualinherited |
Demotes object to previous version of the frame spec.
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
|
inlineprotectedvirtualinherited |
Demotes object to previous version of the frame spec.
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
|
inlineinherited |
Return class of object.
|
inlineinherited |
Return comment of object.
|
inlineinherited |
Return name of object.
|
inlineprotectedvirtualinherited |
|
inlineprotectedvirtualinherited |
|
inlinevirtualinherited |
The name structure name of this object.
|
inlinevirtualinherited |
The name structure name of this object.
|
inlineprotectedinherited |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
|
inlineprotectedinherited |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
|
inlineprotectedvirtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
inlineprotectedvirtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
inlinestaticinherited |
Promote previous version of object to this version.
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
|
inlinestaticinherited |
Promote previous version of object to this version.
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
|
inlineprotectedvirtualinherited |
Promotes object to another version of the frame spec.
[in] | Target | The version of the promoted frame specification. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
|
inlineprotectedvirtualinherited |
Promotes object to another version of the frame spec.
[in] | Target | The version of the promoted frame specification. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
|
inlineprotectedvirtualinherited |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
|
inlineprotectedvirtualinherited |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
|
inlinestaticinherited |
The description of structure.
|
inlinestaticinherited |
The description of structure.
|
protectedvirtual |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
|
protectedvirtual |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
|
protectedinherited |
Comment
|
protectedinherited |
Class number of structure being described
|
protectedinherited |
Name of structure being described by this dictionary structure