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

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

#include <FrTable.hh>

Inheritance diagram for FrameCPP::Version_4::FrTable:
Collaboration diagram for FrameCPP::Version_4::FrTable:

Public Types

typedef FrameSpec::version_type frame_spec_version_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type demote_ret_type
 
typedef stream_base_type demote_stream_type
 
typedef stream_base_type demote_stream_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef object_type promote_ret_type
 
typedef stream_base_type promote_stream_type
 
typedef stream_base_type promote_stream_type
 
typedef PTR_STRUCT ptr_struct_type
 
typedef PTR_STRUCT ptr_struct_type
 
typedef PTR_STRUCT ptr_struct_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetName > column_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetName > column_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetName > column_type
 
typedef column_type::iterator iterator
 
typedef column_type::iterator iterator
 
typedef column_type::iterator iterator
 
typedef column_type::const_iterator const_iterator
 
typedef column_type::const_iterator const_iterator
 
typedef column_type::const_iterator const_iterator
 
typedef std::vector< STRINGcolumn_name_container_type
 Collection of column names.
 
typedef std::vector< STRINGcolumn_name_container_type
 Collection of column names.
 
typedef std::vector< STRINGcolumn_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_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.
 
typedef INT_2U nColumn_type
 Storage class for the number of columns.
 

Public Member Functions

 FrTable ()
 Default constructor.
 
 FrTable (const FrTable &table)
 
 FrTable (const std::string &name, INT_4U nrows)
 
 FrTable (const std::string &Name, const std::string &Comment, nRow_type NRows, column_name_container_type ColumnNames)
 
 FrTable (const FrTableNPS &Source)
 
virtual ~FrTable ()
 
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.
 
const std::string & GetNameSlow () const
 
FrTableMerge (const FrTable &RHS)
 Merge with another FrAdcData.
 
FrTableoperator+= (const FrTable &RHS)
 Concatination operator.
 
bool operator== (const FrTable &RHS) const
 comparison operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
 
 FrTable ()
 Default constructor.
 
 FrTable (const FrTable &table)
 
 FrTable (const std::string &name, INT_4U nrows)
 
 FrTable (const std::string &Name, const std::string &Comment, nRow_type NRows, column_name_container_type ColumnNames)
 
 FrTable (const FrTableNPS &Source)
 
virtual ~FrTable ()
 
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.
 
const std::string & GetNameSlow () const
 
FrTableMerge (const FrTable &RHS)
 Merge with another FrAdcData.
 
FrTableoperator+= (const FrTable &RHS)
 Concatination operator.
 
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 DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
virtual const DescriptionGetDescription (ostream_type &Stream) const
 
virtual const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
virtual const DescriptionGetDescription (ostream_type &Stream) const
 
frame_spec_version_type FrameSpecVersion () const
 
frame_spec_version_type FrameSpecVersion () const
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
ostream_typeWriteNext (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
 
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, promote_stream_type *Stream)
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 
void AppendComment (const std::string &comment)
 Add additional information to the comment.
 
void AppendComment (const std::string &comment)
 Add additional information to the comment.
 
const std::string & GetComment () const
 Retrieve the comment.
 
const std::string & GetComment () const
 Retrieve the comment.
 
const std::string & GetName () const
 Retrieve the name.
 
const std::string & GetName () const
 Retrieve the name.
 
column_name_container_type GetColumnName () const
 Retrieve the list of column names.
 
column_name_container_type GetColumnName () const
 Retrieve the list of column names.
 
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.
 
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.
 
nRow_type GetNRow () const
 Retrieve the number of rows.
 
nRow_type GetNRow () const
 Retrieve the number of rows.
 
const column_typeRefColumn () const
 Retrieve reference to columns.
 
column_typeRefColumn ()
 Retrieve reference to columns.
 
const column_typeRefColumn () const
 Retrieve reference to columns.
 
column_typeRefColumn ()
 Retrieve reference to columns.
 
const column_typeRefColumn () const
 Retrieve reference to columns.
 
