ldas-tools-framecpp 2.7.0
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
FrameCPP::Version_8::FrSH Class Reference

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

#include <FrSH.hh>

Inheritance diagram for FrameCPP::Version_8::FrSH:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_8::FrSH:
Collaboration graph
[legend]

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
 
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
 
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
 
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
 
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
 
typedef STRING< INT_2U > string_2_type
 
typedef STRING< INT_2U > string_2_type
 

Public Member Functions

 FrSH ()
 Default constructor.
 
 FrSH (const std::string &Name, INT_2U ClassId, const std::string &Comment)
 constructor
 
virtual ~FrSH ()
 Desctructor.
 
virtual const char * ObjectStructName () const
 Dictionary class name.
 
INT_2U GetClass () const
 Return class of object.
 
const std::string & GetComment () const
 Return comment of object.
 
const STRINGGetName () 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
 
virtual ~FrSH ()
 Desctructor.
 
virtual const char * ObjectStructName () const
 Dictionary class name.
 
INT_2U GetClass () const
 Return class of object.
 
const std::string & GetComment () const
 Return comment of object.
 
const STRINGGetName () 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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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 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.
 
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.
 
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.
 

Private Types

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_typeobject_base_type
 

Private Member Functions

 FrSH (Common::IStream &Stream)
 
 FrSH (Common::IStream &Stream)
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 

Private Attributes

struct FrameCPP::Version_8::FrSH::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_SH
 Dictionary class id for this structure.
 

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

◆ istream_type [1/2]

template<typename ObjectType , typename ChecksumType >
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ istream_type [2/2]

template<typename ObjectType , typename ChecksumType >
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ object_base_type [1/2]

◆ object_base_type [2/2]

◆ ostream_type [1/2]

template<typename ObjectType , typename ChecksumType >
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ ostream_type [2/2]

template<typename ObjectType , typename ChecksumType >
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ self_type [1/2]

template<typename ObjectType , typename ChecksumType >
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ self_type [2/2]

template<typename ObjectType , typename ChecksumType >
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ string_2_type [1/2]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

◆ string_2_type [2/2]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited
Enumerator
DT_CHAR_PTR 
DT_STRING_2 
DT_INT_2S 
DT_INT_2U 
DT_INT_4S 
DT_INT_4U 
DT_INT_8S 
DT_INT_8U 
DT_REAL_4 
DT_REAL_8 

◆ anonymous enum

anonymous enum
inherited
Enumerator
IC_EOQ 
IC_AMPLITUDE 
IC_CHANNEL_ID 
IC_DATA_QUALITY 
IC_DATA_VALID 
IC_DETECTOR 
IC_DETECTOR_PREFIX 
IC_DT 
IC_END 
IC_FRAME 
IC_GROUP_ID 
IC_GTIME_N 
IC_GTIME_S 
IC_ID 
IC_LOCAL_TIME 
IC_NAME 
IC_RUN 
IC_START 
IC_ULEAP_S 
IC_VERSION 

◆ anonymous enum

anonymous enum
inherited
Enumerator
DT_CHAR_PTR 
DT_STRING_2 
DT_INT_2S 
DT_INT_2U 
DT_INT_4S 
DT_INT_4U 
DT_INT_8S 
DT_INT_8U 
DT_REAL_4 
DT_REAL_8 

◆ anonymous enum

anonymous enum
inherited
Enumerator
IC_EOQ 
IC_AMPLITUDE 
IC_CHANNEL_ID 
IC_DATA_QUALITY 
IC_DATA_VALID 
IC_DETECTOR 
IC_DETECTOR_PREFIX 
IC_DT 
IC_END 
IC_FRAME 
IC_GROUP_ID 
IC_GTIME_N 
IC_GTIME_S 
IC_ID 
IC_LOCAL_TIME 
IC_NAME 
IC_RUN 
IC_START 
IC_ULEAP_S 
IC_VERSION 

Constructor & Destructor Documentation

◆ FrSH() [1/6]

FrameCPP::Version_8::FrSH::FrSH ( )

Default constructor.

◆ FrSH() [2/6]

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() [1/2]

FrameCPP::Version_8::FrSH::~FrSH ( )
virtual

Desctructor.

◆ FrSH() [3/6]

FrameCPP::Version_8::FrSH::FrSH ( Common::IStream Stream)
private

◆ FrSH() [4/6]

FrameCPP::Version_8::FrSH::FrSH ( )

Default constructor.

◆ FrSH() [5/6]

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]

virtual FrameCPP::Version_8::FrSH::~FrSH ( )
virtual

Desctructor.

◆ FrSH() [6/6]

FrameCPP::Version_8::FrSH::FrSH ( Common::IStream Stream)
private

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]

template<typename ObjectType , typename ChecksumType >
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::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]

template<typename ObjectType , typename ChecksumType >
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::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

◆ CheckSumDataClass() [1/2]

template<typename ObjectType , typename ChecksumType >
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

template<typename ObjectType , typename ChecksumType >
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/2]

template<typename ObjectType , typename ChecksumType >
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

template<typename ObjectType , typename ChecksumType >
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ classId() [1/2]

INT_2U FrameCPP::Version_8::FrSH::classId ( ) const
protectedvirtual

Interface method to return classId of dictionary class.

◆ classId() [2/2]

virtual INT_2U FrameCPP::Version_8::FrSH::classId ( ) const
protectedvirtual

Interface method to return classId of dictionary class.

◆ Clone() [1/2]

FrSH * FrameCPP::Version_8::FrSH::Clone ( ) const
virtual

Create a new instance of the object based on self.

