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

Table Data Structure Definition. More...

#include <FrTable.hh>

Public Member Functions

 FrTable ()
 Default constructor.
 
 FrTable (const FrTable &Source)
 Copy Constructor.
 
 FrTable (const name_type &name, nRow_type nrows)
 Constructor.
 
 FrTable (Previous::FrTable &Source, stream_base_type *Stream)
 Promotion Constructor.
 
virtual ~FrTable ()
 Destructor.
 
const name_type & GetNameSlow () const
 Retrieve the name of the table.
 
FrTableMerge (const FrTable &RHS)
 Merge with another FrTable.
 
FrTableoperator+= (const FrTable &RHS)
 Concatinate with another FrTable.
 
bool operator== (const FrTable &RHS) const
 equality operator
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type
 
 FrTable ()
 Default constructor.
 
 FrTable (const FrTable &Source)
 Copy Constructor.
 
 FrTable (const name_type &name, nRow_type nrows)
 Constructor.
 
 FrTable (Previous::FrTable &Source, stream_base_type *Stream)
 Promotion Constructor.
 
virtual ~FrTable ()
 Destructor.
 
const name_type & GetNameSlow () const
 Retrieve the name of the table.
 
FrTableMerge (const FrTable &RHS)
 Merge with another FrTable.
 
FrTableoperator+= (const FrTable &RHS)
 Concatinate with another FrTable.
 
bool operator== (const FrTable &RHS) const
 equality operator
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type
 
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.
 

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 demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Demotes object to previous version of the frame spec.
 
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 cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual self_typepCreate (Common::IStream &Stream) const
 Virtual constructor.
 
virtual self_typepCreate (Common::IStream &Stream) const
 Virtual constructor.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Promotes object to another version of the frame spec.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Promotes object to another version of the frame spec.
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream.
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream.
 

Detailed Description

Table Data Structure Definition.

Constructor & Destructor Documentation

◆ FrTable() [1/8]

FrameCPP::Version_8::FrTable::FrTable ( )

Default constructor.

Returns
A new instance of this object.

◆ FrTable() [2/8]

FrTable::FrTable ( const FrTable & Source)

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
Returns
A new instance of this object.

◆ FrTable() [3/8]

FrTable::FrTable ( const name_type & name,
nRow_type nrows )

Constructor.

Parameters
[in]nameThe of this table.
[in]nrowsNumber of rows in table.
Returns
A new instance of the object.

◆ FrTable() [4/8]

FrTable::FrTable ( Previous::FrTable & Source,
stream_base_type * Stream )

Promotion Constructor.

Parameters
[in]SourceAn FrTable structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrTable structure was read.
Returns
A new instance of the object.

◆ FrTable() [5/8]

FrameCPP::Version_8::FrTable::FrTable ( )

Default constructor.

Returns
A new instance of this object.

◆ FrTable() [6/8]

FrameCPP::Version_8::FrTable::FrTable ( const FrTable & Source)

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
Returns
A new instance of this object.

◆ FrTable() [7/8]

FrameCPP::Version_8::FrTable::FrTable ( const name_type & name,
nRow_type nrows )

Constructor.

Parameters
[in]nameThe of this table.
[in]nrowsNumber of rows in table.
Returns
A new instance of the object.

◆ FrTable() [8/8]

FrameCPP::Version_8::FrTable::FrTable ( Previous::FrTable & Source,
stream_base_type * Stream )

Promotion Constructor.

Parameters
[in]SourceAn FrTable structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrTable structure was read.
Returns
A new instance of the object.

Member Function Documentation

◆ 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 T >
virtual demote_ret_type FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::demote ( INT_2U 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 T >
virtual demote_ret_type FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::demote ( INT_2U 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.

◆ GetNameSlow() [1/2]

const std::string & FrTable::GetNameSlow ( ) const

Retrieve the name of the table.

Returns
The name of the table.

◆ GetNameSlow() [2/2]

const name_type & FrameCPP::Version_8::FrTable::GetNameSlow ( ) const

Retrieve the name of the table.

Returns
The name of the table.

◆ Merge() [1/2]

FrTable & FrTable::Merge ( const FrTable & RHS)

Merge with another FrTable.

Parameters
[in]RHSThe source of the information to append to this FrTable structure.
Returns
A reference to this object

◆ Merge() [2/2]

FrTable & FrameCPP::Version_8::FrTable::Merge ( const FrTable & RHS)

Merge with another FrTable.

Parameters
[in]RHSThe source of the information to append to this FrTable structure.
Returns
A reference to this object

◆ ObjectStructName() [1/2]

template<typename T >
virtual const char * FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::ObjectStructName ( ) const
inlineprotectedvirtualinherited

The name structure name of this object.

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

◆ ObjectStructName() [2/2]

template<typename T >
virtual const char * FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::ObjectStructName ( ) const
inlineprotectedvirtualinherited

The name structure name of this object.

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

◆ operator+=() [1/2]

FrTable & FrTable::operator+= ( const FrTable & RHS)

Concatinate with another FrTable.

Parameters
[in]RHSThe source of the information to append to this FrTable structure.
Returns
A reference to this object

◆ operator+=() [2/2]

FrTable & FrameCPP::Version_8::FrTable::operator+= ( const FrTable & RHS)

Concatinate with another FrTable.

Parameters
[in]RHSThe source of the information to append to this FrTable structure.
Returns
A reference to this object

◆ operator==() [1/4]

bool FrTable::operator== ( const Common::FrameSpec::Object & RHS) const
virtual

equality operator for abstract data type

Parameters
[in]RHSThe object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [2/4]

virtual bool FrameCPP::Version_8::FrTable::operator== ( const Common::FrameSpec::Object & RHS) const
virtual

equality operator for abstract data type

Parameters
[in]RHSThe object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [3/4]

bool FrameCPP::Version_8::FrTable::operator== ( const FrTable & RHS) const
inline

equality operator

Tests the equality of two tables.

Parameters
[in]RHSThe FrTable object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.
Parameters
[in]RHSRight hand side of equality expression.
Returns
True if the two tables are equivelant, false otherwise.

◆ operator==() [4/4]

bool FrameCPP::Version_8::FrTable::operator== ( const FrTable & RHS) const

equality operator

Parameters
[in]RHSThe FrTable object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ pBytes() [1/2]

template<typename T >
virtual cmn_streamsize_type FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::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.

◆ pBytes() [2/2]

template<typename T >
virtual cmn_streamsize_type FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::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.

◆ pCreate() [1/2]

template<typename T >
virtual self_type * FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::pCreate ( Common::IStream & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

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

◆ pCreate() [2/2]

template<typename T >
virtual self_type * FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::pCreate ( Common::IStream & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

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

◆ Promote() [1/2]

template<typename T >
ClassicIO< T >::promote_ret_type FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
staticinherited

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 T >
static promote_ret_type FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
staticinherited

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 T >
virtual promote_ret_type FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::promote ( INT_2U 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 T >
virtual promote_ret_type FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::promote ( INT_2U 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 T >
virtual void FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::pWrite ( Common::OStream & 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 T >
virtual void FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::pWrite ( Common::OStream & 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 T >
static const Common::Description * FrameCPP::Version_8::FrTableImpl::ClassicIO< 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 T >
static const Common::Description * FrameCPP::Version_8::FrTableImpl::ClassicIO< T >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

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