casacore
|
Virtual column forwarding to another column. More...
#include <ForwardCol.h>
Public Member Functions | |
ForwardColumn (ForwardColumnEngine *enginePtr, const String &columnName, int dataType, const String &dataTypeId, const Table &referencedTable) | |
Construct it for the given column. More... | |
virtual | ~ForwardColumn () |
Destructor is mandatory. More... | |
void | fillTableName (const Table &thisTable, const Table &referencedTable) |
Define the special keyword containing the name of the original table. More... | |
virtual void | prepare (const Table &thisTable) |
Initialize the object. More... | |
void | setRW () |
Set the column to writable if its underlying table is writable. More... | |
Public Member Functions inherited from casacore::DataManagerColumn | |
DataManagerColumn () | |
Create a column. More... | |
virtual | ~DataManagerColumn () |
Frees up the storage. More... | |
void | setIsFixedShape (Bool isFixedShape) |
Set the isFixedShape flag. More... | |
Bool | isFixedShape () const |
Is this a fixed shape column? More... | |
virtual void | setMaxLength (uInt maxLength) |
Set the maximum length of the value (can be used for strings). More... | |
void | setFixedShapeColumn (const IPosition &shape) |
Set the shape of all (fixed-shaped) arrays in the column. More... | |
virtual void | setShapeTiled (rownr_t rownr, const IPosition &shape, const IPosition &tileShape) |
Set the shape and tile shape of an (variable-shaped) array in the given row. More... | |
virtual IPosition | tileShape (rownr_t rownr) |
Get the tile shape of the item in the given row. More... | |
ColumnCache & | columnCache () |
Get access to the ColumnCache object. More... | |
const ColumnCache * | columnCachePtr () const |
void | get (rownr_t rownr, Bool *dataPtr) |
Get the scalar value in the given row. More... | |
void | get (rownr_t rownr, uChar *dataPtr) |
void | get (rownr_t rownr, Short *dataPtr) |
void | get (rownr_t rownr, uShort *dataPtr) |
void | get (rownr_t rownr, Int *dataPtr) |
void | get (rownr_t rownr, uInt *dataPtr) |
void | get (rownr_t rownr, Int64 *dataPtr) |
void | get (rownr_t rownr, float *dataPtr) |
void | get (rownr_t rownr, double *dataPtr) |
void | get (rownr_t rownr, Complex *dataPtr) |
void | get (rownr_t rownr, DComplex *dataPtr) |
void | get (rownr_t rownr, String *dataPtr) |
void | get (rownr_t rownr, void *dataPtr) |
This function is the get for all non-standard data types. More... | |
void | put (rownr_t rownr, const Bool *dataPtr) |
Put the scalar value into the given row. More... | |
void | put (rownr_t rownr, const uChar *dataPtr) |
void | put (rownr_t rownr, const Short *dataPtr) |
void | put (rownr_t rownr, const uShort *dataPtr) |
void | put (rownr_t rownr, const Int *dataPtr) |
void | put (rownr_t rownr, const uInt *dataPtr) |
void | put (rownr_t rownr, const Int64 *dataPtr) |
void | put (rownr_t rownr, const float *dataPtr) |
void | put (rownr_t rownr, const double *dataPtr) |
void | put (rownr_t rownr, const Complex *dataPtr) |
void | put (rownr_t rownr, const DComplex *dataPtr) |
void | put (rownr_t rownr, const String *dataPtr) |
void | put (rownr_t rownr, const void *dataPtr) |
This function is the put for all non-standard data types. More... | |
void | throwGet () const |
Throw an "invalid operation" exception for the default implementation of get. More... | |
void | throwPut () const |
Throw an "invalid operation" exception for the default implementation of put. More... | |
void | setColumnName (const String &colName) |
Set the column name. More... | |
const String & | columnName () const |
Get rhe column name. More... | |
Protected Member Functions | |
void | basePrepare (const Table &thisTable, Bool writable) |
Do the preparation of the base class column object. More... | |
BaseColumn * | colPtr () const |
Protected Member Functions inherited from casacore::DataManagerColumn | |
void | getScalarColumnBase (ArrayBase &dataPtr) |
The default implementations of get and put functions. More... | |
void | putScalarColumnBase (const ArrayBase &dataPtr) |
void | getScalarColumnCellsBase (const RefRows &rownrs, ArrayBase &dataPtr) |
void | putScalarColumnCellsBase (const RefRows &rownrs, const ArrayBase &dataPtr) |
void | getArrayColumnBase (ArrayBase &data) |
void | putArrayColumnBase (const ArrayBase &data) |
void | getArrayColumnCellsBase (const RefRows &rownrs, ArrayBase &data) |
void | putArrayColumnCellsBase (const RefRows &rownrs, const ArrayBase &data) |
void | getSliceBase (rownr_t rownr, const Slicer &slicer, ArrayBase &data) |
void | putSliceBase (rownr_t rownr, const Slicer &slicer, const ArrayBase &data) |
void | getColumnSliceBase (const Slicer &slicer, ArrayBase &data) |
void | putColumnSliceBase (const Slicer &slicer, const ArrayBase &data) |
void | getColumnSliceCellsBase (const RefRows &rownrs, const Slicer &slicer, ArrayBase &data) |
void | putColumnSliceCellsBase (const RefRows &rownrs, const Slicer &slicer, const ArrayBase &data) |
Private Member Functions | |
ForwardColumn (const ForwardColumn &) | |
Copy constructor is not needed and therefore forbidden (so make it private). More... | |
ForwardColumn & | operator= (const ForwardColumn &) |
Assignment is not needed and therefore forbidden (so make it private). More... | |
Bool | canChangeShape () const |
This data manager may be able to handle changing array shapes. More... | |
int | dataType () const |
Get the data type of the column as defined in DataType.h. More... | |
String | dataTypeId () const |
Get the data type id of the column for dataType==TpOther. More... | |
Bool | isWritable () const |
Test if data can be put into this column. More... | |
void | setShapeColumn (const IPosition &shape) |
Set the shape of an direct array. More... | |
void | setShape (rownr_t rownr, const IPosition &shape) |
Set the shape of an (indirect) array in the given row. More... | |
Bool | isShapeDefined (rownr_t rownr) |
Is the value shape defined in the given row? More... | |
uInt | ndim (rownr_t rownr) |
Get the dimensionality of the item in the given row. More... | |
IPosition | shape (rownr_t rownr) |
Get the shape of the item in the given row. More... | |
virtual void | getBool (rownr_t rownr, Bool *dataPtr) |
Get the scalar value with a standard data type in the given row. More... | |
virtual void | getuChar (rownr_t rownr, uChar *dataPtr) |
virtual void | getShort (rownr_t rownr, Short *dataPtr) |
virtual void | getuShort (rownr_t rownr, uShort *dataPtr) |
virtual void | getInt (rownr_t rownr, Int *dataPtr) |
virtual void | getuInt (rownr_t rownr, uInt *dataPtr) |
virtual void | getInt64 (rownr_t rownr, Int64 *dataPtr) |
virtual void | getfloat (rownr_t rownr, float *dataPtr) |
virtual void | getdouble (rownr_t rownr, double *dataPtr) |
virtual void | getComplex (rownr_t rownr, Complex *dataPtr) |
virtual void | getDComplex (rownr_t rownr, DComplex *dataPtr) |
virtual void | getString (rownr_t rownr, String *dataPtr) |
virtual void | getOther (rownr_t rownr, void *dataPtr) |
Get the scalar value with a non-standard data type in the given row. More... | |
virtual void | putBool (rownr_t rownr, const Bool *dataPtr) |
Put the scalar value with a standard data type into the given row. More... | |
virtual void | putuChar (rownr_t rownr, const uChar *dataPtr) |
virtual void | putShort (rownr_t rownr, const Short *dataPtr) |
virtual void | putuShort (rownr_t rownr, const uShort *dataPtr) |
virtual void | putInt (rownr_t rownr, const Int *dataPtr) |
virtual void | putuInt (rownr_t rownr, const uInt *dataPtr) |
virtual void | putInt64 (rownr_t rownr, const Int64 *dataPtr) |
virtual void | putfloat (rownr_t rownr, const float *dataPtr) |
virtual void | putdouble (rownr_t rownr, const double *dataPtr) |
virtual void | putComplex (rownr_t rownr, const Complex *dataPtr) |
virtual void | putDComplex (rownr_t rownr, const DComplex *dataPtr) |
virtual void | putString (rownr_t rownr, const String *dataPtr) |
virtual void | putOther (rownr_t rownr, const void *dataPtr) |
Put the scalar value with a non-standard data type into the given row. More... | |
void | getScalarColumnV (ArrayBase &dataPtr) |
Get all scalar values in the column. More... | |
void | putScalarColumnV (const ArrayBase &dataPtr) |
Put all scalar values in the column. More... | |
virtual void | getScalarColumnCellsV (const RefRows &rownrs, ArrayBase &dataPtr) |
Get some scalar values in the column. More... | |
virtual void | putScalarColumnCellsV (const RefRows &rownrs, const ArrayBase &dataPtr) |
Put some scalar values in the column. More... | |
void | getArrayV (rownr_t rownr, ArrayBase &dataPtr) |
Get the array value in the given row. More... | |
void | putArrayV (rownr_t rownr, const ArrayBase &dataPtr) |
Put the array value into the given row. More... | |
void | getSliceV (rownr_t rownr, const Slicer &slicer, ArrayBase &dataPtr) |
Get a section of the array in the given row. More... | |
void | putSliceV (rownr_t rownr, const Slicer &slicer, const ArrayBase &dataPtr) |
Put into a section of the array in the given row. More... | |
void | getArrayColumnV (ArrayBase &dataPtr) |
Get all scalar values in the column. More... | |
void | putArrayColumnV (const ArrayBase &dataPtr) |
Put all scalar values in the column. More... | |
virtual void | getArrayColumnCellsV (const RefRows &rownrs, ArrayBase &dataPtr) |
Get some array values in the column. More... | |
virtual void | putArrayColumnCellsV (const RefRows &rownrs, const ArrayBase &dataPtr) |
Put some array values in the column. More... | |
void | getColumnSliceV (const Slicer &slicer, ArrayBase &dataPtr) |
Get a section of all arrays in the column. More... | |
void | putColumnSliceV (const Slicer &slicer, const ArrayBase &dataPtr) |
Put a section into all arrays in the column. More... | |
virtual void | getColumnSliceCellsV (const RefRows &rownrs, const Slicer &slicer, ArrayBase &dataPtr) |
Get a section of some arrays in the column. More... | |
virtual void | putColumnSliceCellsV (const RefRows &rownrs, const Slicer &slicer, const ArrayBase &dataPtr) |
Put into a section of some arrays in the column. More... | |
Static Private Member Functions | |
static SetupNewTable | setupNewTable (const Table &table, const String &tableName, Table::TableOption option) |
Create a SetupNewTable object with the given name and option and with the description from the given table. More... | |
Private Attributes | |
ForwardColumnEngine * | enginePtr_p |
String | colName_p |
int | dataType_p |
String | dataTypeId_p |
TableColumn | refCol_p |
Bool | writable_p |
Table | origTable_p |
BaseColumn * | colPtr_p |
Virtual column forwarding to another column.
Internal
ForwardColumn represents a virtual column which forwards the gets and puts to a column with the same name in another table. It is, in fact, a reference to the other column. The name of the other table is stored as a keyword in the forwarding column. When there is a forwarding chain (i.e. forwarding to a forwarding column), the name of the last table in the chain is stored in the keyword. In this way, the length of the chain is kept to a minimum. Otherwise a very long chain could occur, which would slow things down.
Addition and deletion of rows is allowed, but the functions addRow and removeRow do not do anything at all. They are implemented to override the default "throw exception" implementation. Because the engine allows this, it can be used in a table supporting addition and removal of rows.
An object of this class is created (and deleted) by ForwardColumnEngine which creates a ForwardColumn object for each column being forwarded.
This class will be used by the calibration software. Most columns in a measurement table will be forwarded, while a few (i.e. the data themselves) will be calculated by a dedicated calibration engine.
Definition at line 91 of file ForwardCol.h.
casacore::ForwardColumn::ForwardColumn | ( | ForwardColumnEngine * | enginePtr, |
const String & | columnName, | ||
int | dataType, | ||
const String & | dataTypeId, | ||
const Table & | referencedTable | ||
) |
Construct it for the given column.
|
virtual |
Destructor is mandatory.
|
private |
Copy constructor is not needed and therefore forbidden (so make it private).
Do the preparation of the base class column object.
|
privatevirtual |
This data manager may be able to handle changing array shapes.
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
inlineprotected |
Definition at line 127 of file ForwardCol.h.
References colPtr_p.
|
privatevirtual |
Get the data type of the column as defined in DataType.h.
Implements casacore::DataManagerColumn.
|
privatevirtual |
Get the data type id of the column for dataType==TpOther.
This function is required for virtual column engines handling non-standard data types. It is used to check the data type.
Reimplemented from casacore::DataManagerColumn.
void casacore::ForwardColumn::fillTableName | ( | const Table & | thisTable, |
const Table & | referencedTable | ||
) |
Define the special keyword containing the name of the original table.
If the column in the referenced table contains that special keyword, it is in its turn a forwarding column. In that case the special keyword value will be copied over to shortcut the forwarding chain. The suffix is appended to the keyword name when defining it. This makes this function usable for derived classes.
|
privatevirtual |
Get some array values in the column.
The argument dataPtr is in fact an Array<T>&, but a ArrayBase& is needed to be generic. The vector pointed to by dataPtr has to have the correct length (which is guaranteed by the ArrayColumn getColumn function).
Reimplemented from casacore::DataManagerColumn.
|
privatevirtual |
Get all scalar values in the column.
The argument dataPtr is in fact a Vector<T>&, but a ArrayBase& is needed to be generic. The vector pointed to by dataPtr has to have the correct length (which is guaranteed by the ScalarColumn getColumn function).
Reimplemented from casacore::DataManagerColumn.
Get the array value in the given row.
The argument dataPtr is in fact a Array<T>&, but a ArrayBase& is needed to be generic. The array pointed to by dataPtr has to have the correct shape (which is guaranteed by the ArrayColumn get function).
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
Get the scalar value with a standard data type in the given row.
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Get a section of some arrays in the column.
The argument dataPtr is in fact an Array<T>&, but a ArrayBase& is needed to be generic. The array pointed to by dataPtr has to have the correct shape (which is guaranteed by the ArrayColumn getColumn function).
Reimplemented from casacore::DataManagerColumn.
|
privatevirtual |
Get a section of all arrays in the column.
The argument dataPtr is in fact a Array<T>&, but a ArrayBase& is needed to be generic. The array pointed to by dataPtr has to have the correct shape (which is guaranteed by the ArrayColumn getColumn function).
Reimplemented from casacore::DataManagerColumn.
|
privatevirtual |
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Get the scalar value with a non-standard data type in the given row.
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Get some scalar values in the column.
The argument dataPtr is in fact a Vector<T>&, but a ArrayBase& is needed to be generic. The vector pointed to by dataPtr has to have the correct length (which is guaranteed by the ScalarColumn getColumn function).
Reimplemented from casacore::DataManagerColumn.
|
privatevirtual |
Get all scalar values in the column.
The argument dataPtr is in fact a Vector<T>&, but a ArrayBase& is needed to be generic. The vector pointed to by dataPtr has to have the correct length (which is guaranteed by the ScalarColumn getColumn function).
Reimplemented from casacore::DataManagerColumn.
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Get a section of the array in the given row.
The argument dataPtr is in fact a Array<T>&, but a ArrayBase& is needed to be generic. The array pointed to by dataPtr has to have the correct shape (which is guaranteed by the ArrayColumn getSlice function).
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
Is the value shape defined in the given row?
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Test if data can be put into this column.
Reimplemented from casacore::DataManagerColumn.
Get the dimensionality of the item in the given row.
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
private |
Assignment is not needed and therefore forbidden (so make it private).
|
virtual |
Initialize the object.
This means binding the column to the column with the same name in the original table. It checks if the description of both columns is the same. It also determines if the column is writable.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Put some array values in the column.
The argument dataPtr is in fact an const Array<T>&, but a const ArrayBase& is needed to be generic. The vector pointed to by dataPtr has to have the correct length (which is guaranteed by the ArrayColumn getColumn function).
Reimplemented from casacore::DataManagerColumn.
|
privatevirtual |
Put all scalar values in the column.
The argument dataPtr is in fact a const Vector<T>&, but a const ArrayBase& is needed to be generic. The vector pointed to by dataPtr has to have the correct length (which is guaranteed by the ScalarColumn putColumn function).
Reimplemented from casacore::DataManagerColumn.
Put the array value into the given row.
The argument dataPtr is in fact a const Array<T>&, but a const ArrayBase& is needed to be generic. The array pointed to by dataPtr has to have the correct shape (which is guaranteed by the ArrayColumn put function).
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Put the scalar value with a standard data type into the given row.
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Put into a section of some arrays in the column.
The argument dataPtr is in fact a const Array<T>&, but a const ArrayBase& is needed to be generic. The array pointed to by dataPtr has to have the correct shape (which is guaranteed by the ArrayColumn putColumn function).
Reimplemented from casacore::DataManagerColumn.
|
privatevirtual |
Put a section into all arrays in the column.
The argument dataPtr is in fact a const Array<T>&, but a const ArrayBase& is needed to be generic. The array pointed to by dataPtr has to have the correct shape (which is guaranteed by the ArrayColumn putColumn function).
Reimplemented from casacore::DataManagerColumn.
|
privatevirtual |
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Put the scalar value with a non-standard data type into the given row.
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Put some scalar values in the column.
The argument dataPtr is in fact a const Vector<T>&, but a const ArrayBase& is needed to be generic. The vector pointed to by dataPtr has to have the correct length (which is guaranteed by the ScalarColumn getColumn function).
Reimplemented from casacore::DataManagerColumn.
|
privatevirtual |
Put all scalar values in the column.
The argument dataPtr is in fact a const Vector<T>&, but a const ArrayBase& is needed to be generic. The vector pointed to by dataPtr has to have the correct length (which is guaranteed by the ScalarColumn putColumn function).
Reimplemented from casacore::DataManagerColumn.
|
privatevirtual |
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Put into a section of the array in the given row.
The argument dataPtr is in fact a const Array<T>&, but a const ArrayBase& is needed to be generic. The array pointed to by dataPtr has to have the correct shape (which is guaranteed by the ArrayColumn putSlice function).
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
void casacore::ForwardColumn::setRW | ( | ) |
Set the column to writable if its underlying table is writable.
Set the shape of an (indirect) array in the given row.
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
privatevirtual |
Set the shape of an direct array.
This only checks if the shape matches the referenced column.
Reimplemented from casacore::DataManagerColumn.
|
staticprivate |
Create a SetupNewTable object with the given name and option and with the description from the given table.
The SetupNewTable object will use a single ForwardColumn engine which forwards all columns to the given table. Later the SetupNewTable::bind functions can be used to bind one or more columns to another data manager.
Get the shape of the item in the given row.
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::ForwardColumnIndexedRow.
|
private |
Definition at line 338 of file ForwardCol.h.
|
private |
Definition at line 346 of file ForwardCol.h.
Referenced by colPtr().
|
private |
Definition at line 339 of file ForwardCol.h.
|
private |
Definition at line 340 of file ForwardCol.h.
|
private |
Definition at line 337 of file ForwardCol.h.
|
private |
Definition at line 345 of file ForwardCol.h.
|
private |
Definition at line 341 of file ForwardCol.h.
|
private |
Definition at line 344 of file ForwardCol.h.