column_typeRefColumn ()
 Retrieve reference to columns.
 
const column_typeRefColumn () const
 Retrieve reference to columns.
 
column_typeRefColumn ()
 Retrieve reference to columns.
 
bool operator== (const FrTablePST &RHS)
 

Static Public Member Functions

static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 
static const Common::DescriptionStructDescription ()
 Full description for the FrTable structure.
 
static const char * StructName ()
 Name of the frame specification structure.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 
static const Common::DescriptionStructDescription ()
 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
 
static const INT_2U MAX_REF
 
static const INT_2U MAX_REF
 

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.
 
std::string & getComment ()
 Retrieve the comment.
 
std::string & getComment ()
 Retrieve the comment.
 
void setName (const std::string &Name)
 Establish name.
 
void setName (const std::string &Name)
 Establish name.
 

Protected Attributes

data_type m_data
 
refs_type m_refs
 
refs_type m_refs
 

Private Member Functions

 FrTable (istream_type &Stream)
 
 FrTable (istream_type &Stream)
 

Private Attributes

const class_type m_class
 Storage for the class identifier.
 
const Description *const m_desc
 Description for parent class.
 
const frame_spec_version_type frame_spec_version
 Version of the frame specification.
 

Detailed Description

Implementation of FrTable according to the frame specification.

Member Typedef Documentation

◆ column_name_container_type [1/3]

typedef std::vector< STRING > FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::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/3]

typedef std::vector< STRING > FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::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 [3/3]

typedef std::vector< STRING > FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::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_type [1/3]

typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::column_type
inherited

◆ column_type [2/3]

typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::column_type
inherited

◆ column_type [3/3]

typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::column_type
inherited

◆ const_iterator [1/3]

typedef column_type::const_iterator FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::const_iterator
inherited

◆ const_iterator [2/3]

typedef column_type::const_iterator FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::const_iterator
inherited

◆ const_iterator [3/3]

typedef column_type::const_iterator FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::const_iterator
inherited

◆ demote_arg_type [1/2]

◆ demote_arg_type [2/2]

◆ demote_ret_type [1/2]

◆ demote_ret_type [2/2]

◆ demote_stream_type [1/2]

◆ demote_stream_type [2/2]

◆ frame_spec_version_type [1/2]

◆ frame_spec_version_type [2/2]

◆ iterator [1/3]

◆ iterator [2/3]

◆ iterator [3/3]

◆ nColumn_type [1/3]

typedef INT_2U FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::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/3]

typedef INT_2U FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::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 [3/3]

typedef INT_2U FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::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/3]

typedef INT_4U FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::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/3]

typedef INT_4U FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::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 [3/3]

typedef INT_4U FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::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.

◆ object_type [1/2]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ object_type [2/2]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ promote_arg_type [1/2]

◆ promote_arg_type [2/2]

◆ promote_ret_type [1/2]

◆ promote_ret_type [2/2]

◆ promote_stream_type [1/2]

◆ promote_stream_type [2/2]

◆ ptr_struct_type [1/3]

typedef PTR_STRUCT FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::ptr_struct_type
inherited

◆ ptr_struct_type [2/3]

typedef PTR_STRUCT FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::ptr_struct_type
inherited

◆ ptr_struct_type [3/3]

typedef PTR_STRUCT FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::ptr_struct_type
inherited

◆ unique_object_type [1/2]

◆ unique_object_type [2/2]

Constructor & Destructor Documentation

◆ FrTable() [1/12]

FrameCPP::Version_4::FrTable::FrTable ( )

Default constructor.

◆ FrTable() [2/12]

FrameCPP::Version_4::FrTable::FrTable ( const FrTable & table)

◆ FrTable() [3/12]

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

◆ FrTable() [4/12]

FrameCPP::Version_4::FrTable::FrTable ( const std::string & Name,
const std::string & Comment,
nRow_type NRows,
column_name_container_type ColumnNames )

◆ FrTable() [5/12]

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

◆ ~FrTable() [1/2]

FrameCPP::Version_4::FrTable::~FrTable ( )
virtual

◆ FrTable() [6/12]

FrameCPP::Version_4::FrTable::FrTable ( istream_type & Stream)
private

◆ FrTable() [7/12]

FrameCPP::Version_4::FrTable::FrTable ( )

Default constructor.

◆ FrTable() [8/12]

FrameCPP::Version_4::FrTable::FrTable ( const FrTable & table)

◆ FrTable() [9/12]

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

◆ FrTable() [10/12]

FrameCPP::Version_4::FrTable::FrTable ( const std::string & Name,
const std::string & Comment,
nRow_type NRows,
column_name_container_type ColumnNames )

◆ FrTable() [11/12]

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

◆ ~FrTable() [2/2]

virtual FrameCPP::Version_4::FrTable::~FrTable ( )
virtual

◆ FrTable() [12/12]

FrameCPP::Version_4::FrTable::FrTable ( istream_type & Stream)
private

Member Function Documentation

◆ AppendComment() [1/2]

void FrTableNPS::AppendComment ( const std::string & comment)
inlineinherited

Add additional information to the comment.

Parameters
[in]commentThe text to append to the comment.

◆ AppendComment() [2/2]

void FrameCPP::Version_4::FrTableNPS::AppendComment ( const std::string & comment)
inherited

Add additional information to the comment.

Parameters
[in]commentThe text to append to the comment.

◆ Bytes() [1/2]

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

Stream size of object.

Parameters
[in]StreamThe input or output stream used in conjunction with this object.
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_4::FrTable::Bytes ( const Common::StreamBase & Stream) const
virtual

Stream size of object.

Parameters
[in]StreamThe input or output stream used in conjunction with this object.
Returns
The number of bytes needed to write or read this class of object to or from a stream.

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

◆ Clone() [1/2]

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

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >, and FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >.

◆ Clone() [2/2]

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

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT< INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< fr_ce_length_type, fr_ce_chkType_type, fr_ce_class_type, fr_ce_instance_type, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef2< INT_8U, CHAR_U, CHAR_U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_4U, INT_2U, INT_2U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Common::StreamRef< INT_8U, INT_2U, INT_4U, DATA_FORMAT_VERSION >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >, and FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >.

◆ Create() [1/4]

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

constructor - virtual

Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrTOC, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrTOC, and FrVect.

◆ Create() [2/4]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( std::istream & Buffer) const
virtualinherited

constructor - virtual

Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, and FrVect.

◆ Create() [3/4]

FrTable * FrameCPP::Version_4::FrTable::Create ( istream_type & Stream) const
virtual

constructor - virtual

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

◆ Create() [4/4]

virtual FrTable * FrameCPP::Version_4::FrTable::Create ( istream_type & Stream) const
virtual

constructor - virtual

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

◆ demote() [1/2]

FrTable::demote_ret_type FrameCPP::Version_4::FrTable::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
protectedvirtual

Down grade an object.

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

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_4::FrTable::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
protectedvirtual

Down grade an object.

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.

◆ FrameSpecVersion() [1/2]

FrameSpec::Object::frame_spec_version_type FrameCPP::Common::FrameSpec::Object::FrameSpecVersion ( ) const
inlineinherited

◆ FrameSpecVersion() [2/2]

frame_spec_version_type FrameCPP::Common::FrameSpec::Object::FrameSpecVersion ( ) const
inherited

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

◆ getClass() [1/2]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

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

◆ getClass() [2/2]

virtual class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

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

◆ GetColumnName() [1/4]

column_name_container_type FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::GetColumnName ( ) const
inlineinherited

Retrieve the list of column names.

Returns
The set of column names in column order.

◆ GetColumnName() [2/4]

column_name_container_type FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::GetColumnName ( ) const
inlineinherited

Retrieve the list of column names.

Returns
The set of column names in column order.

◆ GetColumnName() [3/4]

column_name_container_type FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::GetColumnName ( ) const
inlineinherited

Retrieve the list of column names.

Returns
The set of column names in column order.

