ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_8::FrSH Class Reference

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 self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (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.
 
class_type GetClass () const
 Return class of object.
 
const comment_typeGetComment () const
 Return comment of object.
 
const name_typeGetName () 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 * 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_typepCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typepCreate (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
 

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

Member Typedef Documentation

◆ name_type

typedef std::string FrameCPP::v3::FrSH::name_type
inherited

Name of structure being described by this dictionary structure

Constructor & Destructor Documentation

◆ FrSH() [1/2]

FrameCPP::Version_8::FrSH::FrSH ( const name_type & Name,
class_type ClassId,
const comment_type & 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_8::FrSH::FrSH ( const name_type & Name,
class_type ClassId,
const comment_type & 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]

template<typename FR_SH_T >
virtual void FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::assign ( assign_stream_type & Stream)
inlineprotectedvirtualinherited

Assign the contents of the instance.

Parameters
[in]StreamAn input stream from which to read information for the instance.

◆ assign() [2/2]

template<typename FR_SH_T >
virtual void FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::assign ( assign_stream_type & Stream)
inlineprotectedvirtualinherited

Assign the contents of the instance.

Parameters
[in]StreamAn input stream from which to read information for the instance.

◆ 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.

◆ demote() [1/2]

template<typename FR_SH_T >
virtual demote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::demote ( frame_spec_version_type Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

◆ demote() [2/2]

template<typename FR_SH_T >
virtual demote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::demote ( frame_spec_version_type Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

◆ GetClass()

FrSH::class_type FrameCPP::v3::FrSH::GetClass ( ) const
inlineinherited

Return class of object.

Returns
Class number of structure being described

◆ GetComment()

const FrSH::comment_type & FrameCPP::v3::FrSH::GetComment ( ) const
inlineinherited

Return comment of object.

Returns
Comment

◆ GetName()

const FrSH::name_type & FrameCPP::v3::FrSH::GetName ( ) const
inlineinherited

Return name of object.

Returns
Name of structure being described by this dictionary structure

◆ name() [1/2]

template<typename FR_SH_T >
virtual const std::string & FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::name ( ) const
inlineprotectedvirtualinherited
Todo
See about storing name in this class and eliminate the need for this virtual method.

◆ name() [2/2]

template<typename FR_SH_T >
virtual const std::string & FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::name ( ) const
inlineprotectedvirtualinherited
Todo
See about storing name in this class and eliminate the need for this virtual method.

◆ ObjectStructName() [1/2]

template<typename FR_SH_T >
virtual const char * FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ ObjectStructName() [2/2]

template<typename FR_SH_T >
virtual const char * FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ pBytes() [1/2]

template<typename FR_SH_T >
cmn_streamsize_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedinherited

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.

◆ pBytes() [2/2]

template<typename FR_SH_T >
cmn_streamsize_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedinherited

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.

◆ pCreate() [1/2]

template<typename FR_SH_T >
virtual self_type * FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

◆ pCreate() [2/2]

template<typename FR_SH_T >
virtual self_type * FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

◆ Promote() [1/2]

template<typename FR_SH_T >
static promote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
inlinestaticinherited

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ Promote() [2/2]

template<typename FR_SH_T >
static promote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
inlinestaticinherited

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ promote() [1/2]

template<typename FR_SH_T >
virtual promote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::promote ( frame_spec_version_type Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object promoted to the next generation.

◆ promote() [2/2]

template<typename FR_SH_T >
virtual promote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::promote ( frame_spec_version_type Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object promoted to the next generation.

◆ pWrite() [1/2]

template<typename FR_SH_T >
virtual void FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

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

◆ pWrite() [2/2]

template<typename FR_SH_T >
virtual void FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

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

◆ StructDescription() [1/2]

template<typename FR_SH_T >
static const Common::Description * FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::StructDescription ( )
inlinestaticinherited

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructDescription() [2/2]

template<typename FR_SH_T >
static const Common::Description * FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::StructDescription ( )
inlinestaticinherited

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ vTOCQuery() [1/2]

virtual 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]

virtual 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.

Member Data Documentation

◆ comment

comment_type FrameCPP::v3::FrSH::comment
protectedinherited

Comment

◆ klass

class_type FrameCPP::v3::FrSH::klass
protectedinherited

Class number of structure being described

◆ name

name_type FrameCPP::v3::FrSH::name
protectedinherited

Name of structure being described by this dictionary structure


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