Class Index | Cross Index | Namespace Index |
Table
Contained in: FrameCPP::Version_3_4_5
Derived from:
FrameCPP::Version_3_4_5::Base
Derived by:
none
#include "../../../../../lib/framecpp/src/Version3_4_5/table.hh"
public function member index: |
|||
Table | (); | Default Constructor. | |
Table | (const Table& table); | Copy Constructor. | |
Table | (const std::string& name, INT_4U nrows); | Constructor. | |
inline void | appendComment | (const std::string& comment); | Appends a comment. |
virtual INT_2U | getClassId | () const; | |
inline const std::string& | getComment | () const; | Comment |
inline INT_2U | getNColumns | () const; | Number of columns table has. |
inline INT_4U | getNRows | () const; | Number of rows allowed per vector (column). |
const std::string& | getName | () const; | |
static SH | getSH | (); | Structure Header |
static SH | getSH4 | (); | Frame format version 4 Structure Header |
inline bool | operator != | (const Table& table) const; | Not-equal comparison. |
const Table& | operator += | (const Table& table); | += Assignment Operator. |
const Table& | operator = | (const Table& table); | Assignment Operator. |
bool | operator == | (const Table& table) const; | Equal comparison. |
inline Table::ColumnsContainer& | refColumns | (); | Columns Container |
inline const Table::ColumnsContainer& | refColumns | () const; | Columns Container |
private function member index: |
|||
static Table* | read | (FrameReaderBase& in); | Reads Table object from an FrameReaderBase object. |
static Table* | read4 | (FrameReaderBase& in); | |
virtual void | write | (Output& out) const; | Write Table object |
Table class encapsulates the following attributes:
Attribute | Description |
name | Table name |
comment | Comment |
mNRows | Number of rows allowed in a column |
Table object is also a container for two types of data:
Data | Description |
columns | A container of Frame Vect table columns |
This creates Table object with the following properties:
- name = "none"
- comment = ""
- nRows = 1
- no data
Exceptions:
Exception | Description |
None. |
A deep copy is performed for owned objects.
Parameters:
Parameter | Description |
const Table& table | The object to be copied. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
This creates Table object with the specified properties. Additionally, the comment is set to "" (no comment).
Parameters:
Parameter | Description |
const std::string& name | Chanel name. |
INT_4U nRows | Number rows allowed in a column. |
Exceptions:
Exception | Description |
None. |
This method adds a comment followed by a newline to the end of the current list of comments.
Parameters:
Parameter | Description |
const std::string& comment | The comment to append. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
std::bad_alloc | Memory allocation failed. |
Exceptions:
Exception | Description |
None. |
Gets the comment.
Return value:
const std::string&- Table comment.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
INT_2U- The number of columns.
Exceptions:
Exception | Description |
None. | |
None. |
Return value:
INT_4U
Exceptions:
Exception | Description |
None. | |
None. |
Return by value: to be consistent with Version6
Constructs the Structure Header for this class.
Return value:
SH- Table structure header.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Determines whether two table objects are not equal. All contained data is compared.
Parameters:
Parameter | Description |
const Table& table | The object to compare with. |
Return value:
bool- True if the objects are not equal.
Exceptions:
Exception | Description |
None. | |
None. |
Parameters:
Parameter | Description |
const Table& table |
Return value:
const Table&
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
frame_mismatch | Table mismatch |
A deep copy is performed for owned objects.
Parameters:
Parameter | Description |
const Table& table | The object to be assigned. |
Return value:
const Table&- This object.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
Determines whether Table objects are equal. For this comparison, all of the data is compared.
Parameters:
Parameter | Description |
const Table& table | The object to compare with. |
Return value:
bool- true if the objects are equal.
Exceptions:
Exception | Description |
None. |
Parameters:
Parameter | Description |
FrameReaderBase& in | Input data stream object. |
Return value:
Table*- Newly allocated Table.
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Red failure occured. |
Exceptions:
Exception | Description |
std::bad_alloc | Memory allocation failed. |
read_failure | Red failure occured. |
Get table columns vector container
Return value:
Container< Vect >&- Columns vector.
Exceptions:
Exception | Description |
None. | |
None. |
Get table columns vector container
Return value:
Container< Vect >&- Columns vector.
Exceptions:
Exception | Description |
None. | |
None. |
Writes Table object to an Output object.
Parameters:
Parameter | Description |
Output& out out | Output data object. |
Exceptions:
Exception | Description |
write_failure | Write failure occured. |
All vectors forced to be of this length :TODO: