casa
5.7.0-16
|
Access to a table column containing scalar records. More...
#include <ScaRecordColData.h>
Public Member Functions | |
ScalarRecordColumnData (const ScalarRecordColumnDesc *, ColumnSet *) | |
Construct a scalar column object from the given description in the given column set. More... | |
~ScalarRecordColumnData () | |
virtual Bool | canAccessScalarColumn (Bool &reask) const |
Ask if the data manager can handle a column. More... | |
virtual Bool | canAccessScalarColumnCells (Bool &reask) const |
Ask if the data manager can handle some cells in a column. More... | |
virtual void | initialize (uInt startRownr, uInt endRownr) |
Initialize the rows from startRownr till endRownr (inclusive) with the default value defined in the column description. More... | |
virtual Bool | isDefined (uInt rownr) const |
Test if the given cell contains a defined value. More... | |
virtual void | get (uInt rownr, void *) const |
Get the value from a particular cell. More... | |
virtual void | getScalarColumn (void *dataPtr) const |
Get the array of all values in the column. More... | |
virtual void | getScalarColumnCells (const RefRows &rownrs, void *dataPtr) const |
Get the array of some values in the column (on behalf of RefColumn). More... | |
virtual void | put (uInt rownr, const void *dataPtr) |
Put the value in a particular cell. More... | |
virtual void | putScalarColumn (const void *dataPtr) |
Put the array of all values in the column. More... | |
virtual void | putScalarColumnCells (const RefRows &rownrs, const void *dataPtr) |
Put the array of some values in the column (on behalf on RefColumn). More... | |
virtual void | makeSortKey (Sort &, CountedPtr< BaseCompare > &cmpObj, Int order, const void *&dataSave) |
Add this column and its data to the Sort object. More... | |
virtual void | makeRefSortKey (Sort &, CountedPtr< BaseCompare > &cmpObj, Int order, const Vector< uInt > &rownrs, const void *&dataSave) |
Do it only for the given row numbers. More... | |
virtual void | freeSortKey (const void *&dataSave) |
Free storage on the heap allocated by makeSortkey(). 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... | |
virtual void | createDataManagerColumn () |
Create a data manager column object for this column. More... | |
Public Member Functions inherited from casacore::PlainColumn | |
PlainColumn (const BaseColumnDesc *, ColumnSet *) | |
virtual | ~PlainColumn () |
virtual Bool | isWritable () const |
Test if the column is in principle writable. More... | |
virtual Bool | isStored () const |
Test if the column is stored (otherwise it is virtual). More... | |
TableRecord & | rwKeywordSet () |
Get access to the column keyword set. More... | |
TableRecord & | keywordSet () |
uInt | nrow () const |
Get nr of rows in the column. More... | |
virtual void | setShapeColumn (const IPosition &shape) |
Define the shape of all arrays in the column. More... | |
virtual Bool | isBound () const |
Test if the column is bound to a storage manager or virtual column engine. More... | |
virtual void | bind (DataManager *) |
Bind the column to a data manager. More... | |
DataManager * | dataManager () const |
Get the pointer to the data manager. More... | |
DataManagerColumn *& | dataManagerColumn () |
Get the pointer to the data manager column. More... | |
virtual ColumnCache & | columnCache () |
Get a pointer to the underlying column cache. More... | |
virtual void | setMaximumCacheSize (uInt nbytes) |
Set the maximum cache size (in bytes) to be used by a storage manager. More... | |
void | putFile (AipsIO &, const TableAttr &) |
Write the column. More... | |
void | getFile (AipsIO &, const ColumnSet &, const TableAttr &) |
Read the column. More... | |
Public Member Functions inherited from casacore::BaseColumn | |
BaseColumn (const BaseColumnDesc *) | |
Construct it using the given column description. More... | |
virtual | ~BaseColumn () |
const ColumnDesc & | columnDesc () const |
Get const access to the column description. More... | |
virtual void | setShape (uInt rownr, const IPosition &shape) |
Set the shape of the array in the given row. More... | |
virtual void | setShape (uInt 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 (uInt rownr) const |
Get the #dimensions of an array in a particular cell. More... | |
virtual IPosition | shape (uInt rownr) const |
Get the shape of an array in a particular cell. More... | |
virtual IPosition | tileShape (uInt 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 Bool | canAccessArrayColumn (Bool &reask) const |
Ask if the data manager can handle an array column. More... | |
virtual Bool | canAccessArrayColumnCells (Bool &reask) const |
Ask if the data manager can handle a collection of cells in an array column. More... | |
virtual Bool | canAccessSlice (Bool &reask) const |
Ask if the data manager can handle a cell slice. More... | |
virtual Bool | canAccessColumnSlice (Bool &reask) const |
Ask if the data manager can handle a column slice. More... | |
virtual void | getSlice (uInt rownr, const Slicer &, void *dataPtr) const |
Get a slice of an N-dimensional array in a particular cell. More... | |
virtual void | getArrayColumn (void *dataPtr) const |
Get the array of all array values in a column. More... | |
virtual void | getColumnSlice (const Slicer &, void *dataPtr) const |
Get subsections from all arrays in the column. More... | |
virtual void | getArrayColumnCells (const RefRows &rownrs, void *dataPtr) const |
Get the array of some array values in a column. More... | |
virtual void | getColumnSliceCells (const RefRows &rownrs, const Slicer &, void *dataPtr) const |
Get subsections from some arrays in the column. More... | |
virtual void | putSlice (uInt rownr, const Slicer &, const void *dataPtr) |
Put a slice of an N-dimensional array in a particular cell. More... | |
virtual void | putArrayColumn (const void *dataPtr) |
Put the array of all array values in the column. More... | |
virtual void | putColumnSlice (const Slicer &, const void *dataPtr) |
Put into subsections of all table arrays in the column. More... | |
virtual void | putArrayColumnCells (const RefRows &rownrs, const void *dataPtr) |
Get the array of some array values in a column. More... | |
virtual void | putColumnSliceCells (const RefRows &rownrs, const Slicer &, const void *dataPtr) |
Put subsections of some arrays in the column. More... | |
void | getScalar (uInt rownr, Bool &value) const |
Get the value from the row and convert it to the required type. More... | |
void | getScalar (uInt rownr, uChar &value) const |
void | getScalar (uInt rownr, Short &value) const |
void | getScalar (uInt rownr, uShort &value) const |
void | getScalar (uInt rownr, Int &value) const |
void | getScalar (uInt rownr, uInt &value) const |
void | getScalar (uInt rownr, Int64 &value) const |
void | getScalar (uInt rownr, float &value) const |
void | getScalar (uInt rownr, double &value) const |
void | getScalar (uInt rownr, Complex &value) const |
void | getScalar (uInt rownr, DComplex &value) const |
void | getScalar (uInt rownr, String &value) const |
void | getScalar (uInt rownr, TableRecord &value) const |
void | getScalar (uInt rownr, void *value, const String &dataTypeId) const |
Get a scalar for the other data types. More... | |
void | putScalar (uInt rownr, const Bool &value) |
Put the value into the row and convert it from the given type. More... | |
void | putScalar (uInt rownr, const uChar &value) |
void | putScalar (uInt rownr, const Short &value) |
void | putScalar (uInt rownr, const uShort &value) |
void | putScalar (uInt rownr, const Int &value) |
void | putScalar (uInt rownr, const uInt &value) |
void | putScalar (uInt rownr, const Int64 &value) |
void | putScalar (uInt rownr, const float &value) |
void | putScalar (uInt rownr, const double &value) |
void | putScalar (uInt rownr, const Complex &value) |
void | putScalar (uInt rownr, const DComplex &value) |
void | putScalar (uInt rownr, const String &value) |
void | putScalar (uInt rownr, const Char *value) |
void | putScalar (uInt rownr, const TableRecord &value) |
Private Member Functions | |
ScalarRecordColumnData (const ScalarRecordColumnData &) | |
Copy constructor cannot be used. More... | |
ScalarRecordColumnData & | operator= (const ScalarRecordColumnData &) |
Assignment cannot be used. More... | |
virtual void | putFileDerived (AipsIO &) |
Write the column data. More... | |
virtual void | getFileDerived (AipsIO &, const ColumnSet &) |
Read the column data back. More... | |
void | getRecord (uInt rownr, TableRecord &rec) const |
Handle getting and putting a record. More... | |
void | putRecord (uInt rownr, const TableRecord &rec) |
Private Attributes | |
const ScalarRecordColumnDesc * | scaDescPtr_p |
Pointer to column description. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from casacore::PlainColumn | |
int | traceId () const |
Get the trace-id of the table. More... | |
void | checkValueLength (const void *) const |
Check the length of a value. More... | |
void | checkValueLength (const String *value) const |
void | checkValueLength (const Array< String > *value) const |
void | checkReadLock (Bool wait) const |
Lock the table before reading or writing. More... | |
void | checkWriteLock (Bool wait) const |
void | autoReleaseLock () const |
Inspect the auto lock when the inspection interval has expired and release it when another process needs the lock. More... | |
Protected Member Functions inherited from casacore::BaseColumn | |
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 inherited from casacore::PlainColumn | |
DataManager * | dataManPtr_p |
DataManagerColumn * | dataColPtr_p |
ColumnSet * | colSetPtr_p |
String | originalName_p |
Bool | rtraceColumn_p |
Bool | wtraceColumn_p |
Protected Attributes inherited from casacore::BaseColumn | |
const BaseColumnDesc * | colDescPtr_p |
Access to a table column containing scalar records.
Internal
ScalarRecordColumnData represents a table column containing scalars.
The class ScalarRecordColumnData is derived from PlainColumn. It implements the virtual functions accessing a table column containing scalars holding records.
It is possible to access an scalar in an individual cell (i.e. table row) or in the entire column.
The main task of this class is to communicate with the data manager column object. This consists of:
The class is hidden from the user by the envelope class ScalarColumn. If used directly by other Table classes, it should be done with care. It assumes that the arrays in the various get and put functions have the correct length. ScalarColumn does that check.
Definition at line 96 of file ScaRecordColData.h.
casacore::ScalarRecordColumnData::ScalarRecordColumnData | ( | const ScalarRecordColumnDesc * | , |
ColumnSet * | |||
) |
Construct a scalar column object from the given description in the given column set.
This constructor is used by ScalarRecordColumnDesc::makeColumn.
casacore::ScalarRecordColumnData::~ScalarRecordColumnData | ( | ) |
|
private |
Copy constructor cannot be used.
|
virtual |
Allocate value buffers for the table iterator.
Iteration based on records is not supported, so an exception is thrown.
Reimplemented from casacore::BaseColumn.
Ask if the data manager can handle a column.
Reimplemented from casacore::BaseColumn.
|
virtual |
Ask if the data manager can handle some cells in a column.
Reimplemented from casacore::BaseColumn.
|
virtual |
Create a data manager column object for this column.
Implements casacore::PlainColumn.
|
virtual |
Free the value buffers allocated by allocIterBuf.
Reimplemented from casacore::BaseColumn.
|
virtual |
Free storage on the heap allocated by makeSortkey().
The pointer will be set to zero.
Reimplemented from casacore::BaseColumn.
|
virtual |
Get the value from a particular cell.
Implements casacore::BaseColumn.
|
privatevirtual |
Read the column data back.
The control information is read from the given AipsIO object. This is used to bind the column to the appropriate data manager. Thereafter the data manager gets opened.
Implements casacore::PlainColumn.
|
private |
Handle getting and putting a record.
It is stored as a Vector of uChar.
|
virtual |
Get the array of all values in the column.
The length of the buffer pointed to by dataPtr must match the actual length. This is checked by ScalarColumn.
Reimplemented from casacore::BaseColumn.
|
virtual |
Get the array of some values in the column (on behalf of RefColumn).
The length of the buffer pointed to by dataPtr must match the actual length. This is checked by ScalarColumn.
Reimplemented from casacore::BaseColumn.
|
virtual |
Initialize the rows from startRownr till endRownr (inclusive) with the default value defined in the column description.
Implements casacore::BaseColumn.
Test if the given cell contains a defined value.
Implements casacore::BaseColumn.
|
virtual |
Do it only for the given row numbers.
Reimplemented from casacore::BaseColumn.
|
virtual |
Add this column and its data to the Sort object.
Sorting on records is not supported, so an exception is thrown.
Reimplemented from casacore::BaseColumn.
|
private |
Assignment cannot be used.
|
virtual |
Put the value in a particular cell.
The length of the buffer pointed to by dataPtr must match the actual length. This is checked by ScalarColumn.
Implements casacore::BaseColumn.
|
privatevirtual |
Write the column data.
The control information is written into the given AipsIO object, while the data is written/flushed by the data manager.
Implements casacore::PlainColumn.
|
private |
|
virtual |
Put the array of all values in the column.
The length of the buffer pointed to by dataPtr must match the actual length. This is checked by ScalarColumn.
Reimplemented from casacore::BaseColumn.
|
virtual |
Put the array of some values in the column (on behalf on RefColumn).
The length of the buffer pointed to by dataPtr must match the actual length. This is checked by ScalarColumn.
Reimplemented from casacore::BaseColumn.
|
private |
Pointer to column description.
Definition at line 181 of file ScaRecordColData.h.