ldas-tools-framecpp
2.5.8
|
Table Data Structure Definition. More...
#include <FrTable.hh>
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< Object > | unique_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< STRING > | column_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... | |
FrTable & | Merge (const FrTable &RHS) |
Merge with another FrTable. More... | |
FrTable & | operator+= (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_type * | Create (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_type & | WriteNext (ostream_type &Stream) const |
Write a next pointer to the parent to the stream. More... | |
virtual Object * | Clone () 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_type & | RefColumn () const |
Retrieve reference to columns. More... | |
column_type & | RefColumn () |
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::Description * | StructDescription () |
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 FrTable * | pCreate (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 |
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 |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
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.
|
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.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
FrTable::FrTable | ( | ) |
Default constructor.
FrTable::FrTable | ( | const FrTable & | Source | ) |
Copy Constructor.
[in] | Source | The object from which to copy the information. |
FrTable::FrTable | ( | const FrTableNPS & | Source | ) |
Copy Constructor.
[in] | Source | The object from which to copy the information. |
FrTable::FrTable | ( | const std::string & | name, |
INT_4U | nrows | ||
) |
Constructor.
[in] | name | The of this table. |
[in] | nrows | Number of rows in table. |
FrTable::FrTable | ( | Previous::FrTable & | Source, |
Common::IStream * | 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. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
virtualinherited |
constructor - virtual copy constructor
Reimplemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrStatData, FrameCPP::Version_8::FrStatData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_8::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrStatData, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, and FrameCPP::Version_3::FrHeader.
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
protectedvirtual |
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. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Down grade an object.
[in] | Target | This is the version of the frame specification of the demoted object. |
[in] | Obj | The base object. |
[in] | Stream | Stream from which Obj was created. |
|
inlineinherited |
Retrieve the class identifier.
|
protectedvirtualinherited |
Retrieve the class identifier.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlineinherited |
Retrieve the list of column names.
|
inlinevirtualinherited |
Retrieve FrSH/FrSE description of the parent object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
const std::string & FrTable::GetNameSlow | ( | ) | const |
Retrieve the name of the table.
|
inlineinherited |
Retrieve the number of columns.
|
inlineinherited |
Retrieve the number of rows.
|
virtual |
The name structure name of this object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
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. |
|
virtual |
equality operator for abstract data type
[in] | RHS | The object to be compared. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inherited |
|
protectedvirtual |
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< Common::FrameSpec::Object, checksum_type >.
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.
|
inlinestatic |
Promote previous version of object to this version.
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
|
protectedvirtual |
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. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
inherited |
|
protectedvirtual |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.
|
inlineinherited |
Retrieve reference to columns.
|
inlineinherited |
Retrieve reference to columns.
|
static |
The description of structure.
|
inlinestatic |
The name structure name of this object.
The name of the structure is most often used when writing the description of the structure out to a stream.
|
virtualinherited |
Verify an object.
[in,out] | Verifier | Set of rules to use in verification of the object. If an error occurs, the violation is logged here. |
[in] | Stream | The stream that is being used to read the object. |
Reimplemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_8::FrameH, FrameCPP::Version_6::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_4::FrEndOfFile, and FrameCPP::Version_3::FrEndOfFile.
|
virtualinherited |
Write object to the stream.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inherited |
Write a next pointer to the parent to the stream.
[in,out] | Stream | The output stream to receive the next pointer. |
|
static |
Dictionary class id for this structure.
|
protectedinherited |
|
staticinherited |