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

Implementation of FrTable according to the frame specification. More...

#include <FrTable.hh>

Inheritance diagram for FrameCPP::Version_6::FrTable:
Collaboration diagram for FrameCPP::Version_6::FrTable:

Public Types

typedef std::vector< STRING > column_name_container_type
 Collection of column names.
 
typedef INT_4U nRow_type
 Storage class for the number of rows.
 
typedef INT_2U nColumn_type
 Storage class for the number of columns.
 

Public Member Functions

virtual cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Stream size of object.
 
virtual FrTableCreate (istream_type &Stream) const
 constructor - virtual
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
bool operator== (const FrTable &RHS) const
 comparison operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
 
virtual cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Stream size of object.
 
virtual FrTableCreate (istream_type &Stream) const
 constructor - virtual
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
bool operator== (const FrTable &RHS) const
 comparison operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
 
class_type GetClass () const
 Retrieve the class identifier.
 
class_type GetClass () const
 Retrieve the class identifier.
 
virtual const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
virtual const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
ostream_type & WriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
ostream_type & WriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
virtual ObjectCreate () const
 constructor - virtual
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 
column_name_container_type GetColumnName () const
 Retrieve the list of column names.
 
column_name_container_type GetColumnName () const
 Retrieve the list of column names.
 
nColumn_type GetNColumn () const
 Retrieve the number of columns.
 
nColumn_type GetNColumn () const
 Retrieve the number of columns.
 
nRow_type GetNRow () const
 Retrieve the number of rows.
 
nRow_type GetNRow () const
 Retrieve the number of rows.
 
const column_type & RefColumn () const
 Retrieve reference to columns.
 
column_type & RefColumn ()
 Retrieve reference to columns.
 
const column_type & RefColumn () const
 Retrieve reference to columns.
 
column_type & RefColumn ()
 Retrieve reference to columns.
 

Static Public Member Functions

static const Common::Description * StructDescription ()
 Full description for the FrTable structure.
 
static const char * StructName ()
 Name of the frame specification structure.
 
static const Common::Description * StructDescription ()
 Full description for the FrTable structure.
 
static const char * StructName ()
 Name of the frame specification structure.
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
 Down grade an object.
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
 Down grade an object.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 

Static Public Attributes

static const Common::FrameSpec::Info::frame_object_types CLASS_ID
 Dictionary class id for this structure.
 

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 Source, promote_arg_type Obj, promote_stream_type *Stream) const
 Up grade an object.
 
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 Source, promote_arg_type Obj, promote_stream_type *Stream) const
 Up grade an object.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 

Detailed Description

Implementation of FrTable according to the frame specification.

Member Typedef Documentation

◆ column_name_container_type

template<typename TPTR_STRUCT , typename TColumn >
typedef std::vector< STRING > FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::column_name_container_type
inherited

Collection of column names.

This storage class is used to abstract the container type used to maintain the collection of column names used in the table. The container maintains the column order of the column names.

◆ nColumn_type

template<typename TPTR_STRUCT , typename TColumn >
typedef INT_2U FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::nColumn_type
inherited

Storage class for the number of columns.

This storage class is used to abstract the data type used to store the number of columns in the table.

◆ nRow_type

template<typename TPTR_STRUCT , typename TColumn >
typedef INT_4U FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::nRow_type
inherited

Storage class for the number of rows.

This storage class is used to abstract the data type used to store the number of rows in the table.

Member Function Documentation

◆ Bytes() [1/2]

FrameCPP::cmn_streamsize_type FrameCPP::Version_6::FrTable::Bytes ( const Common::StreamBase & Stream) const
virtual

Stream size of object.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes needed to write or read this class of object to or from a stream.

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

◆ Bytes() [2/2]

virtual cmn_streamsize_type FrameCPP::Version_6::FrTable::Bytes ( const Common::StreamBase & Stream) const
virtual

Stream size of object.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes needed to write or read this class of object to or from a stream.

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

◆ DemoteObject() [1/2]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type Target,
object_type Obj,
demote_stream_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.

◆ DemoteObject() [2/2]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type Target,
object_type Obj,
demote_stream_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() [1/2]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inlineinherited

Retrieve the class identifier.

Returns
The class identifier.

◆ GetClass() [2/2]

class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inherited

Retrieve the class identifier.

Returns
The class identifier.

◆ GetColumnName() [1/2]

template<typename TPTR_STRUCT , typename TColumn >
column_name_container_type FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::GetColumnName ( ) const
inlineinherited

Retrieve the list of column names.

