ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_9::FrSE Class Reference

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

#include <FrSE.hh>

Inheritance diagram for FrameCPP::Version_9::FrSE:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_9::FrSE:
Collaboration graph
[legend]

Public Types

typedef STRING io_name_type
typedef STRING io_id_type
typedef STRING io_comment_type
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
typedef const char *const struct_name_type
typedef const char *const struct_desc_type
typedef INT_2U const struct_id_type
typedef std::string name_type
typedef std::string classId_type
typedef std::string comment_type

Public Member Functions

 FrSE ()
 Default constructor.
 FrSE (const name_type &Name, const classId_type &ClassId, const comment_type &Comment="")
 constructor
virtual ~FrSE ()
 Desctructor.
bool operator== (const FrSE &RHS) const
 comparison operator
 FrSE ()
 Default constructor.
 FrSE (const name_type &Name, const classId_type &ClassId, const comment_type &Comment="")
 constructor
virtual ~FrSE ()
 Desctructor.
bool operator== (const FrSE &RHS) const
 comparison operator
bool operator== (const Common::FrameSpec::Object &Obj) const
Common::FrameSpec::Object * Clone () const
virtual const char * ObjectStructName () const
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_type * Create (istream_type &Stream) const
 Virtual constructor.
virtual self_type * Create (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.
bool operator== (const FrSE &RHS) const
 comparison operator
const name_type & GetName () const
 Return name of object.
const classId_type & GetClass () const
 Return class of object.
const comment_type & GetComment () const
 Return comment of object.

Static Public Member Functions

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_name_type FrameSpecName ()
static struct_name_type StructName ()
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.

Static Public Attributes

static struct_name_type struct_name
static struct_desc_type struct_desc
static struct_id_type struct_id

Protected Types

typedef ObjectWithChecksum< Common::FrameSpec::Object > object_type

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Down grade an object.
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Upgrade an object.
virtual cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
virtual self_type * pCreate (istream_type &Stream) const
 Create a new instance of the object based on the input stream.
void pWrite (Common::OStream &Stream) const
 Write the structure to the stream.

Protected Attributes

name_type name
classId_type classId
 The string representation of data type of the element.
comment_type comment
 Description of the element.

Private Types

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > object_base_type

Private Member Functions

virtual Object * Create () const
virtual Object * Create (std::istream &Buffer) const
 constructor - virtual
virtual Object * Create () const
virtual Object * Create (std::istream &Buffer) const
 constructor - virtual
void save (Archive &ar, const unsigned int version) const
void load (Archive &ar, const unsigned int version)

Private Attributes

ChecksumType m_chkSum
 Structure checksum.

Detailed Description

Contains field information of a dictionary structure.

This class gives information describing a single field of the class structure being described. In a dicitionary structure, there may be multiple occurances of FrSE. The order of the FrSE corresponds to the order of the fields as written to the stream.

See also
FrSH

Member Typedef Documentation

◆ classId_type

typedef std::string FrameCPP::v3::FrSE::classId_type
inherited

◆ comment_type

typedef std::string FrameCPP::v3::FrSE::comment_type
inherited

◆ io_comment_type

typedef STRING FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >::io_comment_type
inherited

◆ io_id_type

typedef STRING FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >::io_id_type
inherited

◆ io_name_type

typedef STRING FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >::io_name_type
inherited

◆ 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

◆ name_type

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

◆ object_base_type

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > FrameCPP::Version_9::ObjectWithChecksum< Common::FrameSpec::Object >::object_base_type
privateinherited

◆ object_type

typedef ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >::object_type
protectedinherited

◆ 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

◆ struct_desc_type

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_id_type

template<typename Object_T>
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_name_type

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

Constructor & Destructor Documentation

◆ FrSE() [1/4]

FrameCPP::Version_9::FrSE::FrSE ( )

Default constructor.

◆ FrSE() [2/4]

FrSE::FrSE ( const name_type & Name,
const classId_type & ClassId,
const comment_type & Comment = "" )

constructor

Parameters
[in]NameName of an element of the structure being described by this dictionary structure.
[in]ClassIdThe data type of the element being described by this dictionary structure.
[in]CommentDescription of the element being described by this dictionary strucutre.

◆ ~FrSE() [1/2]

FrSE::~FrSE ( )
virtual

Desctructor.

◆ FrSE() [3/4]

FrameCPP::Version_9::FrSE::FrSE ( )

Default constructor.

◆ FrSE() [4/4]

FrameCPP::Version_9::FrSE::FrSE ( const name_type & Name,
const classId_type & ClassId,
const comment_type & Comment = "" )

constructor

Parameters
[in]NameName of an element of the structure being described by this dictionary structure.
[in]ClassIdThe data type of the element being described by this dictionary structure.
[in]CommentDescription of the element being described by this dictionary strucutre.

◆ ~FrSE() [2/2]

virtual FrameCPP::Version_9::FrSE::~FrSE ( )
virtual

Desctructor.

Member Function Documentation

◆ 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>
template 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>
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>
template 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>
const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ Clone()

Common::FrameSpec::Object * FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >::Clone ( ) const
inlineinherited

◆ Create() [1/6]

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

Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.

◆ Create() [2/6]

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

Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.

◆ 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

◆ demote()

virtual demote_ret_type FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Down grade an object.

◆ FrameSpecDescription()

template<typename Object_T>
struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId()

template<typename Object_T>
struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecName()

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ GetClass()

const classId_type & FrameCPP::v3::FrSE::GetClass ( ) const
inlineinherited

Return class of object.

◆ GetComment()

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

Return comment of object.

◆ GetName()

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

Return name of object.

◆ load()

void FrameCPP::Version_9::FrSEImpl::SerialIO< FrSE >::load ( Archive & ar,
const unsigned int version )
inlineprivateinherited

◆ ObjectStructName()

virtual const char * FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >::ObjectStructName ( ) const
inlinevirtualinherited

◆ operator==() [1/4]

bool FrameCPP::v3::FrSE::operator== ( const FrSE & RHS) const
inlineinherited

comparison operator

◆ operator==() [2/4]

bool FrameCPP::Version_9::FrSE::operator== ( const FrSE & RHS) const
inline

comparison operator

◆ operator==() [3/4]

bool FrameCPP::Version_9::FrSE::operator== ( const FrSE & RHS) const
inline

comparison operator

◆ operator==() [4/4]

bool FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >::operator== ( const Common::FrameSpec::Object & Obj) const
inherited

◆ pBytes()

virtual cmn_streamsize_type FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtualinherited

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

virtual self_type * FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >::pCreate ( istream_type & Stream) const
inlineprotectedvirtualinherited

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

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

◆ promote()

virtual promote_ret_type FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Upgrade an object.

◆ pWrite()

void FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >::pWrite ( Common::OStream & Stream) const
inlineprotectedvirtualinherited

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

◆ save()

void FrameCPP::Version_9::FrSEImpl::SerialIO< FrSE >::save ( Archive & ar,
const unsigned int version ) const
inlineprivateinherited

◆ StructDescription()

const Common::Description * FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ StructName()

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

◆ 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

◆ classId

classId_type FrameCPP::v3::FrSE::classId
protectedinherited

The string representation of data type of the element.

◆ comment

comment_type FrameCPP::v3::FrSE::comment
protectedinherited

Description of the element.

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

◆ name

name_type FrameCPP::v3::FrSE::name
protectedinherited

Name of an element of the structure being described. All element names within the structure must be unique.

◆ struct_desc

template<typename Object_T>
struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc
staticinherited

◆ struct_id

template<typename Object_T>
struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id
staticinherited

◆ struct_name

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name
staticinherited
The documentation for this class was generated from the following files:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version9/FrSE.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version9/FrSE.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version9/FrSE.cc