◆ GetColumnName() [4/4]

column_name_container_type FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::GetColumnName ( ) const
inlineinherited

Retrieve the list of column names.

Returns
The set of column names in column order.

◆ GetComment() [1/2]

const std::string & FrTableNPS::GetComment ( ) const
inlineinherited

Retrieve the comment.

Returns
The text of the comment associated with the table.

◆ GetComment() [2/2]

const std::string & FrameCPP::Version_4::FrTableNPS::GetComment ( ) const
inherited

Retrieve the comment.

Returns
The text of the comment associated with the table.

◆ getComment() [1/2]

std::string & FrTableNPS::getComment ( )
inlineprotectedinherited

Retrieve the comment.

Returns
The text of the comment associated with the table.

◆ getComment() [2/2]

std::string & FrameCPP::Version_4::FrTableNPS::getComment ( )
protectedinherited

Retrieve the comment.

Returns
The text of the comment associated with the table.

◆ GetDescription() [1/4]

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

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.

◆ GetDescription() [3/4]

◆ GetDescription() [4/4]

◆ GetName() [1/2]

const std::string & FrTableNPS::GetName ( ) const
inlineinherited

Retrieve the name.

Returns
The name associated with the table

◆ GetName() [2/2]

const std::string & FrameCPP::Version_4::FrTableNPS::GetName ( ) const
inherited

Retrieve the name.

Returns
The name associated with the table

◆ GetNameSlow() [1/2]

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

◆ GetNameSlow() [2/2]

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

◆ GetNColumn() [1/4]

nColumn_type FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::GetNColumn ( ) const
inlineinherited

Retrieve the number of columns.

Returns
The number of columns in the table.

◆ GetNColumn() [2/4]

nColumn_type FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::GetNColumn ( ) const
inlineinherited

Retrieve the number of columns.

Returns
The number of columns in the table.

◆ GetNColumn() [3/4]

nColumn_type FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::GetNColumn ( ) const
inlineinherited

Retrieve the number of columns.

Returns
The number of columns in the table.

◆ GetNColumn() [4/4]

nColumn_type FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::GetNColumn ( ) const
inlineinherited

Retrieve the number of columns.

Returns
The number of columns in the table.

◆ GetNRow() [1/4]

nRow_type FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::GetNRow ( ) const
inlineinherited

Retrieve the number of rows.

Returns
The number of rows in the table.

◆ GetNRow() [2/4]

nRow_type FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::GetNRow ( ) const
inlineinherited

Retrieve the number of rows.

Returns
The number of rows in the table.

◆ GetNRow() [3/4]

nRow_type FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::GetNRow ( ) const
inlineinherited

Retrieve the number of rows.

Returns
The number of rows in the table.

◆ GetNRow() [4/4]

nRow_type FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::GetNRow ( ) const
inlineinherited

Retrieve the number of rows.

Returns
The number of rows in the table.

◆ Merge() [1/2]

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

Merge with another FrAdcData.

◆ Merge() [2/2]

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

Merge with another FrAdcData.

◆ ObjectStructName() [1/2]

const char * FrameCPP::Version_4::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_4::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]

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

Concatination operator.

◆ operator+=() [2/2]

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

Concatination operator.

◆ operator==() [1/5]

bool FrameCPP::Version_4::FrTable::operator== ( const Common::FrameSpec::Object & Obj) const
virtual

comparison operator

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

◆ operator==() [2/5]

virtual bool FrameCPP::Version_4::FrTable::operator== ( const Common::FrameSpec::Object & Obj) const
virtual

comparison operator

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

◆ operator==() [3/5]

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

comparison operator

Parameters
[in]RHSThe right hand side argument of the comparison operator
Returns
True if the two FrTable objects being compared are equivelant, false otherwise.

◆ operator==() [4/5]

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

comparison operator

Parameters
[in]RHSThe right hand side argument of the comparison operator
Returns
True if the two FrTable objects being compared are equivelant, false otherwise.

◆ operator==() [5/5]

bool FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::operator== ( const FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > > & RHS)
inherited

