ldas-tools-framecpp  2.7.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
FrameCPP::Version_8::FrSH Class Reference

Contains class information of a dictionary structure. More...

#include <FrSH.hh>

Inherits FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, FrameCPP::Common::TOCInfo, FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, and FrameCPP::Common::TOCInfo.

Public Member Functions

 FrSH ()
 Default constructor.
 
 FrSH (const std::string &Name, INT_2U ClassId, const std::string &Comment)
 constructor More...
 
virtual ~FrSH ()
 Desctructor.
 
virtual const char * ObjectStructName () const
 Dictionary class name. More...
 
INT_2U GetClass () const
 Return class of object.
 
const std::string & GetComment () const
 Return comment of object.
 
const STRING & GetName () const
 Return name of object.
 
virtual FrSHClone () const
 Create a new instance of the object based on self.
 
bool operator== (const FrSH &RHS) const
 comparison operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
 
 FrSH ()
 Default constructor.
 
 FrSH (const std::string &Name, INT_2U ClassId, const std::string &Comment)
 constructor More...
 
virtual ~FrSH ()
 Desctructor.
 
virtual const char * ObjectStructName () const
 Dictionary class name. More...
 
INT_2U GetClass () const
 Return class of object.
 
const std::string & GetComment () const
 Return comment of object.
 
const STRING & GetName () const
 Return name of object.
 
virtual FrSHClone () const
 Create a new instance of the object based on self.
 
bool operator== (const FrSH &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_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typeCreate (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 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 const std::string & name () const
 Interface method to return name of dictionary class.
 
virtual INT_2U classId () const
 Interface method to return classId of dictionary class.
 
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 FrSHpCreate (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 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.
 
virtual INT_2U classId () const
 Interface method to return classId of dictionary class.
 
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 FrSHpCreate (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 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...
 

Detailed Description

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.

See also
FrSE

Constructor & Destructor Documentation

◆ FrSH() [1/2]

FrameCPP::Version_8::FrSH::FrSH ( const std::string &  Name,
INT_2U  ClassId,
const std::string &  Comment 
)

constructor

Parameters
[in]NameName of structure being described by this dictionary structure.
[in]ClassIdClass number of structure being described
[in]CommentComment describing the class.

◆ FrSH() [2/2]

FrameCPP::Version_6::FrSH::FrSH ( const std::string &  Name,
INT_2U  ClassId,
const std::string &  Comment 
)

constructor

Parameters
[in]NameName of structure being described by this dictionary structure.
[in]ClassIdClass number of structure being described
[in]CommentComment describing the class.

Member Function Documentation

◆ assign() [1/2]

void FrameCPP::Version_8::FrSH::assign ( assign_stream_type &  Stream)
protectedvirtual

Assign the contents of the instance.

Parameters
[in]StreamAn input stream from which to read information for the instance.
Note
This has been hidden so programmers are not tempted to bypass usage of IFrameStream as the input stream.

◆ assign() [2/2]

virtual void FrameCPP::Version_8::FrSH::assign ( assign_stream_type &  Stream)
protectedvirtual

Assign the contents of the instance.

Parameters
[in]StreamAn input stream from which to read information for the instance.
Note
This has been hidden so programmers are not tempted to bypass usage of IFrameStream as the input stream.

◆ Bytes() [1/2]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Bytes ( const StreamBase &  Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream 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]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Bytes ( const StreamBase &  Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream 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 self_type* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type &  Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ Create() [2/2]

virtual self_type* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type &  Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ ObjectStructName() [1/2]

const char * FrameCPP::Version_8::FrSH::ObjectStructName ( ) const
virtual

Dictionary class name.

Returns
The dictionary class name for this structure.

◆ ObjectStructName() [2/2]

const char *const FrameCPP::Version_6::FrSH::ObjectStructName ( ) const
virtual

Dictionary class name.

Returns
The dictionary class name for this structure.

◆ pBytes() [1/2]

INT_8U FrameCPP::Version_8::FrSH::pBytes ( const Common::StreamBase &  Stream) const
protectedvirtual

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ pBytes() [2/2]

virtual INT_8U FrameCPP::Version_8::FrSH::pBytes ( const Common::StreamBase &  Stream) const
protectedvirtual

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ pWrite() [1/2]

void FrameCPP::Version_8::FrSH::pWrite ( Common::OStream &  Stream) const
protectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ pWrite() [2/2]

virtual void FrameCPP::Version_8::FrSH::pWrite ( Common::OStream &  Stream) const
protectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ vTOCQuery() [1/2]

void FrameCPP::Version_8::FrSH::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
protectedvirtual

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

◆ vTOCQuery() [2/2]

void FrameCPP::Version_6::FrSH::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
protectedvirtual

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

The documentation for this class was generated from the following files: