ldas-tools-framecpp  2.6.4
Classes | Public Types | 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>

Inheritance diagram for FrameCPP::Version_8::FrSH:
FrameCPP::Version_8::ObjectWithChecksum< Common::FrSH > FrameCPP::Common::TOCInfo FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type > FrameCPP::Common::FrSH FrameCPP::Common::FrameSpec::Object FrameCPP::Common::FrameSpec::ObjectInterface

Public Types

typedef ObjectWithChecksum< Common::FrSH, checksum_typeself_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef INT_2U cmn_classId_type
 
typedef IStringStream assign_stream_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_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
}
 
typedef STRING< INT_2U > string_2_type
 

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 STRINGGetName () const
 Return name of object. More...
 
virtual FrSHClone () 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 self_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *Stream)
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 
void TOCQuery (int InfoClass,...) const
 

Static Public Member Functions

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 * CheckSumDataComment ()
 Comment to be used in comment field of FrSE. More...
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
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 FrSHpCreate (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 class_type getClass () const
 Retrieve the class identifier. 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

Member Typedef Documentation

◆ assign_stream_type

typedef IStringStream FrameCPP::Common::FrSH::assign_stream_type
inherited

◆ cmn_classId_type

typedef INT_2U FrameCPP::Common::FrSH::cmn_classId_type
inherited

◆ demote_arg_type

◆ demote_ret_type

◆ frame_spec_version_type

◆ istream_type

◆ object_type

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ ostream_type

◆ promote_arg_type

◆ promote_ret_type

◆ self_type

◆ string_2_type

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

◆ unique_object_type

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 

Constructor & Destructor Documentation

◆ FrSH() [1/2]

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

Default constructor.

◆ FrSH() [2/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()

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

Desctructor.

Member Function Documentation

◆ assign()

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.

Implements FrameCPP::Common::FrSH.

◆ Bytes()

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , 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

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ CheckSumDataClass()

static const char* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment()

static const char* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ classId()

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

Interface method to return classId of dictionary class.

Implements FrameCPP::Common::FrSH.

◆ Clone()

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

Create a new instance of the object based on self.

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Create()

virtual self_type* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , 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.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ DataType() [1/2]

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

◆ DataType() [2/2]

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

◆ demote()

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.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ DemoteObject()

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type  Target,
object_type  Obj,
istream_type Stream 
)
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ GetClass()

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

Return class of object.

◆ getClass()

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetComment()

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

Return comment of object.

◆ GetDescription()

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
inlinevirtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetName()

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

Return name of object.

◆ name()

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

Interface method to return name of dictionary class.

Implements FrameCPP::Common::FrSH.

◆ ObjectStructName()

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

Dictionary class name.

Returns
The dictionary class name for this structure.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [1/2]

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

comparison operator

◆ operator==() [2/2]

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

comparison operator

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ pBytes()

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< Common::FrSH, checksum_type >.

◆ pCreate()

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< Common::FrSH, checksum_type >.

◆ promote()

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

Upgrade an object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ PromoteObject() [1/3]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [2/3]

template<typename PreviousType , typename CurrentType >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [3/3]

template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type  Target,
FrameSpec::ObjectInterface::frame_spec_version_type  Source,
FrameSpec::ObjectInterface::promote_arg_type  Obj,
IStream Stream 
)
inherited

◆ pWrite()

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< Common::FrSH, checksum_type >.

◆ StructName()

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

Return the dictionary name of the structure.

◆ TOCQuery()

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

◆ VerifyObject()

void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited

◆ vTOCQuery()

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()

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::Write ( ostream_type Stream) const
virtualinherited

Write object to the stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ WriteNext()

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

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