◆ Promote() [1/2]

FrTable::promote_ret_type FrameCPP::Version_4::FrTable::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
static

◆ Promote() [2/2]

static promote_ret_type FrameCPP::Version_4::FrTable::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
static

◆ promote() [1/2]

FrTable::promote_ret_type FrameCPP::Version_4::FrTable::promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream ) const
protectedvirtual

Up grade an object.

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

◆ promote() [2/2]

virtual promote_ret_type FrameCPP::Version_4::FrTable::promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream ) const
protectedvirtual

Up grade an object.

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

◆ PromoteObject() [1/5]

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

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

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

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

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,
promote_stream_type * Stream )
inherited

◆ RefColumn() [1/8]

column_type & FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::RefColumn ( )
inherited

Retrieve reference to columns.

Returns
A reference to the container of columns.

◆ RefColumn() [2/8]

FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::column_type & FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::RefColumn ( )
inlineinherited

Retrieve reference to columns.

Returns
A reference to the container of columns.

◆ RefColumn() [3/8]

column_type & FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::RefColumn ( )
inherited

Retrieve reference to columns.

Returns
A reference to the container of columns.

◆ RefColumn() [4/8]

column_type & FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::RefColumn ( )
inherited

Retrieve reference to columns.

Returns
A reference to the container of columns.

◆ RefColumn() [5/8]

const column_type & FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::RefColumn ( ) const
inherited

Retrieve reference to columns.

Returns
A constant reference to the container of columns.

◆ RefColumn() [6/8]

const FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::column_type & FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::RefColumn ( ) const
inlineinherited

Retrieve reference to columns.

Returns
A constant reference to the container of columns.

◆ RefColumn() [7/8]

const column_type & FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::RefColumn ( ) const
inherited

Retrieve reference to columns.

Returns
A constant reference to the container of columns.

◆ RefColumn() [8/8]

const column_type & FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::RefColumn ( ) const
inherited

Retrieve reference to columns.

Returns
A constant reference to the container of columns.

◆ setName() [1/2]

void FrTableNPS::setName ( const std::string & Name)
inlineprotectedinherited

Establish name.

Parameters
[in]NameThe name to associate with the table

◆ setName() [2/2]

void FrameCPP::Version_4::FrTableNPS::setName ( const std::string & Name)
protectedinherited

Establish name.

Parameters
[in]NameThe name to associate with the table

◆ StructDescription() [1/2]

const Description * FrameCPP::Version_4::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_4::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_4::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_4::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]

◆ VerifyObject() [2/2]

◆ Write() [1/2]

void FrameCPP::Version_4::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_4::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.

Member Data Documentation

◆ CLASS_ID

static const Common::FrameSpec::Info::frame_object_types FrameCPP::Version_4::FrTable::CLASS_ID
static
Initial value:

◆ frame_spec_version

const frame_spec_version_type FrameCPP::Common::FrameSpec::Object::frame_spec_version
privateinherited

Version of the frame specification.

The version of the frame specification for which this object was created.

◆ m_class

const class_type FrameCPP::Common::FrameSpec::Object::m_class
privateinherited

Storage for the class identifier.

The class identifier uniquely identifies the parent class within the frame specification. All instances of parent class will have the same class identifier.

◆ m_data

data_type FrTableNPS::m_data
protectedinherited

◆ m_desc

const Description *const FrameCPP::Common::FrameSpec::Object::m_desc
privateinherited

Description for parent class.

The description for the parent class composed of one FrSH and one or more FrSE elements.

◆ m_refs [1/2]

refs_type FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::m_refs
protectedinherited

◆ m_refs [2/2]

refs_type FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::m_refs
protectedinherited

◆ MAX_REF [1/2]

const INT_2U FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::MAX_REF
staticinherited

◆ MAX_REF [2/2]

static const INT_2U FrameCPP::Version_4::FrTablePST< PTR_STRUCT, Common::SearchContainer< FrVect, &FrVect::GetName > >::MAX_REF
staticinherited

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