ldas-tools-framecpp  2.7.0
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::FrSE Class Reference

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

#include <FrSE.hh>

Inheritance diagram for FrameCPP::Version_8::FrSE:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_8::FrSE:
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
 

Public Member Functions

 FrSE ()
 Default constructor. More...
 
 FrSE (const std::string &Name, const std::string &ClassId, const std::string &Comment="")
 constructor More...
 
virtual ~FrSE ()
 Desctructor. More...
 
virtual const char * ObjectStructName () const
 Dictionary class name. More...
 
std::string GetClass () const
 Return class of object. More...
 
std::string GetComment () const
 Return comment of object. More...
 
std::string GetName () const
 Return name of object. More...
 
virtual FrSEClone () const
 Create a new instance of the object based on self. More...
 
bool operator== (const FrSE &RHS) const
 comparison operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
 FrSE ()
 Default constructor. More...
 
 FrSE (const std::string &Name, const std::string &ClassId, const std::string &Comment="")
 constructor More...
 
virtual ~FrSE ()
 Desctructor. More...
 
virtual const char * ObjectStructName () const
 Dictionary class name. More...
 
std::string GetClass () const
 Return class of object. More...
 
std::string GetComment () const
 Return comment of object. More...
 
std::string GetName () const
 Return name of object. More...
 
virtual FrSEClone () const
 Create a new instance of the object based on self. More...
 
bool operator== (const FrSE &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 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. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 

Static Public Member Functions

static const char * StructName ()
 Return the dictionary name of the structure. More...
 
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 * 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 const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE. More...
 

Protected Member Functions

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

Private Types

typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 
typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 

Private Member Functions

 FrSE (Common::IStream &Stream)
 Constructor (Stream) More...
 
 FrSE (Common::IStream &Stream)
 Constructor (Stream) More...
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 

Private Attributes

struct FrameCPP::Version_8::FrSE::image_t m_data
 
ChecksumType m_chkSum
 Structure checksum. More...
 

Static Private Attributes

static const Common::FrameSpec::Info::frame_object_types s_object_id = Common::FrameSpec::Info::FSI_FR_SE
 Dictionary class id for this structure. More...
 

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

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

◆ object_type [1/2]

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

Constructor & Destructor Documentation

◆ FrSE() [1/6]

FrSE::FrSE ( )

Default constructor.

◆ FrSE() [2/6]

FrSE::FrSE ( const std::string &  Name,
const std::string &  ClassId,
const std::string &  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/6]

FrSE::FrSE ( Common::IStream Stream)
private

Constructor (Stream)

Construct a new FrSE by reading the input stream.

Parameters
[in]StreamThe stream from which to construct the new FrSE structure.

◆ FrSE() [4/6]

FrameCPP::Version_8::FrSE::FrSE ( )

Default constructor.

◆ FrSE() [5/6]

FrameCPP::Version_8::FrSE::FrSE ( const std::string &  Name,
const std::string &  ClassId,
const std::string &  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_8::FrSE::~FrSE ( )
virtual

Desctructor.

◆ FrSE() [6/6]

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

Constructor (Stream)

Construct a new FrSE by reading the input stream.

Parameters
[in]StreamThe stream from which to construct the new FrSE structure.

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

◆ Clone() [1/2]

FrSE * FrSE::Clone ( ) const
virtual

Create a new instance of the object based on self.

◆ Clone() [2/2]

virtual FrSE* FrameCPP::Version_8::FrSE::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

◆ demote() [1/2]

FrSE::demote_ret_type FrSE::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::FrSE::demote ( INT_2U  Target,
demote_arg_type  Obj,
Common::IStream Stream 
) const
protectedvirtual

Down grade an object.

◆ GetClass() [1/2]

std::string FrameCPP::Version_8::FrSE::GetClass ( ) const
inline

Return class of object.

◆ GetClass() [2/2]

std::string FrameCPP::Version_8::FrSE::GetClass ( ) const

Return class of object.

◆ GetComment() [1/2]

std::string FrameCPP::Version_8::FrSE::GetComment ( ) const
inline

Return comment of object.

◆ GetComment() [2/2]

std::string FrameCPP::Version_8::FrSE::GetComment ( ) const

Return comment of object.

◆ GetName() [1/2]

std::string FrSE::GetName ( ) const

Return name of object.

◆ GetName() [2/2]

std::string FrameCPP::Version_8::FrSE::GetName ( ) const

Return name of object.

◆ ObjectStructName() [1/2]

const char * FrSE::ObjectStructName ( ) const
virtual

Dictionary class name.

Returns
The dictionary class name for this structure.

◆ ObjectStructName() [2/2]

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

Dictionary class name.

Returns
The dictionary class name for this structure.

◆ operator==() [1/4]

bool FrSE::operator== ( const Common::FrameSpec::Object Obj) const
virtual

comparison operator

◆ operator==() [2/4]

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

comparison operator

◆ operator==() [3/4]

bool FrSE::operator== ( const FrSE RHS) const

comparison operator

◆ operator==() [4/4]

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

comparison operator

◆ pBytes() [1/2]

INT_8U FrSE::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::FrSE::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]

FrSE * FrSE::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 FrSE* FrameCPP::Version_8::FrSE::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]

FrSE::promote_ret_type FrSE::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::FrSE::promote ( INT_2U  Target,
promote_arg_type  Obj,
Common::IStream Stream 
) const
protectedvirtual

Upgrade an object.

◆ pWrite() [1/2]

void FrSE::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::FrSE::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::FrSE::StructName ( )
inlinestatic

Return the dictionary name of the structure.

◆ StructName() [2/2]

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

Return the dictionary name of the structure.

◆ 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::FrSE::image_t FrameCPP::Version_8::FrSE::m_data
private

◆ s_object_id

static const Common::FrameSpec::Info::frame_object_types FrameCPP::Version_8::FrSE::s_object_id = Common::FrameSpec::Info::FSI_FR_SE
staticprivate

Dictionary class id for this structure.


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