#include <ScalarColumn.h>
Inheritance diagram for casa::ScalarColumn< T >:
Part of API
The class ScalarColumn allows read/write access to a column containing scalar values with an arbitrary data type. It augments the class ROScalarColumn with the possibility to put data into a cell or into the whole column.
A default constructor is defined to allow construction of an array of ScalarColumn objects. However, this constructs an object not referencing a column. Functions like get, etc. will fail (i.e. result in a segmentation fault) when used on such objects. The functions ROTableColumn::isNull and throwIfNull can be used to test on this. The functions attach and reference can fill in the object.
The assignment operator is not defined for this class, because it was felt it would be too confusing. Instead the function reference can be used to do assignment with reference semantics. An assignment with copy semantics can be done with a putColumn function.
See module Tables .
Definition at line 257 of file ScalarColumn.h.
Public Member Functions | |
| ScalarColumn () | |
| The default constructor creates a null object, i.e. | |
| ScalarColumn (const Table &, const String &columnName) | |
| Construct the scalar column object for the table column. | |
| ScalarColumn (const TableColumn &) | |
| Construct from the given table column. | |
| ScalarColumn (const ScalarColumn< T > &) | |
| Copy constructor (reference semantics). | |
| ~ScalarColumn () | |
| virtual ROTableColumn * | clone () const |
| Clone the object. | |
| void | reference (const ScalarColumn< T > &) |
| Change the reference to another column. | |
| void | attach (const Table &table, const String &columnName) |
| Attach a column to the object. | |
| void | put (uInt rownr, const T &value) |
| Put the value in a particular cell (i.e. | |
| void | putColumn (const Vector< T > &vec) |
| Put the vector of all values in the column. | |
| void | putColumnRange (const Slicer &rowRange, const Vector< T > &vec) |
| Put the vector of a range of values in the column. | |
| void | putColumnCells (const RefRows &rownrs, const Vector< T > &vec) |
| Put the vector of some values in the column. | |
| void | fillColumn (const T &value) |
| Put the same value in all cells of the column. | |
| void | putColumn (const ROScalarColumn< T > &that) |
| Put the contents of a column with the same data type into this column. | |
| void | put (uInt rownr, const ROScalarColumn< T > &that) |
| Use the same row numbers for both cells. | |
| void | put (uInt thisRownr, const ROScalarColumn< T > &that, uInt thatRownr) |
| Use possibly different row numbers for that (i.e. | |
| void | put (uInt rownr, const ROTableColumn &that) |
| Use the same row numbers for both cells. | |
| void | put (uInt thisRownr, const ROTableColumn &that, uInt thatRownr) |
| Use possibly different row numbers for that (i.e. | |
Private Member Functions | |
| ScalarColumn< T > & | operator= (const ScalarColumn< T > &) |
| Assigning one column to another suggests a deep copy. | |
| void | reference (const TableColumn &) |
| Referencing any other typed column cannot be done. | |
| void | putColumn (const ROTableColumn &) |
| Copy the values of that column to this column. | |
| casa::ScalarColumn< T >::ScalarColumn | ( | ) |
The default constructor creates a null object, i.e.
it does not reference a table column. The sole purpose of this constructor is to allow construction of an array of ScalarColumn objects. The functions reference and attach can be used to make a null object reference a column. Note that get functions, etc. will cause a segmentation fault when operating on a null object. It was felt it was too expensive to test on null over and over again. The user should use the isNull or throwIfNull function in case of doubt.
| casa::ScalarColumn< T >::ScalarColumn | ( | const Table & | , | |
| const String & | columnName | |||
| ) |
Construct the scalar column object for the table column.
| casa::ScalarColumn< T >::ScalarColumn | ( | const TableColumn & | ) |
Construct from the given table column.
This constructor is useful if first a table column was constructed, its type is determined and thereafter used to construct the correct column object.
| casa::ScalarColumn< T >::ScalarColumn | ( | const ScalarColumn< T > & | ) |
Copy constructor (reference semantics).
| casa::ScalarColumn< T >::~ScalarColumn | ( | ) |
| virtual ROTableColumn* casa::ScalarColumn< T >::clone | ( | ) | const [virtual] |
| void casa::ScalarColumn< T >::reference | ( | const ScalarColumn< T > & | ) |
Change the reference to another column.
This is in fact an assignment operator with reference semantics. It removes the reference to the current column and creates a reference to the column referenced in the other object. It will handle null objects correctly.
Referenced by casa::ScalarColumn< std::complex< Float > >::attach().
| void casa::ScalarColumn< T >::attach | ( | const Table & | table, | |
| const String & | columnName | |||
| ) | [inline] |
Attach a column to the object.
This is in fact only a shorthand for
reference (ScalarColumn<T> (table, columnName));
Reimplemented from casa::ROScalarColumn< T >.
Definition at line 305 of file ScalarColumn.h.
| void casa::ScalarColumn< T >::put | ( | uInt | rownr, | |
| const T & | value | |||
| ) | [inline] |
Put the value in a particular cell (i.e.
table row). The row numbers count from 0 until #rows-1.
Definition at line 310 of file ScalarColumn.h.
Referenced by casa::ScalarColumn< std::complex< Float > >::put().
| void casa::ScalarColumn< T >::put | ( | uInt | rownr, | |
| const ROScalarColumn< T > & | that | |||
| ) | [inline] |
| void casa::ScalarColumn< T >::put | ( | uInt | thisRownr, | |
| const ROScalarColumn< T > & | that, | |||
| uInt | thatRownr | |||
| ) |
Use possibly different row numbers for that (i.e.
input) and and this (i.e. output) cell.
| void casa::ScalarColumn< T >::put | ( | uInt | rownr, | |
| const ROTableColumn & | that | |||
| ) | [inline] |
Use the same row numbers for both cells.
Reimplemented from casa::TableColumn.
Definition at line 330 of file ScalarColumn.h.
| void casa::ScalarColumn< T >::put | ( | uInt | thisRownr, | |
| const ROTableColumn & | that, | |||
| uInt | thatRownr | |||
| ) | [virtual] |
Use possibly different row numbers for that (i.e.
input) and and this (i.e. output) cell.
Reimplemented from casa::TableColumn.
| void casa::ScalarColumn< T >::putColumn | ( | const Vector< T > & | vec | ) |
Put the vector of all values in the column.
The length of the vector must be the number of cells in the column (i.e. the number of rows in the table).
| void casa::ScalarColumn< T >::putColumnRange | ( | const Slicer & | rowRange, | |
| const Vector< T > & | vec | |||
| ) |
Put the vector of a range of values in the column.
The Slicer object can be used to specify start, end (or length), and stride of the rows to put. The length of the vector must be the number of cells in the slice.
| void casa::ScalarColumn< T >::putColumnCells | ( | const RefRows & | rownrs, | |
| const Vector< T > & | vec | |||
| ) |
Put the vector of some values in the column.
The length of the vector must be the number of cells in the RefRows object.
| void casa::ScalarColumn< T >::fillColumn | ( | const T & | value | ) |
Put the same value in all cells of the column.
| void casa::ScalarColumn< T >::putColumn | ( | const ROScalarColumn< T > & | that | ) |
Put the contents of a column with the same data type into this column.
To put the contents of a column with a different data type into this column, the function TableColumn::putColumn can be used (provided the data type promotion is possible). In fact, this function is an assignment operator with copy semantics.
| ScalarColumn<T>& casa::ScalarColumn< T >::operator= | ( | const ScalarColumn< T > & | ) | [private] |
Assigning one column to another suggests a deep copy.
Because the copy constructor has reference semantics, it was felt it would be too confusing to allow assignment. Instead the function reference (with reference semantics) and putColumn (with copy semantics) exist. Declaring this operator private, makes it unusable.
| void casa::ScalarColumn< T >::reference | ( | const TableColumn & | ) | [private] |
Referencing any other typed column cannot be done.
If we do not put this function here, the conversion constructor ROScalarColumn (const TableColumn&) will be used and no compile error is given.
Reimplemented from casa::TableColumn.
| void casa::ScalarColumn< T >::putColumn | ( | const ROTableColumn & | ) | [private] |
Copy the values of that column to this column.
The numbers of rows in both columns must be equal. Data type promotion is possible. An exception is thrown if the data cannot be converted. This function is useful to copy one column to another without knowing their data types. In fact, this function is an assignment operator with copy semantics.
Reimplemented from casa::TableColumn.
1.5.1