◆ Clone() [2/2]

virtual FrSH * FrameCPP::Version_8::FrSH::Clone ( ) const
virtual

Create a new instance of the object based on self.

◆ Create() [1/6]

template<typename ObjectType , typename ChecksumType >
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [2/6]

template<typename ObjectType , typename ChecksumType >
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [3/6]

template<typename ObjectType , typename ChecksumType >
virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::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() [4/6]

template<typename ObjectType , typename ChecksumType >
virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::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() [5/6]

template<typename ObjectType , typename ChecksumType >
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream &  Buffer) const
inlineprivatevirtualinherited

constructor - virtual

◆ Create() [6/6]

template<typename ObjectType , typename ChecksumType >
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream &  Buffer) const
inlineprivatevirtualinherited

constructor - virtual

◆ DataType() [1/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T &  Data)
staticinherited

◆ DataType() [2/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T &  Data)
staticinherited

◆ DataType() [3/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T *  Data)
staticinherited

◆ DataType() [4/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T *  Data)
staticinherited

◆ demote() [1/2]

FrSH::demote_ret_type FrameCPP::Version_8::FrSH::demote ( INT_2U  Target,
demote_arg_type  Obj,
Common::IStream Stream 
) const
protectedvirtual

Down grade an object.

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_8::FrSH::demote ( INT_2U  Target,
demote_arg_type  Obj,
Common::IStream Stream 
) const
protectedvirtual

Down grade an object.

◆ GetClass() [1/2]

INT_2U FrameCPP::Version_8::FrSH::GetClass ( ) const
inline

Return class of object.

◆ GetClass() [2/2]

INT_2U FrameCPP::Version_8::FrSH::GetClass ( ) const

Return class of object.

◆ GetComment() [1/2]

const std::string & FrameCPP::Version_8::FrSH::GetComment ( ) const
inline

Return comment of object.

◆ GetComment() [2/2]

const std::string & FrameCPP::Version_8::FrSH::GetComment ( ) const

Return comment of object.

◆ GetName() [1/2]

const STRING & FrameCPP::Version_8::FrSH::GetName ( ) const
inline

Return name of object.

◆ GetName() [2/2]

const STRING & FrameCPP::Version_8::FrSH::GetName ( ) const

Return name of object.

◆ name() [1/2]

const std::string & FrameCPP::Version_8::FrSH::name ( ) const
protectedvirtual

Interface method to return name of dictionary class.

◆ name() [2/2]

virtual const std::string & FrameCPP::Version_8::FrSH::name ( ) const
protectedvirtual

Interface method to return name of dictionary class.

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

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

Dictionary class name.

Returns
The dictionary class name for this structure.

◆ operator==() [1/4]

bool FrameCPP::Version_8::FrSH::operator== ( const Common::FrameSpec::Object Obj) const
virtual

comparison operator

◆ operator==() [2/4]

virtual bool FrameCPP::Version_8::FrSH::operator== ( const Common::FrameSpec::Object Obj) const
virtual

comparison operator

◆ operator==() [3/4]

bool FrameCPP::Version_8::FrSH::operator== ( const FrSH RHS) const

comparison operator

◆ operator==() [4/4]

bool FrameCPP::Version_8::FrSH::operator== ( const FrSH RHS) const

comparison operator

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

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

◆ pCreate() [1/2]

FrSH * FrameCPP::Version_8::FrSH::pCreate ( Common::IStream Stream) const
protectedvirtual

Create a new instance of the object based on the input stream.

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

◆ pCreate() [2/2]

virtual FrSH * FrameCPP::Version_8::FrSH::pCreate ( Common::IStream Stream) const
protectedvirtual

Create a new instance of the object based on the input stream.

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

◆ promote() [1/2]

FrSH::promote_ret_type FrameCPP::Version_8::FrSH::promote ( INT_2U  Target,
promote_arg_type  Obj,
Common::IStream Stream 
) const
protectedvirtual

Upgrade an object.

◆ promote() [2/2]

virtual promote_ret_type FrameCPP::Version_8::FrSH::promote ( INT_2U  Target,
promote_arg_type  Obj,
Common::IStream Stream 
) const
protectedvirtual

Upgrade an object.

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

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

◆ StructName() [1/2]

const char * FrameCPP::Version_8::FrSH::StructName ( )
inlinestatic

Return the dictionary name of the structure.

◆ StructName() [2/2]

static const char * FrameCPP::Version_8::FrSH::StructName ( )
static

Return the dictionary name of the structure.

◆ TOCQuery() [1/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int  InfoClass,
  ... 
) const
inlineinherited

◆ TOCQuery() [2/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int  InfoClass,
  ... 
) const
inherited

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

Implements FrameCPP::Common::TOCInfo.

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

Implements FrameCPP::Common::TOCInfo.

◆ Write() [1/2]

template<typename ObjectType , typename ChecksumType >
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type Stream) const
virtualinherited

Write object to the stream.

◆ Write() [2/2]

template<typename ObjectType , typename ChecksumType >
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type Stream) const
virtualinherited

Write object to the stream.

Member Data Documentation

◆ m_chkSum

template<typename ObjectType , typename ChecksumType >
ChecksumType FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::m_chkSum
privateinherited

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

◆ m_data

struct FrameCPP::Version_8::FrSH::image_t FrameCPP::Version_8::FrSH::m_data
private

◆ s_object_id

static const Common::FrameSpec::Info::frame_object_types FrameCPP::Version_8::FrSH::s_object_id = Common::FrameSpec::Info::FSI_FR_SH
staticprivate

Dictionary class id for this structure.


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