casacore
|
Abstract base class for a table column. More...
#include <BaseColumn.h>
Public Member Functions | |
BaseColumn (const BaseColumnDesc *) | |
Construct it using the given column description. More... | |
virtual | ~BaseColumn () |
virtual Bool | isWritable () const =0 |
Test if the column is writable. More... | |
virtual Bool | isStored () const =0 |
Test if the column is stored (otherwise it is virtual). More... | |
virtual TableRecord & | rwKeywordSet ()=0 |
Get access to the column keyword set. More... | |
virtual TableRecord & | keywordSet ()=0 |
const ColumnDesc & | columnDesc () const |
Get const access to the column description. More... | |
virtual rownr_t | nrow () const =0 |
Get nr of rows in the column. More... | |
virtual Bool | isDefined (rownr_t rownr) const =0 |
Test if the given cell contains a defined value. More... | |
virtual void | setShape (rownr_t rownr, const IPosition &shape) |
Set the shape of the array in the given row. More... | |
virtual void | setShape (rownr_t rownr, const IPosition &shape, const IPosition &tileShape) |
Set the shape and tile shape of the array in the given row. More... | |
virtual uInt | ndimColumn () const |
Get the global #dimensions of an array (ie. More... | |
virtual IPosition | shapeColumn () const |
Get the global shape of an array (ie. More... | |
virtual uInt | ndim (rownr_t rownr) const |
Get the #dimensions of an array in a particular cell. More... | |
virtual IPosition | shape (rownr_t rownr) const |
Get the shape of an array in a particular cell. More... | |
virtual IPosition | tileShape (rownr_t rownr) const |
Get the tile shape of an array in a particular cell. More... | |
virtual Bool | canChangeShape () const |
Ask the data manager if the shape of an existing array can be changed. More... | |
virtual void | initialize (rownr_t startRownr, rownr_t endRownr)=0 |
Initialize the rows from startRow till endRow (inclusive) with the default value defined in the column description. More... | |
virtual void | get (rownr_t rownr, void *dataPtr) const |
Get a scalar value from a particular cell. More... | |
virtual void | getArray (rownr_t rownr, ArrayBase &dataPtr) const |
Get an array from a particular cell. More... | |
virtual void | getSlice (rownr_t rownr, const Slicer &, ArrayBase &dataPtr) const |
Get a slice of an N-dimensional array in a particular cell. More... | |
virtual void | getScalarColumn (ArrayBase &dataPtr) const |
Get the vector of all scalar values in a column. More... | |
virtual void | getArrayColumn (ArrayBase &dataPtr) const |
Get the array of all array values in a column. More... | |
virtual void | getColumnSlice (const Slicer &, ArrayBase &dataPtr) const |
Get subsections from all arrays in the column. More... | |
virtual void | getScalarColumnCells (const RefRows &rownrs, ArrayBase &dataPtr) const |
Get the vector of some scalar values in a column. More... | |
virtual void | getArrayColumnCells (const RefRows &rownrs, ArrayBase &dataPtr) const |
Get the array of some array values in a column. More... | |
virtual void | getColumnSliceCells (const RefRows &rownrs, const Slicer &, ArrayBase &dataPtr) const |
Get subsections from some arrays in the column. More... | |
virtual void | put (rownr_t rownr, const void *dataPtr) |
Put the scalar value in a particular cell. More... | |
virtual void | putArray (rownr_t rownr, const ArrayBase &dataPtr) |
Put the array value in a particular cell. More... | |
virtual void | putSlice (rownr_t rownr, const Slicer &, const ArrayBase &dataPtr) |
Put a slice of an N-dimensional array in a particular cell. More... | |
virtual void | putScalarColumn (const ArrayBase &dataPtr) |
Put the vector of all scalar values in the column. More... | |
virtual void | putArrayColumn (const ArrayBase &dataPtr) |
Put the array of all array values in the column. More... | |
virtual void | putColumnSlice (const Slicer &, const ArrayBase &dataPtr) |
Put into subsections of all table arrays in the column. More... | |
virtual void | putScalarColumnCells (const RefRows &rownrs, const ArrayBase &dataPtr) |
Get the vector of some scalar values in a column. More... | |
virtual void | putArrayColumnCells (const RefRows &rownrs, const ArrayBase &dataPtr) |
Get the array of some array values in a column. More... | |
virtual void | putColumnSliceCells (const RefRows &rownrs, const Slicer &, const ArrayBase &dataPtr) |
Put subsections of some arrays in the column. More... | |
void | getScalar (rownr_t rownr, Bool &value) const |
Get the value from the row and convert it to the required type. More... | |
void | getScalar (rownr_t rownr, uChar &value) const |
void | getScalar (rownr_t rownr, Short &value) const |
void | getScalar (rownr_t rownr, uShort &value) const |
void | getScalar (rownr_t rownr, Int &value) const |
void | getScalar (rownr_t rownr, uInt &value) const |
void | getScalar (rownr_t rownr, Int64 &value) const |
void | getScalar (rownr_t rownr, float &value) const |
void | getScalar (rownr_t rownr, double &value) const |
void | getScalar (rownr_t rownr, Complex &value) const |
void | getScalar (rownr_t rownr, DComplex &value) const |
void | getScalar (rownr_t rownr, String &value) const |
void | getScalar (rownr_t rownr, TableRecord &value) const |
void | getScalar (rownr_t rownr, void *value, const String &dataTypeId) const |
Get a scalar for the other data types. More... | |
void | putScalar (rownr_t rownr, const Bool &value) |
Put the value into the row and convert it from the given type. More... | |
void | putScalar (rownr_t rownr, const uChar &value) |
void | putScalar (rownr_t rownr, const Short &value) |
void | putScalar (rownr_t rownr, const uShort &value) |
void | putScalar (rownr_t rownr, const Int &value) |
void | putScalar (rownr_t rownr, const uInt &value) |
void | putScalar (rownr_t rownr, const Int64 &value) |
void | putScalar (rownr_t rownr, const float &value) |
void | putScalar (rownr_t rownr, const double &value) |
void | putScalar (rownr_t rownr, const Complex &value) |
void | putScalar (rownr_t rownr, const DComplex &value) |
void | putScalar (rownr_t rownr, const String &value) |
void | putScalar (rownr_t rownr, const Char *value) |
void | putScalar (rownr_t rownr, const TableRecord &value) |
virtual ColumnCache & | columnCache ()=0 |
Get a pointer to the underlying column cache. More... | |
virtual void | setMaximumCacheSize (uInt nbytes)=0 |
Set the maximum cache size (in bytes) to be used by a storage manager. More... | |
virtual void | makeSortKey (Sort &, CountedPtr< BaseCompare > &cmpObj, Int order, CountedPtr< ArrayBase > &dataSave) |
Add this column and its data to the Sort object. More... | |
virtual void | makeRefSortKey (Sort &, CountedPtr< BaseCompare > &cmpObj, Int order, const Vector< rownr_t > &rownrs, CountedPtr< ArrayBase > &dataSave) |
Do it only for the given row numbers. More... | |
virtual void | allocIterBuf (void *&lastVal, void *&curVal, CountedPtr< BaseCompare > &cmpObj) |
Allocate value buffers for the table iterator. More... | |
virtual void | freeIterBuf (void *&lastVal, void *&curVal) |
Free the value buffers allocated by allocIterBuf. More... | |
Protected Member Functions | |
void | throwGetScalar () const |
Throw exceptions for invalid scalar get or put. More... | |
void | throwPutScalar () const |
void | throwGetType (const String &type) const |
void | throwPutType (const String &type) const |
Protected Attributes | |
const BaseColumnDesc * | colDescPtr_p |
Private Attributes | |
ColumnDesc | colDesc_p |
Abstract base class for a table column.
Internal
This is the (abstract) base class to access a column in a table.
This class is the base class for the derived column classes. It is a private class in the sense that the user cannot get access to it. All user access to a column is done via the classes TableColumn, ScalarColumn and ArrayColumn. They call the corresponding functions in this class and its derived classes.
This class serves a the base for the more specialized column classes like FilledScalarColumn and RefColumn. It defines many virtual functions, which are implemented in the derived classes. Some of these functions are purely virtual, some have a default implementation throwing an "invalid operation" exception. In that way those latter functions only have to be implemented in the classes which handle those cases.
Tip: The class RefColumn is in fact implemented in terms of this class; Almost every function in RefColumn calls the corresponding function in BaseColumn with the correct row number;
Definition at line 98 of file BaseColumn.h.
casacore::BaseColumn::BaseColumn | ( | const BaseColumnDesc * | ) |
Construct it using the given column description.
|
virtual |
|
virtual |
Allocate value buffers for the table iterator.
Also get a comparison object if undefined. The function freeIterBuf must be called to free the buffers.
Reimplemented in casacore::RefColumn, casacore::ConcatColumn, casacore::ScalarRecordColumnData, and casacore::ScalarColumnData< T >.
|
virtual |
Ask the data manager if the shape of an existing array can be changed.
Default is no.
Reimplemented in casacore::ConcatColumn, casacore::RefColumn, and casacore::ArrayColumnData.
|
pure virtual |
Get a pointer to the underlying column cache.
Implemented in casacore::RefColumn, casacore::ConcatColumn, and casacore::PlainColumn.
const ColumnDesc& casacore::BaseColumn::columnDesc | ( | ) | const |
Get const access to the column description.
|
virtual |
Free the value buffers allocated by allocIterBuf.
Reimplemented in casacore::RefColumn, casacore::ConcatColumn, casacore::ScalarRecordColumnData, and casacore::ScalarColumnData< T >.
|
virtual |
Get a scalar value from a particular cell.
Reimplemented in casacore::ConcatColumn, casacore::RefColumn, casacore::ScalarRecordColumnData, and casacore::ScalarColumnData< T >.
Referenced by casacore::ScalarColumn< casacore::String >::get().
Get an array from a particular cell.
Reimplemented in casacore::ConcatColumn, casacore::ArrayColumnData, and casacore::RefColumn.
Referenced by casacore::ArrayColumnBase::baseGet().
|
virtual |
Get the array of all array values in a column.
If the column contains n-dim arrays, the resulting array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.
Reimplemented in casacore::ArrayColumnData, casacore::RefColumn, and casacore::ConcatColumn.
|
virtual |
Get the array of some array values in a column.
If the column contains n-dim arrays, the resulting array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.
Reimplemented in casacore::RefColumn, casacore::ArrayColumnData, and casacore::ConcatColumn.
|
virtual |
Get subsections from all arrays in the column.
If the column contains n-dim arrays, the resulting array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.
Reimplemented in casacore::ArrayColumnData, casacore::RefColumn, and casacore::ConcatColumn.
|
virtual |
Get subsections from some arrays in the column.
If the column contains n-dim arrays, the resulting array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.
Reimplemented in casacore::ArrayColumnData, casacore::RefColumn, and casacore::ConcatColumn.
Get the value from the row and convert it to the required type.
This can only be used for scalar columns with a standard data type. Note that an unsigned integer cannot be converted to a signed integer with the same length. So only Int64 can handle all integer values.
Referenced by casacore::TableColumn::getScalar(), and casacore::TableColumn::getScalarValue().
void casacore::BaseColumn::getScalar | ( | rownr_t | rownr, |
float & | value | ||
) | const |
void casacore::BaseColumn::getScalar | ( | rownr_t | rownr, |
double & | value | ||
) | const |
void casacore::BaseColumn::getScalar | ( | rownr_t | rownr, |
Complex & | value | ||
) | const |
void casacore::BaseColumn::getScalar | ( | rownr_t | rownr, |
DComplex & | value | ||
) | const |
void casacore::BaseColumn::getScalar | ( | rownr_t | rownr, |
TableRecord & | value | ||
) | const |
void casacore::BaseColumn::getScalar | ( | rownr_t | rownr, |
void * | value, | ||
const String & | dataTypeId | ||
) | const |
Get a scalar for the other data types.
The given data type id must match the data type id of this column.
|
virtual |
Get the vector of all scalar values in a column.
Reimplemented in casacore::RefColumn, casacore::ScalarRecordColumnData, casacore::ScalarColumnData< T >, and casacore::ConcatScalarColumn< T >.
|
virtual |
Get the vector of some scalar values in a column.
Reimplemented in casacore::RefColumn, casacore::ScalarRecordColumnData, casacore::ScalarColumnData< T >, and casacore::ConcatScalarColumn< T >.
|
virtual |
Get a slice of an N-dimensional array in a particular cell.
Reimplemented in casacore::ArrayColumnData, casacore::RefColumn, and casacore::ConcatColumn.
Referenced by casacore::ArrayColumnBase::baseGetSlice().
Initialize the rows from startRow till endRow (inclusive) with the default value defined in the column description.
Implemented in casacore::ConcatColumn, casacore::RefColumn, casacore::ArrayColumnData, casacore::ScalarRecordColumnData, and casacore::ScalarColumnData< T >.
Test if the given cell contains a defined value.
Implemented in casacore::ArrayColumnData, casacore::RefColumn, casacore::ConcatColumn, casacore::ScalarRecordColumnData, and casacore::ScalarColumnData< T >.
Referenced by casacore::TableColumn::isDefined().
|
pure virtual |
Test if the column is stored (otherwise it is virtual).
Implemented in casacore::RefColumn, casacore::ConcatColumn, and casacore::PlainColumn.
|
pure virtual |
Test if the column is writable.
Implemented in casacore::RefColumn, casacore::ConcatColumn, and casacore::PlainColumn.
|
pure virtual |
Implemented in casacore::RefColumn, casacore::ConcatColumn, and casacore::PlainColumn.
Referenced by casacore::TableColumn::keywordSet().
|
virtual |
Do it only for the given row numbers.
Reimplemented in casacore::ScalarRecordColumnData, casacore::ScalarColumnData< T >, and casacore::ConcatScalarColumn< T >.
|
virtual |
Add this column and its data to the Sort object.
It may allocate some storage on the heap, which will be saved in the argument dataSave. The function freeSortKey must be called to free this storage.
Reimplemented in casacore::RefColumn, casacore::ScalarRecordColumnData, casacore::ScalarColumnData< T >, and casacore::ConcatScalarColumn< T >.
Get the #dimensions of an array in a particular cell.
Reimplemented in casacore::RefColumn, casacore::ConcatColumn, and casacore::ArrayColumnData.
Referenced by casacore::ArrayColumnBase::ndim(), casacore::ArrayColumn< casacore::String >::ndim(), and casacore::TableColumn::ndim().
|
virtual |
Get the global #dimensions of an array (ie.
for all rows).
Reimplemented in casacore::RefColumn, casacore::ConcatColumn, and casacore::ArrayColumnData.
Referenced by casacore::TableColumn::ndimColumn().
|
pure virtual |
Get nr of rows in the column.
Implemented in casacore::RefColumn, casacore::ConcatColumn, and casacore::PlainColumn.
Referenced by casacore::TableColumn::nrow().
|
virtual |
Put the scalar value in a particular cell.
Reimplemented in casacore::RefColumn, casacore::ConcatColumn, casacore::ScalarRecordColumnData, and casacore::ScalarColumnData< T >.
Referenced by casacore::ScalarColumn< casacore::String >::put().
Put the array value in a particular cell.
Reimplemented in casacore::ArrayColumnData, casacore::RefColumn, and casacore::ConcatColumn.
Referenced by casacore::ArrayColumnBase::basePut().
|
virtual |
Put the array of all array values in the column.
If the column contains n-dim arrays, the source array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.
Reimplemented in casacore::ArrayColumnData, casacore::RefColumn, and casacore::ConcatColumn.
|
virtual |
Get the array of some array values in a column.
If the column contains n-dim arrays, the resulting array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.
Reimplemented in casacore::RefColumn, casacore::ArrayColumnData, and casacore::ConcatColumn.
|
virtual |
Put into subsections of all table arrays in the column.
If the column contains n-dim arrays, the source array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.
Reimplemented in casacore::ArrayColumnData, casacore::RefColumn, and casacore::ConcatColumn.
|
virtual |
Put subsections of some arrays in the column.
If the column contains n-dim arrays, the source array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.
Reimplemented in casacore::ArrayColumnData, casacore::RefColumn, and casacore::ConcatColumn.
Put the value into the row and convert it from the given type.
This can only be used for scalar columns with a standard data type.
Referenced by putScalar(), and casacore::TableColumn::putScalar().
void casacore::BaseColumn::putScalar | ( | rownr_t | rownr, |
const float & | value | ||
) |
void casacore::BaseColumn::putScalar | ( | rownr_t | rownr, |
const double & | value | ||
) |
void casacore::BaseColumn::putScalar | ( | rownr_t | rownr, |
const Complex & | value | ||
) |
void casacore::BaseColumn::putScalar | ( | rownr_t | rownr, |
const DComplex & | value | ||
) |
Definition at line 273 of file BaseColumn.h.
References putScalar().
void casacore::BaseColumn::putScalar | ( | rownr_t | rownr, |
const TableRecord & | value | ||
) |
|
virtual |
Put the vector of all scalar values in the column.
Reimplemented in casacore::RefColumn, casacore::ScalarRecordColumnData, casacore::ScalarColumnData< T >, and casacore::ConcatScalarColumn< T >.
|
virtual |
Get the vector of some scalar values in a column.
Reimplemented in casacore::RefColumn, casacore::ScalarRecordColumnData, casacore::ScalarColumnData< T >, and casacore::ConcatScalarColumn< T >.
|
virtual |
Put a slice of an N-dimensional array in a particular cell.
Reimplemented in casacore::ArrayColumnData, casacore::RefColumn, and casacore::ConcatColumn.
Referenced by casacore::ArrayColumnBase::basePutSlice().
|
pure virtual |
Get access to the column keyword set.
Implemented in casacore::RefColumn, casacore::ConcatColumn, and casacore::PlainColumn.
|
pure virtual |
Set the maximum cache size (in bytes) to be used by a storage manager.
Implemented in casacore::RefColumn, casacore::ConcatColumn, and casacore::PlainColumn.
Referenced by casacore::TableColumn::setMaximumCacheSize().
Set the shape of the array in the given row.
Reimplemented in casacore::ArrayColumnData, casacore::RefColumn, and casacore::ConcatColumn.
|
virtual |
Set the shape and tile shape of the array in the given row.
Reimplemented in casacore::ArrayColumnData, casacore::RefColumn, and casacore::ConcatColumn.
Get the shape of an array in a particular cell.
Reimplemented in casacore::RefColumn, casacore::ConcatColumn, and casacore::ArrayColumnData.
Referenced by casacore::ArrayColumnBase::shape(), casacore::ArrayColumn< casacore::String >::shape(), and casacore::TableColumn::shape().
|
virtual |
Get the global shape of an array (ie.
for all rows).
Reimplemented in casacore::RefColumn, casacore::ConcatColumn, and casacore::ArrayColumnData.
Referenced by casacore::TableColumn::shapeColumn().
|
protected |
Throw exceptions for invalid scalar get or put.
|
protected |
|
protected |
|
protected |
Get the tile shape of an array in a particular cell.
Reimplemented in casacore::ConcatColumn, and casacore::ArrayColumnData.
Referenced by casacore::TableColumn::tileShape().
|
mutableprivate |
Definition at line 321 of file BaseColumn.h.
|
protected |
Definition at line 316 of file BaseColumn.h.