ldas-tools-framecpp 3.0.4
|
Table Data Structure Definition. More...
#include <FrTable.hh>
Public Types | |
typedef ObjectWithChecksum< ObjectType, ChecksumType > | self_type |
typedef ObjectWithChecksum< ObjectType, ChecksumType > | self_type |
typedef IStream | istream_type |
typedef IStream | istream_type |
typedef OStream | ostream_type |
typedef OStream | ostream_type |
typedef std::string | name_type |
typedef std::string | comment_type |
typedef INT_2U | nColumn_type |
typedef INT_4U | nRow_type |
typedef const char *const | struct_name_type |
typedef const char *const | struct_desc_type |
typedef INT_2U const | struct_id_type |
typedef PTR_STRUCT | ptr_struct_type |
typedef Common::SearchContainer< FrVect, &FrVect::GetName > | column_type |
typedef column_type::iterator | iterator |
typedef column_type::const_iterator | const_iterator |
typedef std::vector< STRING > | column_name_container_type |
Collection of column names. |
Public Member Functions | |
FrTable () | |
Default constructor. | |
FrTable (const FrTable &Source) | |
Copy Constructor. | |
FrTable (const name_type &name, nRow_type nrows) | |
Constructor. | |
FrTable (Previous::FrTable &Source, stream_base_type *Stream) | |
Promotion Constructor. | |
virtual | ~FrTable () |
Destructor. | |
const name_type & | GetNameSlow () const |
Retrieve the name of the table. | |
FrTable & | Merge (const FrTable &RHS) |
Merge with another FrTable. | |
FrTable & | operator+= (const FrTable &RHS) |
Concatinate with another FrTable. | |
bool | operator== (const FrTable &RHS) const |
equality operator | |
virtual bool | operator== (const Common::FrameSpec::Object &RHS) const |
equality operator for abstract data type | |
FrTable () | |
Default constructor. | |
FrTable (const FrTable &Source) | |
Copy Constructor. | |
FrTable (const name_type &name, nRow_type nrows) | |
Constructor. | |
FrTable (Previous::FrTable &Source, stream_base_type *Stream) | |
Promotion Constructor. | |
virtual | ~FrTable () |
Destructor. | |
const name_type & | GetNameSlow () const |
Retrieve the name of the table. | |
FrTable & | Merge (const FrTable &RHS) |
Merge with another FrTable. | |
FrTable & | operator+= (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_type * | Create (istream_type &Stream) const |
Virtual constructor. | |
virtual self_type * | Create (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. | |
nColumn_type | GetNColumn () const |
Retrieve the number of columns. | |
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. | |
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) |
Promote previous version of object to this version. | |
static const Common::Description * | StructDescription () |
The description of structure. | |
static const char * | CheckSumDataClass () |
Data class to be used in class field of FrSE. | |
static const char * | CheckSumDataClass () |
Data class to be used in class field of FrSE. | |
static const char * | CheckSumDataComment () |
Comment to be used in comment field of FrSE. | |
static const char * | CheckSumDataComment () |
Comment to be used in comment field of FrSE. | |
static struct_name_type | FrameSpecName () |
static struct_name_type | StructName () |
static struct_desc_type | FrameSpecDescription () |
Return the dictionary name of the structure. | |
static struct_id_type | FrameSpecId () |
Return the dictionary name of the structure. |
Static Public Attributes | |
static struct_name_type | struct_name |
static struct_desc_type | struct_desc |
static struct_id_type | struct_id |
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 |
Demotes object to previous version of the frame spec. | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. | |
virtual const Common::Description * | GetDescription (ostream_type &Stream) const |
The data structure description. | |
virtual cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. | |
virtual self_type * | pCreate (Common::IStream &Stream) const |
Virtual constructor. | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const |
Promotes object to another version of the frame spec. | |
virtual void | pWrite (Common::OStream &Stream) const |
Write the structure to the stream. |
Protected Attributes | |
refs_type | m_refs |
Private Types | |
typedef STRING | io_name_type |
typedef STRING | io_comment_type |
typedef ObjectWithChecksum< Common::FrameSpec::Object > | object_type |
Object with checksum data. | |
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > | object_base_type |
Private Member Functions | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual |
Private Attributes | |
ChecksumType | m_chkSum |
Structure checksum. |
Table Data Structure Definition.
|
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.
|
inherited |
|
inherited |
|
inherited |
|
privateinherited |
|
privateinherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
privateinherited |
|
privateinherited |
Object with checksum data.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
FrameCPP::Version_9::FrTable::FrTable | ( | ) |
Default constructor.
FrTable::FrTable | ( | const FrTable & | Source | ) |
Copy Constructor.
[in] | Source | The object from which to copy the information. |
Constructor.
[in] | name | The of this table. |
[in] | nrows | Number of rows in table. |
FrTable::FrTable | ( | Previous::FrTable & | Source, |
stream_base_type * | Stream ) |
|
virtual |
Destructor.
FrameCPP::Version_9::FrTable::FrTable | ( | ) |
Default constructor.
FrameCPP::Version_9::FrTable::FrTable | ( | const FrTable & | Source | ) |
Copy Constructor.
[in] | Source | The object from which to copy the information. |
Constructor.
[in] | name | The of this table. |
[in] | nrows | Number of rows in table. |
FrameCPP::Version_9::FrTable::FrTable | ( | Previous::FrTable & | Source, |
stream_base_type * | Stream ) |
|
virtual |
Destructor.
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
inlineprivatevirtualinherited |
Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.
|
inlineprivatevirtualinherited |
Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
inlineprivatevirtualinherited |
constructor - virtual
|
inlineprivatevirtualinherited |
constructor - virtual
|
inlineprotectedvirtualinherited |
Demotes object to previous version of the frame spec.
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
|
inlinestaticinherited |
Return the dictionary name of the structure.
|
inlinestaticinherited |
Return the dictionary name of the structure.
|
inlinestaticinherited |
|
inlineinherited |
Retrieve the list of column names.
|
inlineprotectedvirtualinherited |
The data structure description.
const std::string & FrTable::GetNameSlow | ( | ) | const |
Retrieve the name of the table.
const name_type & FrameCPP::Version_9::FrTable::GetNameSlow | ( | ) | const |
Retrieve the name of the table.
|
inlineinherited |
Retrieve the number of columns.
|
inlineinherited |
Retrieve the number of rows.
|
inlineprotectedvirtualinherited |
The name structure name of this object.
|
inherited |
|
virtual |
equality operator for abstract data type
[in] | RHS | The object to be compared. |
|
virtual |
equality operator for abstract data type
[in] | RHS | The object to be compared. |
|
inline |
equality operator
Tests the equality of two tables.
[in] | RHS | The FrTable object to be compared. |
[in] | RHS | Right hand side of equality expression. |
bool FrameCPP::Version_9::FrTable::operator== | ( | const FrTable & | RHS | ) | const |
equality operator
[in] | RHS | The FrTable object to be compared. |
|
inlineprotectedvirtualinherited |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inlineprotectedvirtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
staticinherited |
|
inlineprotectedvirtualinherited |
Promotes object to another version of the frame spec.
[in] | Target | The version of the promoted frame specification. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
|
inlineprotectedvirtualinherited |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inherited |
Retrieve reference to columns.
|
inherited |
Retrieve reference to columns.
|
inlinestaticinherited |
The description of structure.
|
inlinestaticinherited |
|
virtualinherited |
Write object to the stream.
|
virtualinherited |
Write object to the stream.
|
privateinherited |
Structure checksum.
The checksum for the structure when the structure is contained in a stream.
|
protectedinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |