casacore
|
A Column in the Standard Storage Manager. More...
#include <SSMColumn.h>
Public Member Functions | |
SSMColumn (SSMBase *aParent, int aDataType, uInt aColNr) | |
Create a SSMColumn object with the given parent. More... | |
virtual | ~SSMColumn () |
virtual void | setShapeColumn (const IPosition &aShape) |
Set the shape of an array in the column. More... | |
virtual void | setMaxLength (uInt maxLength) |
Set the maximum length of a 'fixed length' string. More... | |
virtual uInt | ndim (rownr_t aRowNr) |
Get the dimensionality of the item in the given row. More... | |
virtual IPosition | shape (rownr_t aRowNr) |
Get the shape of the array in the given row. More... | |
virtual void | doCreate (rownr_t aNrRows) |
Let the object initialize itself for a newly created table. More... | |
virtual void | getFile (rownr_t aNrRows) |
Let the column object initialize itself for an existing table. More... | |
void | resync (rownr_t aNrRow) |
Resync the storage manager with the new file contents. More... | |
virtual void | getBool (rownr_t aRowNr, Bool *aDataPtr) |
Get the scalar value in the given row. More... | |
virtual void | getuChar (rownr_t aRowNr, uChar *aDataPtr) |
virtual void | getShort (rownr_t aRowNr, Short *aDataPtr) |
virtual void | getuShort (rownr_t aRowNr, uShort *aDataPtr) |
virtual void | getInt (rownr_t aRowNr, Int *aDataPtr) |
virtual void | getuInt (rownr_t aRowNr, uInt *aDataPtr) |
virtual void | getInt64 (rownr_t aRowNr, Int64 *aDataPtr) |
virtual void | getfloat (rownr_t aRowNr, float *aDataPtr) |
virtual void | getdouble (rownr_t aRowNr, double *aDataPtr) |
virtual void | getComplex (rownr_t aRowNr, Complex *aDataPtr) |
virtual void | getDComplex (rownr_t aRowNr, DComplex *aDataPtr) |
virtual void | getString (rownr_t aRowNr, String *aDataPtr) |
virtual void | putBool (rownr_t aRowNr, const Bool *aDataPtr) |
Put the scalar value in the given row. More... | |
virtual void | putuChar (rownr_t aRowNr, const uChar *aDataPtr) |
virtual void | putShort (rownr_t aRowNr, const Short *aDataPtr) |
virtual void | putuShort (rownr_t aRowNr, const uShort *aDataPtr) |
virtual void | putInt (rownr_t aRowNr, const Int *aDataPtr) |
virtual void | putuInt (rownr_t aRowNr, const uInt *aDataPtr) |
virtual void | putInt64 (rownr_t aRowNr, const Int64 *aDataPtr) |
virtual void | putfloat (rownr_t aRowNr, const float *aDataPtr) |
virtual void | putdouble (rownr_t aRowNr, const double *aDataPtr) |
virtual void | putComplex (rownr_t aRowNr, const Complex *aDataPtr) |
virtual void | putDComplex (rownr_t aRowNr, const DComplex *aDataPtr) |
virtual void | putString (rownr_t aRowNr, const String *aDataPtr) |
virtual void | getScalarColumnV (ArrayBase &aDataPtr) |
Get the scalar values of the entire column. More... | |
virtual void | putScalarColumnV (const ArrayBase &aDataPtr) |
Put the scalar values of the entire column. More... | |
virtual void | addRow (rownr_t aNewNrRows, rownr_t anOldNrRows, Bool doInit) |
Add (NewNrRows-OldNrRows) rows to the Column and initialize the new rows when needed. More... | |
virtual void | deleteRow (rownr_t aRowNr) |
Remove the given row from the data bucket and possibly string bucket. More... | |
uInt | getExternalSizeBytes () const |
Get the size of the dataType in bytes!! More... | |
uInt | getExternalSizeBits () const |
Get the size of the dataType in bits!! More... | |
uInt | getColNr () |
get the sequence number of this column. More... | |
void | setColNr (uInt aColNr) |
set the sequence number of this column. More... | |
void | removeColumn () |
If something special has to be done before removing the Column, as is the case with Strings, it can be done here. More... | |
Public Member Functions inherited from casacore::StManColumnBase | |
StManColumnBase (int dataType) | |
Default constructor. More... | |
~StManColumnBase () | |
virtual int | dataType () const |
Return the data type of the column. More... | |
DataType | dtype () const |
Int | elemSize () const |
Return the size of an element of the column's data type. 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 String | dataTypeId () const |
Get the data type id of the column for dataType==TpOther. More... | |
virtual Bool | isWritable () const |
Test if data can be put into this column. More... | |
void | setFixedShapeColumn (const IPosition &shape) |
Set the shape of all (fixed-shaped) arrays in the column. More... | |
virtual void | setShape (rownr_t rownr, const IPosition &shape) |
Set the shape of an (variable-shaped) array in the given row. 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 Bool | isShapeDefined (rownr_t rownr) |
Is the value shape defined in the given row? By default it returns True. 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... | |
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... | |
virtual void | getArrayV (rownr_t rownr, ArrayBase &dataPtr) |
Get the array value in the given row. More... | |
virtual void | putArrayV (rownr_t rownr, const ArrayBase &data) |
Put the array value into the given row. More... | |
virtual void | getArrayColumnV (ArrayBase &data) |
Get all array values in the column. More... | |
virtual void | putArrayColumnV (const ArrayBase &data) |
Put all array values in the column. More... | |
virtual void | getArrayColumnCellsV (const RefRows &rownrs, ArrayBase &data) |
Get some array values in the column. More... | |
virtual void | putArrayColumnCellsV (const RefRows &rownrs, const ArrayBase &data) |
Put some array values in the column. More... | |
virtual void | getSliceV (rownr_t rownr, const Slicer &slicer, ArrayBase &data) |
Get a section of the array in the given row. More... | |
virtual void | putSliceV (rownr_t rownr, const Slicer &slicer, const ArrayBase &data) |
Put into a section of the array in the given row. More... | |
virtual void | getColumnSliceV (const Slicer &slicer, ArrayBase &data) |
Get a section of all arrays in the column. More... | |
virtual void | putColumnSliceV (const Slicer &slicer, const ArrayBase &data) |
Put into a section of all arrays in the column. More... | |
virtual void | getColumnSliceCellsV (const RefRows &rownrs, const Slicer &slicer, ArrayBase &data) |
Get a section of some arrays in the column. More... | |
virtual void | putColumnSliceCellsV (const RefRows &rownrs, const Slicer &slicer, const ArrayBase &data) |
Put into a section of some arrays in the column. 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 | shiftRows (char *aValue, rownr_t rowNr, rownr_t startRow, rownr_t endRow) |
Shift the rows in the bucket one to the left when removing the given row. More... | |
void | getValue (rownr_t aRowNr) |
Fill the cache with data of the bucket containing the given row. More... | |
Char * | getRowValue (Int *data, rownr_t aRowNr) |
Get the bucketnr, offset, and length of a variable length string. More... | |
void | putValue (rownr_t aRowNr, const void *aValue) |
Put the given value for the row into the correct data bucket. More... | |
void | putValueShortString (rownr_t aRowNr, const void *aValue, const String &string) |
Put the given string for the row into the correct data bucket. More... | |
void | getColumnValue (void *anArray, rownr_t aNrRows) |
Get the values for the entire column. More... | |
void | putColumnValue (const void *anArray, rownr_t aNrRows) |
Put the values from the array in the entire column. More... | |
Protected Member Functions inherited from casacore::DataManagerColumn | |
virtual void | getOther (rownr_t rownr, void *dataPtr) |
This function is the get for all non-standard data types. More... | |
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) |
Protected Attributes | |
SSMBase * | itsSSMPtr |
Pointer to the parent storage manager. More... | |
uInt | itsExternalSizeBytes |
Length of column cell value in storage format (0 = variable length). More... | |
uInt | itsExternalSizeBits |
uInt | itsColNr |
Column sequence number of this column. More... | |
IPosition | itsShape |
The shape of the column. More... | |
uInt | itsMaxLen |
The maximum length of a 'fixed length' string. More... | |
uInt | itsNrElem |
Number of elements in a value for this column. More... | |
uInt | itsNrCopy |
Number of values to be copied. More... | |
uInt | itsLocalSize |
The sizeof the datatype in local format. More... | |
void * | itsData |
The data in local format. More... | |
Conversion::ValueFunction * | itsWriteFunc |
Pointer to a convert function for writing. More... | |
Conversion::ValueFunction * | itsReadFunc |
Pointer to a convert function for reading. More... | |
Private Member Functions | |
SSMColumn (const SSMColumn &) | |
Forbid copy constructor. More... | |
SSMColumn & | operator= (const SSMColumn &) |
Forbid assignment. More... | |
void | init () |
Initialize part of the object. More... | |
char * | getDataPtr () |
Get the pointer to the cache. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from casacore::StManColumnBase | |
static Bool | isNativeDataType (int dtype) |
Test if the given data type is supported by storage managers. More... | |
A Column in the Standard Storage Manager.
Internal
SSMColumn represents a Column in the Standard Storage Manager.
SSMColumn is the base class for access to a column stored with the Standard Storage manager. It provides some basic functionality for the derived classes handling direct and indirect arrays.
The main task of SSMColumn is handling the access to a column containing scalars of the various data types. The data is stored in buckets. The classes SSMBase and SSMIndex keep track in which data bucket a given row is stored and at which offset the column starts. Using that information SSMColumn can access its data easily.
Almost all data types have a fixed length and can be handled easily. However, strings are a special case.
If the string is fixed length (which means it has a maximum length), the string is stored directly in the data bucket. If the string is shorter than the maximum length, its length is indicated by a trailing 0.
Variable strings are in principle stored in a special string bucket. The data bucket contains 3 integers telling the bucketnr, offset, and length of the string. However, it the string is short enough (ie. <= 8 characters), the string is stored directly in data bucket using the space for bucketnr and offset.
The class maintains a cache of the data in the bucket last read. This cache is used by the higher level table classes to get faster read access to the data. The cache is not used for strings, because they are stored differently.
Definition at line 99 of file SSMColumn.h.
Create a SSMColumn object with the given parent.
It initializes the various variables. It keeps the pointer to its parent (but does not own it).
|
virtual |
|
private |
Forbid copy constructor.
|
virtual |
Add (NewNrRows-OldNrRows) rows to the Column and initialize the new rows when needed.
Reimplemented in casacore::SSMIndColumn.
|
virtual |
Remove the given row from the data bucket and possibly string bucket.
If needed, it also removes it from the cache.
Reimplemented in casacore::SSMIndColumn, and casacore::SSMDirColumn.
|
virtual |
Let the object initialize itself for a newly created table.
It is meant for a derived class.
Reimplemented in casacore::SSMIndColumn.
Get the scalar value in the given row.
Reimplemented from casacore::DataManagerColumn.
|
inline |
get the sequence number of this column.
Definition at line 292 of file SSMColumn.h.
References itsColNr.
|
protected |
Get the values for the entire column.
The data from all buckets is copied to the array.
|
virtual |
Reimplemented from casacore::DataManagerColumn.
|
inlineprivate |
Get the pointer to the cache.
It is created if not done yet.
Definition at line 284 of file SSMColumn.h.
References casacore::SSMBase::getRowsPerBucket(), itsColNr, itsData, itsLocalSize, and itsSSMPtr.
|
virtual |
Reimplemented from casacore::DataManagerColumn.
|
virtual |
Reimplemented from casacore::DataManagerColumn.
|
inline |
Get the size of the dataType in bits!!
Definition at line 279 of file SSMColumn.h.
References itsExternalSizeBits.
|
inline |
Get the size of the dataType in bytes!!
Definition at line 274 of file SSMColumn.h.
References itsExternalSizeBytes.
|
virtual |
Let the column object initialize itself for an existing table.
Reimplemented in casacore::SSMIndColumn.
|
virtual |
Reimplemented from casacore::DataManagerColumn.
Reimplemented from casacore::DataManagerColumn.
Reimplemented from casacore::DataManagerColumn.
Get the bucketnr, offset, and length of a variable length string.
data
must have 3 Ints to hold the values. It returns a pointer to the data in the bucket, which can be used for the case that the data bucket contains the (short) string.
|
virtual |
Get the scalar values of the entire column.
Reimplemented from casacore::DataManagerColumn.
Reimplemented from casacore::DataManagerColumn.
Reimplemented from casacore::DataManagerColumn.
Reimplemented from casacore::DataManagerColumn.
Reimplemented from casacore::DataManagerColumn.
Reimplemented from casacore::DataManagerColumn.
|
protected |
Fill the cache with data of the bucket containing the given row.
|
private |
Initialize part of the object.
It determines the nr of elements, the function to use to convert from local to file format, etc..
Get the dimensionality of the item in the given row.
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::SSMIndStringColumn, and casacore::SSMIndColumn.
Put the scalar value in the given row.
It updates the cache if the row is contained in the cache.
Reimplemented from casacore::DataManagerColumn.
|
protected |
Put the values from the array in the entire column.
Each data bucket is filled with the the appropriate part of the array.
|
virtual |
Reimplemented from casacore::DataManagerColumn.
|
virtual |
Reimplemented from casacore::DataManagerColumn.
|
virtual |
Reimplemented from casacore::DataManagerColumn.
|
virtual |
Reimplemented from casacore::DataManagerColumn.
Reimplemented from casacore::DataManagerColumn.
Reimplemented from casacore::DataManagerColumn.
|
virtual |
Put the scalar values of the entire column.
It invalidates the cache.
Reimplemented from casacore::DataManagerColumn.
Reimplemented from casacore::DataManagerColumn.
Reimplemented from casacore::DataManagerColumn.
Reimplemented from casacore::DataManagerColumn.
Reimplemented from casacore::DataManagerColumn.
Reimplemented from casacore::DataManagerColumn.
|
protected |
Put the given value for the row into the correct data bucket.
|
protected |
Put the given string for the row into the correct data bucket.
The argument aValue>
must be 3 Ints (for bucketnr, offset, and length). Only the length is actually used.
void casacore::SSMColumn::removeColumn | ( | ) |
If something special has to be done before removing the Column, as is the case with Strings, it can be done here.
void casacore::SSMColumn::resync | ( | rownr_t | aNrRow | ) |
Resync the storage manager with the new file contents.
It resets the last rownr put.
|
inline |
set the sequence number of this column.
Definition at line 297 of file SSMColumn.h.
References itsColNr.
|
virtual |
Set the maximum length of a 'fixed length' string.
It is only called (right after the constructor) if the string has a fixed length.
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::SSMIndColumn, and casacore::SSMDirColumn.
|
virtual |
Set the shape of an array in the column.
It is only called (right after the constructor) if the array has a fixed shape.
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::SSMIndColumn.
Get the shape of the array in the given row.
Reimplemented from casacore::DataManagerColumn.
Reimplemented in casacore::SSMIndColumn, and casacore::SSMIndStringColumn.
|
protected |
Shift the rows in the bucket one to the left when removing the given row.
|
protected |
Column sequence number of this column.
Definition at line 237 of file SSMColumn.h.
Referenced by getColNr(), getDataPtr(), and setColNr().
|
protected |
|
protected |
Definition at line 235 of file SSMColumn.h.
Referenced by getExternalSizeBits().
|
protected |
Length of column cell value in storage format (0 = variable length).
Definition at line 234 of file SSMColumn.h.
Referenced by getExternalSizeBytes().
|
protected |
The sizeof the datatype in local format.
Definition at line 249 of file SSMColumn.h.
Referenced by getDataPtr().
|
protected |
The maximum length of a 'fixed length' string.
Definition at line 241 of file SSMColumn.h.
|
protected |
Number of values to be copied.
Normally this is itsNrElem, but for complex types it is 2*itsNrElem. When local format is used, it is the number of bytes.
Definition at line 247 of file SSMColumn.h.
|
protected |
Number of elements in a value for this column.
Definition at line 243 of file SSMColumn.h.
|
protected |
Pointer to a convert function for reading.
Definition at line 255 of file SSMColumn.h.
|
protected |
The shape of the column.
Definition at line 239 of file SSMColumn.h.
|
protected |
Pointer to the parent storage manager.
Definition at line 232 of file SSMColumn.h.
Referenced by getDataPtr().
|
protected |
Pointer to a convert function for writing.
Definition at line 253 of file SSMColumn.h.