ldas-tools-framecpp  2.5.8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | 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:
FrameCPP::Version_8::ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn > FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > FrameCPP::Common::FrameSpec::Object FrameCPP::Common::FrameSpec::ObjectInterface

Public Types

typedef ObjectWithChecksum
< Common::FrameSpec::Object,
checksum_type
self_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef TPTR_STRUCT ptr_struct_type
 
typedef TColumn column_type
 
typedef column_type::iterator iterator
 
typedef column_type::const_iterator const_iterator
 
typedef std::vector< STRINGcolumn_name_container_type
 Collection of column names. More...
 
typedef INT_4U nRow_type
 Storage class for the number of rows. More...
 
typedef INT_2U nColumn_type
 Storage class for the number of columns. More...
 

Public Member Functions

 FrTable ()
 Default constructor. More...
 
 FrTable (const FrTable &Source)
 Copy Constructor. More...
 
 FrTable (const FrTableNPS &Source)
 Copy Constructor. More...
 
 FrTable (const std::string &name, INT_4U nrows)
 Constructor. More...
 
 FrTable (Previous::FrTable &Source, Common::IStream *Stream)
 Promotion Constructor. More...
 
virtual ~FrTable ()
 Destructor. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
const std::string & GetNameSlow () const
 Retrieve the name of the table. More...
 
FrTableMerge (const FrTable &RHS)
 Merge with another FrTable. More...
 
FrTableoperator+= (const FrTable &RHS)
 Concatinate with another FrTable. More...
 
bool operator== (const FrTable &RHS) const
 equality operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type 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 void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectClone () const
 constructor - virtual copy constructor More...
 
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *Stream)
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 
column_name_container_type GetColumnName () const
 Retrieve the list of column names. More...
 
nColumn_type GetNColumn () const
 Retrieve the number of columns. More...
 
nRow_type GetNRow () const
 Retrieve the number of rows. More...
 
const column_typeRefColumn () const
 Retrieve reference to columns. More...
 
column_typeRefColumn ()
 Retrieve reference to columns. More...
 
bool operator== (const FrTablePST &RHS)
 

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. More...
 
static const Common::DescriptionStructDescription ()
 The description of structure. More...
 
static const char * StructName ()
 The name structure name of this object. 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 object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 

Static Public Attributes

static const
Common::FrameSpec::Info::frame_object_types 
CLASS_ID = Common::FrameSpec::Info::FSI_FR_TABLE
 Dictionary class id for this structure. More...
 
static const INT_2U MAX_REF = 1
 

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. More...
 
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. More...
 
virtual cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual FrTablepCreate (Common::IStream &Stream) const
 Virtual constructor. More...
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream. More...
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 

Protected Attributes

refs_type m_refs
 

Detailed Description

Table Data Structure Definition.

Member Typedef Documentation

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.

template<typename TPTR_STRUCT , typename TColumn >
typedef TColumn FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::column_type
inherited
template<typename TPTR_STRUCT , typename TColumn >
typedef column_type::const_iterator FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::const_iterator
inherited
template<typename TPTR_STRUCT , typename TColumn >
typedef column_type::iterator FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::iterator
inherited
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.

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.

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

Constructor & Destructor Documentation

FrTable::FrTable ( )

Default constructor.

Returns
A new instance of this object.
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::FrTable ( const FrTableNPS Source)

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
Returns
A new instance of this object.
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::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::~FrTable ( )
virtual

Destructor.

Member Function Documentation

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

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

static const char* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object , checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

static const char* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object , checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

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

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.

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

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type  Target,
object_type  Obj,
istream_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.
FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inlineinherited

Retrieve the class identifier.

Returns
The class identifier.
FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

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

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

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

Retrieve the name of the table.

Returns
The name of the table.
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.
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.
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
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.

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

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

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

template<typename TPTR_STRUCT , typename TColumn >
bool FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::operator== ( const FrTablePST< TPTR_STRUCT, TColumn > &  RHS)
inherited
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< Common::FrameSpec::Object, checksum_type >.

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< Common::FrameSpec::Object, checksum_type >.

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

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

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_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.
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,
istream_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.
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type  Target,
FrameSpec::ObjectInterface::frame_spec_version_type  Source,
FrameSpec::ObjectInterface::promote_arg_type  Obj,
IStream Stream 
)
inherited
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< Common::FrameSpec::Object, checksum_type >.

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.
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.
const Description * FrTable::StructDescription ( )
static

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.
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.
void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object , checksum_type >::Write ( ostream_type Stream) const
virtualinherited

Write object to the stream.

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

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.

Member Data Documentation

const Common::FrameSpec::Info::frame_object_types FrameCPP::Version_8::FrTable::CLASS_ID = Common::FrameSpec::Info::FSI_FR_TABLE
static

Dictionary class id for this structure.

template<typename TPTR_STRUCT , typename TColumn >
refs_type FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::m_refs
protectedinherited
template<typename TPTR_STRUCT , typename TColumn >
const INT_2U FrameCPP::Version_4::FrTablePST< TPTR_STRUCT, TColumn >::MAX_REF = 1
staticinherited

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