casacore
|
#include <VACEngine.h>
Public Member Functions | |
VACEngine () | |
The default constructor is required for reconstruction of the engine when a table is read back. More... | |
VACEngine (const String &sourceColumnName) | |
Construct an engine to handle a column with an arbitrary data type. More... | |
~VACEngine () | |
Destructor is mandatory. More... | |
String | dataManagerType () const |
Return the data manager type name. More... | |
const String & | sourceColumnName () const |
Get the name of the source column. More... | |
Public Member Functions inherited from casacore::VirtualColumnEngine | |
VirtualColumnEngine () | |
Create the object. More... | |
virtual | ~VirtualColumnEngine () |
Public Member Functions inherited from casacore::DataManager | |
DataManager () | |
Default constructor. More... | |
virtual | ~DataManager () |
virtual DataManager * | clone () const =0 |
Make a clone of the derived object. More... | |
virtual String | dataManagerName () const |
Return the name of the data manager. More... | |
void | dataManagerInfo (Record &info) const |
Add SEQNR and SPEC (the DataManagerSpec subrecord) to the info. More... | |
virtual Record | dataManagerSpec () const |
Return a record containing data manager specifications. More... | |
virtual Record | getProperties () const |
Get data manager properties that can be modified. More... | |
virtual void | setProperties (const Record &spec) |
Modify data manager properties given in record fields. More... | |
virtual Bool | canReallocateColumns () const |
Tell if the data manager wants to reallocate the data manager column objects. More... | |
virtual DataManagerColumn * | reallocateColumn (DataManagerColumn *column) |
Reallocate the column object if it is part of this data manager. More... | |
uInt | sequenceNr () const |
Get the (unique) sequence nr of this data manager. More... | |
uInt | ncolumn () const |
Get the nr of columns in this data manager (can be zero). More... | |
Bool | asBigEndian () const |
Have the data to be stored in big or little endian canonical format? More... | |
const TSMOption & | tsmOption () const |
Get the TSM option. More... | |
MultiFileBase * | multiFile () |
Get the MultiFile pointer (can be 0). More... | |
String | keywordName (const String &keyword) const |
Compose a keyword name from the given keyword appended with the sequence number (e.g. More... | |
String | fileName () const |
Compose a unique filename from the table name and sequence number. More... | |
ByteIO::OpenOption | fileOption () const |
Get the AipsIO option of the underlying file. More... | |
virtual Bool | isRegular () const |
Is this a regular storage manager? It is regular if it allows addition of rows and writing data in them. More... | |
Table & | table () const |
Get the table this object is associated with. More... | |
virtual void | reopenRW () |
Reopen the data manager for read/write access. More... | |
virtual Bool | canAddColumn () const |
Does the data manager allow to add columns? (default no) More... | |
virtual Bool | canRemoveColumn () const |
Does the data manager allow to delete columns? (default no) More... | |
virtual Bool | canRenameColumn () const |
Does the data manager allow to rename columns? (default yes) More... | |
virtual void | setMaximumCacheSize (uInt nMiB) |
Set the maximum cache size (in bytes) to be used by a storage manager. More... | |
virtual void | showCacheStatistics (std::ostream &) const |
Show the data manager's IO statistics. More... | |
DataManagerColumn * | createScalarColumn (const String &columnName, int dataType, const String &dataTypeId) |
Create a column in the data manager on behalf of a table column. More... | |
DataManagerColumn * | createDirArrColumn (const String &columnName, int dataType, const String &dataTypeId) |
Create a direct array column. More... | |
DataManagerColumn * | createIndArrColumn (const String &columnName, int dataType, const String &dataTypeId) |
Create an indirect array column. More... | |
DataManager * | getClone () const |
Has the object already been cloned? More... | |
void | setClone (DataManager *clone) const |
Set the pointer to the clone. More... | |
Public Member Functions inherited from casacore::VirtualArrayColumn< T > | |
VirtualArrayColumn () | |
Create a column. More... | |
virtual | ~VirtualArrayColumn () |
virtual int | dataType () const |
Return the data type of the column. More... | |
virtual String | dataTypeId () const |
Return the data type Id of the column. More... | |
Public Member Functions inherited from casacore::VirtualArrayColumnBase | |
VirtualArrayColumnBase () | |
Create a column. More... | |
virtual | ~VirtualArrayColumnBase () |
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 uInt | ndim (rownr_t rownr) |
Get the dimensionality of the item in the given row. More... | |
virtual IPosition | tileShape (rownr_t rownr) |
Get the tile shape of the item in the given row. More... | |
virtual Bool | canChangeShape () const |
Can the data manager handle chaging the shape of an existing array? Default is no. 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 | |
VACEngine (const VACEngine< T > &) | |
Copy constructor is only used by clone(). More... | |
Protected Member Functions inherited from casacore::DataManager | |
void | decrementNcolumn () |
Decrement number of columns (in case a column is deleted). More... | |
void | setEndian (Bool bigEndian) |
Tell the data manager if big or little endian format is needed. More... | |
void | setTsmOption (const TSMOption &tsmOption) |
Tell the data manager which TSM option to use. More... | |
void | setMultiFile (MultiFileBase *mfile) |
Tell the data manager that MultiFile can be used. More... | |
virtual Bool | hasMultiFileSupport () const |
Does the data manager support use of MultiFile? A derived class has to return True if it can use the MultiFile. More... | |
void | throwDataTypeOther (const String &columnName, int dataType) const |
Throw an exception in case data type is TpOther, because the storage managers (and maybe other data managers) do not support such columns. More... | |
Protected Member Functions inherited from casacore::VirtualArrayColumn< T > | |
virtual void | getArray (rownr_t rownr, Array< T > &data)=0 |
Get the array value in the given row. More... | |
virtual void | putArray (rownr_t rownr, const Array< T > &data) |
Put the array value into the given row. More... | |
virtual void | getSlice (rownr_t rownr, const Slicer &slicer, Array< T > &data) |
Get a section of the array in the given row. More... | |
virtual void | putSlice (rownr_t rownr, const Slicer &slicer, const Array< T > &data) |
Put into a section of the array in the given row. More... | |
virtual void | getArrayColumn (Array< T > &data) |
Get an entire column. More... | |
virtual void | putArrayColumn (const Array< T > &data) |
Put an entire column. More... | |
virtual void | getArrayColumnCells (const RefRows &rownrs, Array< T > &data) |
Get some array values in the column. More... | |
virtual void | putArrayColumnCells (const RefRows &rownrs, const Array< T > &data) |
Put some array values in the column. More... | |
virtual void | getColumnSlice (const Slicer &slicer, Array< T > &data) |
Get a section of all arrays in the column. More... | |
virtual void | putColumnSlice (const Slicer &slicer, const Array< T > &data) |
Put a section of all arrays in the column. More... | |
virtual void | getColumnSliceCells (const RefRows &rownrs, const Slicer &slicer, Array< T > &data) |
Get a section of some arrays in the column. More... | |
virtual void | putColumnSliceCells (const RefRows &rownrs, const Slicer &slicer, const Array< T > &data) |
Put into a section of some arrays in the column. More... | |
Protected Member Functions inherited from casacore::VirtualArrayColumnBase | |
virtual void | setShapeColumn (const IPosition &shape) |
Set the shape of all arrays in the column. More... | |
virtual void | setShape (rownr_t rownr, const IPosition &shape) |
Set the shape of an array in the given row. More... | |
virtual Bool | isShapeDefined (rownr_t rownr) |
Is the value shape defined in the given row? By default it throws a "not possible" exception. More... | |
virtual IPosition | shape (rownr_t rownr) |
Get the shape of the item in the given row. More... | |
virtual void | getScalarColumnV (ArrayBase &dataPtr) |
The scalar access functions throw an exception. More... | |
virtual 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... | |
Protected Member Functions inherited from casacore::DataManagerColumn | |
virtual void | getBool (rownr_t rownr, Bool *dataPtr) |
Get the scalar value 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) |
This function is the get for all non-standard data types. More... | |
virtual void | putBool (rownr_t rownr, const Bool *dataPtr) |
Put the scalar value 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) |
This function is the put for all non-standard data types. More... | |
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 | |
VACEngine< T > & | operator= (const VACEngine< T > &) |
Assignment is not needed and therefore forbidden (so it is made private). More... | |
Bool | isWritable () const |
The column is in principle writable. More... | |
DataManagerColumn * | makeDirArrColumn (const String &columnName, int dataType, const String &dataTypeID) |
Create the column object for the array column in this engine. More... | |
DataManagerColumn * | makeIndArrColumn (const String &columnName, int dataType, const String &dataTypeID) |
Create an indirect array column. More... | |
Private Attributes | |
String | sourceName_p |
Additional Inherited Members | |
Static Public Member Functions inherited from casacore::DataManager | |
static void | registerCtor (const String &type, DataManagerCtor func) |
Register a mapping of a data manager type to its static construction function. More... | |
static DataManagerCtor | getCtor (const String &dataManagerType) |
Get the "constructor" of a data manager (thread-safe). More... | |
static Bool | isRegistered (const String &dataManagerType) |
Test if a data manager is registered (thread-safe). More... | |
static DataManager * | unknownDataManager (const String &dataManagerType, const Record &spec) |
Serve as default function for theirRegisterMap, which catches all unknown data manager types. More... | |
Static Public Attributes inherited from casacore::DataManager | |
static rownr_t | MAXROWNR32 |
Define the highest row number that can be represented as signed 32-bit. More... | |
Base virtual column for an array column with any type
Public interface
VACEngine stands for Virtual Array Column Engine, i.e. a class handling a virtual table column containing array values.
VACEngine is a base virtual column engine to handle a column with an arbitrary type. Data of columns with standard data types can directly be stored in a Table using a storage manager, but data of column with non-standard types have to be stored in another way. The way to do this is to split the object with the non-standard type into its individual elements, which are subsequently put into the appropriate columns.
A virtual column engine has to be implemented for each non-standard data type, which has to be stored in a table. This engine has to get and put the individual parts the object. VACEngine is the base class for such engines, so the actual engine quite simple to implement. The example shows the implementation of an engine AVACEngine handling a data type A.
In principle the name of the engine class is free, but it is strongly recommended to use the name <dataTypeId>VACEngine
, where VAC stands for Virtual Array Column (e.g. AVACEngine
for class A). In this way the default data manager name supplied by the class and by class ArrayColumnDesc can be used.
This example shows the implementation of an engine class AVACEngine, which stores the data of a class A. The data objects A are stored in a column called the source column. The user has to associate two target columns with it. The engine stores the data parts x and y in the target columns. The names of the target columns are stored as keywords in the source column. In this way the engine can reconstruct itself when the table is read back.
In the example all AVACEngine functions are shown inline, but they should be implemented out-of-line in a separate.cc file.
User code using this engine to create a new table could look like:
This class makes it easier for the user to implement the engine. It supplies several default functions.
static String dataTypeId();
This should return the (unique) name of the class, thus when T is templated in its turn, the name should contain the template argument name. Definition at line 288 of file VACEngine.h.
casacore::VACEngine< T >::VACEngine | ( | ) |
The default constructor is required for reconstruction of the engine when a table is read back.
It is also used to construct an engine, which does not check the source column name.
casacore::VACEngine< T >::VACEngine | ( | const String & | sourceColumnName | ) |
Construct an engine to handle a column with an arbitrary data type.
Later it will check if the source column name is correct.
casacore::VACEngine< T >::~VACEngine | ( | ) |
Destructor is mandatory.
|
protected |
Copy constructor is only used by clone().
(so it is made protected).
|
virtual |
Return the data manager type name.
This defaults to the data type ID followed by VACEngine (meaning Virtual Array Column Engine).
Implements casacore::DataManager.
|
privatevirtual |
The column is in principle writable.
This does not mean it is actually writable, because that depends on the fact if the table is writable.
Reimplemented from casacore::VirtualArrayColumnBase.
|
privatevirtual |
Create the column object for the array column in this engine.
It will check if the given column name matches the source column name. This assures that the engine is bound to the correct column.
Reimplemented from casacore::VirtualColumnEngine.
|
privatevirtual |
Create an indirect array column.
The default implementation throws an exception that it cannot do it for this column.
Reimplemented from casacore::VirtualColumnEngine.
|
private |
Assignment is not needed and therefore forbidden (so it is made private).
|
inline |
Get the name of the source column.
Definition at line 315 of file VACEngine.h.
References casacore::VACEngine< T >::sourceName_p.
|
private |
Definition at line 347 of file VACEngine.h.
Referenced by casacore::VACEngine< T >::sourceColumnName().