ldas-tools-framecpp
2.7.0
|
Contains class information of a dictionary structure. More...
#include <FrSH.hh>
Classes | |
struct | image_t |
Public Member Functions | |
FrSH () | |
Default constructor. More... | |
FrSH (const std::string &Name, INT_2U ClassId, const std::string &Comment) | |
constructor More... | |
virtual | ~FrSH () |
Desctructor. More... | |
virtual const char * | ObjectStructName () const |
Dictionary class name. More... | |
INT_2U | GetClass () const |
Return class of object. More... | |
const std::string & | GetComment () const |
Return comment of object. More... | |
const STRING & | GetName () const |
Return name of object. More... | |
virtual FrSH * | Clone () const |
Create a new instance of the object based on self. More... | |
bool | operator== (const FrSH &RHS) const |
comparison operator More... | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator More... | |
FrSH () | |
Default constructor. More... | |
FrSH (const std::string &Name, INT_2U ClassId, const std::string &Comment) | |
constructor More... | |
virtual | ~FrSH () |
Desctructor. More... | |
virtual const char * | ObjectStructName () const |
Dictionary class name. More... | |
INT_2U | GetClass () const |
Return class of object. More... | |
const std::string & | GetComment () const |
Return comment of object. More... | |
const STRING & | GetName () const |
Return name of object. More... | |
virtual FrSH * | Clone () const |
Create a new instance of the object based on self. More... | |
bool | operator== (const FrSH &RHS) const |
comparison operator More... | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
comparison operator 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 void | Write (ostream_type &Stream) const |
Write object to the stream. More... | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. More... | |
void | TOCQuery (int InfoClass,...) const |
void | TOCQuery (int InfoClass,...) const |
Static Public Member Functions | |
static const char * | StructName () |
Return the dictionary name of the structure. More... | |
static const char * | StructName () |
Return the dictionary name of the structure. More... | |
static const char * | CheckSumDataClass () |
Data class to be used in class field of FrSE. More... | |
static const char * | CheckSumDataClass () |
Data class to be used in class field of FrSE. More... | |
static const char * | CheckSumDataComment () |
Comment to be used in comment field of FrSE. More... | |
static const char * | CheckSumDataComment () |
Comment to be used in comment field of FrSE. More... | |
template<class T > | |
static int | DataType (const T *Data) |
template<class T > | |
static int | DataType (const T &Data) |
template<class T > | |
static int | DataType (const T *Data) |
template<class T > | |
static int | DataType (const T &Data) |
Protected Member Functions | |
virtual const std::string & | name () const |
Interface method to return name of dictionary class. More... | |
virtual INT_2U | classId () const |
Interface method to return classId of dictionary class. More... | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, Common::IStream *Stream) const |
Down grade an object. More... | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, Common::IStream *Stream) const |
Upgrade an object. More... | |
virtual INT_8U | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
virtual FrSH * | pCreate (Common::IStream &Stream) const |
Create a new instance of the object based on the input stream. More... | |
virtual void | pWrite (Common::OStream &Stream) const |
Write the structure to the stream. More... | |
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
Answer requests for information as needed by TOC. More... | |
virtual void | assign (assign_stream_type &Stream) |
Assign the contents of the instance. More... | |
virtual const std::string & | name () const |
Interface method to return name of dictionary class. More... | |
virtual INT_2U | classId () const |
Interface method to return classId of dictionary class. More... | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, Common::IStream *Stream) const |
Down grade an object. More... | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, Common::IStream *Stream) const |
Upgrade an object. More... | |
virtual INT_8U | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
virtual FrSH * | pCreate (Common::IStream &Stream) const |
Create a new instance of the object based on the input stream. More... | |
virtual void | pWrite (Common::OStream &Stream) const |
Write the structure to the stream. More... | |
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
Answer requests for information as needed by TOC. More... | |
virtual void | assign (assign_stream_type &Stream) |
Assign the contents of the instance. More... | |
Private Types | |
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type > | object_base_type |
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type > | object_base_type |
Private Member Functions | |
FrSH (Common::IStream &Stream) | |
FrSH (Common::IStream &Stream) | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual More... | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual More... | |
Private Attributes | |
struct FrameCPP::Version_8::FrSH::image_t | m_data |
ChecksumType | m_chkSum |
Structure checksum. More... | |
Static Private Attributes | |
static const Common::FrameSpec::Info::frame_object_types | s_object_id = Common::FrameSpec::Info::FSI_FR_SH |
Dictionary class id for this structure. More... | |
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 |
|
inherited |
|
privateinherited |
|
privateinherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
FrameCPP::Version_8::FrSH::FrSH | ( | ) |
Default constructor.
FrameCPP::Version_8::FrSH::FrSH | ( | const std::string & | Name, |
INT_2U | ClassId, | ||
const std::string & | 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. |
|
virtual |
Desctructor.
|
private |
FrameCPP::Version_8::FrSH::FrSH | ( | ) |
Default constructor.
FrameCPP::Version_8::FrSH::FrSH | ( | const std::string & | Name, |
INT_2U | ClassId, | ||
const std::string & | 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. |
|
virtual |
Desctructor.
|
private |
|
protectedvirtual |
Assign the contents of the instance.
[in] | Stream | An input stream from which to read information for the instance. |
|
protectedvirtual |
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. |
|
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.
|
protectedvirtual |
Interface method to return classId of dictionary class.
|
protectedvirtual |
Interface method to return classId of dictionary class.
|
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
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
protectedvirtual |
Down grade an object.
|
protectedvirtual |
Down grade an object.
|
inline |
Return class of object.
INT_2U FrameCPP::Version_8::FrSH::GetClass | ( | ) | const |
Return class of object.
|
inline |
Return comment of object.
const std::string& FrameCPP::Version_8::FrSH::GetComment | ( | ) | const |
Return comment of object.
|
inline |
Return name of object.
const STRING& FrameCPP::Version_8::FrSH::GetName | ( | ) | const |
Return name of object.
|
protectedvirtual |
Interface method to return name of dictionary class.
|
protectedvirtual |
Interface method to return name of dictionary class.
|
virtual |
Dictionary class name.
|
virtual |
Dictionary class name.
|
virtual |
comparison operator
|
virtual |
comparison operator
bool FrameCPP::Version_8::FrSH::operator== | ( | const FrSH & | RHS | ) | const |
comparison operator
bool FrameCPP::Version_8::FrSH::operator== | ( | const FrSH & | 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.
|
inlineinherited |
|
inherited |
|
protectedvirtual |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
Implements FrameCPP::Common::TOCInfo.
|
protectedvirtual |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
Implements FrameCPP::Common::TOCInfo.
|
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.