Returns
The set of column names in column order.

◆ GetColumnName() [2/2]

template<typename TPTR_STRUCT , typename TColumn >
column_name_container_type FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::GetColumnName ( ) const
inlineinherited

Retrieve the list of column names.

Returns
The set of column names in column order.

◆ GetDescription() [1/2]

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.

◆ GetDescription() [2/2]

virtual const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
virtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

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

◆ GetNColumn() [1/2]

template<typename TPTR_STRUCT , typename TColumn >
nColumn_type FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::GetNColumn ( ) const
inlineinherited

Retrieve the number of columns.

Returns
The number of columns in the table.

◆ GetNColumn() [2/2]

template<typename TPTR_STRUCT , typename TColumn >
nColumn_type FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::GetNColumn ( ) const
inlineinherited

Retrieve the number of columns.

Returns
The number of columns in the table.

◆ GetNRow() [1/2]

template<typename TPTR_STRUCT , typename TColumn >
nRow_type FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::GetNRow ( ) const
inlineinherited

Retrieve the number of rows.

Returns
The number of rows in the table.

◆ GetNRow() [2/2]

template<typename TPTR_STRUCT , typename TColumn >
nRow_type FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::GetNRow ( ) const
inlineinherited

Retrieve the number of rows.

Returns
The number of rows in the table.

◆ ObjectStructName() [1/2]

const char * FrameCPP::Version_6::FrTable::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

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

◆ ObjectStructName() [2/2]

virtual const char * FrameCPP::Version_6::FrTable::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

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

◆ operator==() [1/2]

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

comparison operator

Parameters
[in]RHSRight hand side of equality expression.
Returns
True if the two FrTable objects being compared are equivelant, false otherwise.

◆ operator==() [2/2]

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

comparison operator

Parameters
[in]RHSRight hand side of equality expression.
Returns
True if the two FrTable objects being compared are equivelant, false otherwise.

◆ PromoteObject() [1/4]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_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/4]

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,
stream_base_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/4]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_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() [4/4]

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

◆ RefColumn() [1/4]

template<typename TPTR_STRUCT , typename TColumn >
FrTablePST< TPTR_STRUCT, TColumn >::column_type & FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::RefColumn ( )
inlineinherited

Retrieve reference to columns.

Returns
A reference to the container of columns.

◆ RefColumn() [2/4]

template<typename TPTR_STRUCT , typename TColumn >
column_type & FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::RefColumn ( )
inherited

Retrieve reference to columns.

Returns
A reference to the container of columns.

◆ RefColumn() [3/4]

template<typename TPTR_STRUCT , typename TColumn >
const FrTablePST< TPTR_STRUCT, TColumn >::column_type & FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::RefColumn ( ) const
inlineinherited

Retrieve reference to columns.

Returns
A constant reference to the container of columns.

◆ RefColumn() [4/4]

template<typename TPTR_STRUCT , typename TColumn >
const column_type & FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::RefColumn ( ) const
inherited

Retrieve reference to columns.

Returns
A constant reference to the container of columns.

◆ StructDescription() [1/2]

const Description * FrameCPP::Version_6::FrTable::StructDescription ( )
static

Full description for the FrTable structure.

Returns
A pointer to a static Description object containing the full description of an FrTable structure for the current frame specification.

◆ StructDescription() [2/2]

static const Common::Description * FrameCPP::Version_6::FrTable::StructDescription ( )
static

Full description for the FrTable structure.

Returns
A pointer to a static Description object containing the full description of an FrTable structure for the current frame specification.

◆ StructName() [1/2]

const char * FrameCPP::Version_6::FrTable::StructName ( )
inlinestatic

Name of the frame specification structure.

Returns
A pointer to a static address containing the name to be associated with this structure as specified by the frame specification.

◆ StructName() [2/2]

static const char * FrameCPP::Version_6::FrTable::StructName ( )
static

Name of the frame specification structure.

Returns
A pointer to a static address containing the name to be associated with this structure as specified by the frame specification.

◆ VerifyObject() [1/2]

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

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, and FrameCPP::Version_9::FrHeader.

◆ VerifyObject() [2/2]

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

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, and FrameCPP::Version_9::FrHeader.

◆ Write() [1/2]

void FrameCPP::Version_6::FrTable::Write ( ostream_type & Stream) const
virtual

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

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

◆ Write() [2/2]

virtual void FrameCPP::Version_6::FrTable::Write ( ostream_type & Stream) const
virtual

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

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

◆ WriteNext() [1/2]

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.

◆ WriteNext() [2/2]

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: