ldas-tools-framecpp 2.7.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
FrameCPP::Version_8::FrTable Class Reference

Table Data Structure Definition. More...

#include <FrTable.hh>

Inheritance diagram for FrameCPP::Version_8::FrTable:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_8::FrTable:
Collaboration graph
[legend]

Public Types

typedef std::vector< STRING > column_name_container_type
 Collection of column names.
 
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_4U nRow_type
 Storage class for the number of rows.
 
typedef INT_2U nColumn_type
 Storage class for the number of columns.
 
typedef INT_2U nColumn_type
 Storage class for the number of columns.
 

Public Member Functions

 FrTable ()
 Default constructor.
 
 FrTable (const FrTable &Source)
 Copy Constructor.
 
 FrTable (const FrTableNPS &Source)
 Copy Constructor.
 
 FrTable (const std::string &name, INT_4U nrows)
 Constructor.
 
 FrTable (Previous::FrTable &Source, Common::IStream *Stream)
 Promotion Constructor.
 
virtual ~FrTable ()
 Destructor.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
const std::string & 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 FrTableNPS &Source)
 Copy Constructor.
 
 FrTable (const std::string &name, INT_4U nrows)
 Constructor.
 
 FrTable (Previous::FrTable &Source, Common::IStream *Stream)
 Promotion Constructor.
 
virtual ~FrTable ()
 Destructor.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
const std::string & 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.
 
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 promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, Common::IStream *Stream)
 Promote previous version of object to this version.
 
static const Common::Description * StructDescription ()
 The description of structure.
 
static const char * StructName ()
 The name structure name of this object.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, Common::IStream *Stream)
 Promote previous version of object to this version.
 
static const Common::Description * StructDescription ()
 The description of structure.
 
static const char * StructName ()
 The name structure name of this object.
 
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 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, Common::IStream *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, Common::IStream *Stream) const
 Promotes object to another version of the frame spec.
 
virtual cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual FrTablepCreate (Common::IStream &Stream) const
 Virtual constructor.
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream.
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, Common::IStream *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, Common::IStream *Stream) const
 Promotes object to another version of the frame spec.
 
virtual cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual FrTablepCreate (Common::IStream &Stream) const
 Virtual constructor.
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream.
 

Detailed Description

Table Data Structure Definition.

Member Typedef Documentation

◆ column_name_container_type [1/2]

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.

◆ column_name_container_type [2/2]

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 [1/2]

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.

◆ nColumn_type [2/2]

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 [1/2]

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.

◆ nRow_type [2/2]

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.

Constructor & Destructor Documentation

◆ FrTable() [1/10]

FrTable::FrTable ( )

Default constructor.

Returns
A new instance of this object.

◆ FrTable() [2/10]

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/10]

FrTable::FrTable ( const FrTableNPS & Source)

Copy Constructor.

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

◆ FrTable() [4/10]

FrTable::FrTable ( const std::string & name,
INT_4U nrows )

Constructor.

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

◆ FrTable() [5/10]

FrTable::FrTable ( Previous::FrTable & Source,
Common::IStream * 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() [6/10]

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

Default constructor.

Returns
A new instance of this object.

◆ FrTable() [7/10]

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() [8/10]

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

Copy Constructor.

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

◆ FrTable() [9/10]

FrameCPP::Version_8::FrTable::FrTable ( const std::string & name,
INT_4U nrows )

Constructor.

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

◆ FrTable() [10/10]

FrameCPP::Version_8::FrTable::FrTable ( Previous::FrTable & Source,
Common::IStream * 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]

FrTable::demote_ret_type FrTable::demote ( INT_2U Target,
demote_arg_type Obj,
Common::IStream * Stream ) const
protectedvirtual

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]

virtual demote_ret_type FrameCPP::Version_8::FrTable::demote ( INT_2U Target,
demote_arg_type Obj,
Common::IStream * Stream ) const
protectedvirtual

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.

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

◆ 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 std::string & FrameCPP::Version_8::FrTable::GetNameSlow ( ) const

Retrieve the name of the table.

Returns
The name of the table.

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

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

const char * FrTable::ObjectStructName ( ) const
virtual

The name structure name of this object.

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

◆ ObjectStructName() [2/2]

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

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]

FrameCPP::cmn_streamsize_type FrTable::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, checksum_type >.

◆ pBytes() [2/2]

virtual cmn_streamsize_type FrameCPP::Version_8::FrTable::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, checksum_type >.

◆ pCreate() [1/2]

FrTable * FrTable::pCreate ( Common::IStream & Stream) const
protectedvirtual

Virtual constructor.

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

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

◆ pCreate() [2/2]

virtual FrTable * FrameCPP::Version_8::FrTable::pCreate ( Common::IStream & Stream) const
protectedvirtual

Virtual constructor.

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

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

◆ Promote() [1/2]

FrTable::promote_ret_type FrameCPP::Version_8::FrTable::Promote ( INT_2U Source,
promote_arg_type Obj,
Common::IStream * Stream )
inlinestatic

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]

static promote_ret_type FrameCPP::Version_8::FrTable::Promote ( INT_2U Source,
promote_arg_type Obj,
Common::IStream * Stream )
static

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]

FrTable::promote_ret_type FrTable::promote ( INT_2U Target,
promote_arg_type Obj,
Common::IStream * Stream ) const
protectedvirtual

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]

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

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]

void FrTable::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, checksum_type >.

◆ pWrite() [2/2]

virtual void FrameCPP::Version_8::FrTable::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, checksum_type >.

◆ 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 * FrTable::StructDescription ( )
static

The description of structure.

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

◆ StructDescription() [2/2]

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

The description of structure.

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

◆ StructName() [1/2]

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

The name structure name of this object.

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

The name of the structure is most often used when writing the description of the structure out to a stream.

Returns
The name of the structure.

◆ StructName() [2/2]

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

The name structure name of this object.

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

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