casacore
Public Member Functions | Private Member Functions | List of all members

More...

#include <TSMIdColumn.h>

Public Member Functions

 TSMIdColumn (const TSMColumn &column)
 Create an id column from the given column. More...
 
virtual ~TSMIdColumn ()
 Frees up the storage. More...
 
virtual void getBool (rownr_t rownr, Bool *dataPtr)
 Get a scalar value in the given row. More...
 
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 putBool (rownr_t rownr, const Bool *dataPtr)
 Put a scalar value in the given row. More...
 
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)
 
- Public Member Functions inherited from casacore::TSMColumn
 TSMColumn (TiledStMan *stman, int dataType, const String &columnName)
 Create a column of the given type. More...
 
virtual ~TSMColumn ()
 Frees up the storage. More...
 
const StringcolumnName () const
 Get the name of the column. More...
 
virtual int dataType () const
 Return the data type of the column. More...
 
void setShapeColumn (const IPosition &shape)
 Set the fixed shape of the column. More...
 
const IPositionshapeColumn () const
 Get the fixed shape of the column. More...
 
TSMDataColumnmakeDataColumn ()
 Make a TSM data column object. More...
 
TSMCoordColumnmakeCoordColumn (uInt axesNumber)
 Make a TSM coordinate column object. More...
 
TSMIdColumnmakeIdColumn ()
 Make a TSM id column object. More...
 
TSMColumnunlink ()
 Unlink the underlying column. More...
 
- Public Member Functions inherited from casacore::StManColumnBase
 StManColumnBase (int dataType)
 Default constructor. More...
 
 ~StManColumnBase ()
 
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...
 
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 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 uInt ndim (rownr_t rownr)
 Get the dimensionality of the item in the given row. More...
 
virtual IPosition shape (rownr_t rownr)
 Get the shape 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...
 
ColumnCachecolumnCache ()
 Get access to the ColumnCache object. More...
 
const ColumnCachecolumnCachePtr () 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 getScalarColumnV (ArrayBase &dataPtr)
 Get all scalar values in the column. 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...
 
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 StringcolumnName () const
 Get rhe column name. More...
 

Private Member Functions

 TSMIdColumn (const TSMIdColumn &)
 Forbid copy constructor. More...
 
TSMIdColumnoperator= (const TSMIdColumn &)
 Forbid assignment. 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...
 
- Protected Member Functions inherited from casacore::TSMColumn
 TSMColumn (const TSMColumn &that)
 The copy constructor can only be used to copy a derived class. More...
 
- Protected Member Functions inherited from casacore::DataManagerColumn
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 getOther (rownr_t rownr, void *dataPtr)
 This function is the get for all non-standard data types. 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 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 inherited from casacore::TSMColumn
TiledStManstmanPtr_p
 The storage manager. More...
 
int dtype_p
 The data type of the data (as defined in DataType.h). More...
 
String name_p
 The name of the column. More...
 
IPosition columnShape_p
 The fixed shape of the column. More...
 
TSMColumncolPtr_p
 The specialized column object (i.e. More...
 

Detailed Description

An id column in Tiled Storage Manager.

Intended use:

Internal

Review Status

Reviewed By:
UNKNOWN
Date Reviewed:
before2004/08/25

Prerequisite

Etymology

TSMIdColumn handles an id column for a Tiled Storage Manager.

Synopsis

TSMIdColumn is used by TiledStMan to handle the access to a table column containing an id value of a tiled hypercube. Explicitly putting an id value is not possible. The only way to define the value is by specifying it when adding a hypercube in TiledDataStMan.

The id values are held in a TSMCube object. The row number determines which TSMCube object has to be accessed.

The creation of a TSMIdColumn object is done by a TSMColumn object. This process is described in more detail in the class TSMColumn.

Motivation

Handling coordinate columns in the Tiled Storage Manager is different from other columns.

Definition at line 90 of file TSMIdColumn.h.

Constructor & Destructor Documentation

◆ TSMIdColumn() [1/2]

casacore::TSMIdColumn::TSMIdColumn ( const TSMColumn column)

Create an id column from the given column.

◆ ~TSMIdColumn()

virtual casacore::TSMIdColumn::~TSMIdColumn ( )
virtual

Frees up the storage.

◆ TSMIdColumn() [2/2]

casacore::TSMIdColumn::TSMIdColumn ( const TSMIdColumn )
private

Forbid copy constructor.

Member Function Documentation

◆ getBool()

virtual void casacore::TSMIdColumn::getBool ( rownr_t  rownr,
Bool dataPtr 
)
virtual

Get a scalar value in the given row.

The buffer pointed to by dataPtr has to have the correct length (which is guaranteed by the ScalarColumn get function).

Reimplemented from casacore::DataManagerColumn.

◆ getComplex()

virtual void casacore::TSMIdColumn::getComplex ( rownr_t  rownr,
Complex *  dataPtr 
)
virtual

Reimplemented from casacore::DataManagerColumn.

◆ getDComplex()

virtual void casacore::TSMIdColumn::getDComplex ( rownr_t  rownr,
DComplex *  dataPtr 
)
virtual

Reimplemented from casacore::DataManagerColumn.

◆ getdouble()

virtual void casacore::TSMIdColumn::getdouble ( rownr_t  rownr,
double *  dataPtr 
)
virtual

Reimplemented from casacore::DataManagerColumn.

◆ getfloat()

virtual void casacore::TSMIdColumn::getfloat ( rownr_t  rownr,
float *  dataPtr 
)
virtual

Reimplemented from casacore::DataManagerColumn.

◆ getInt()

virtual void casacore::TSMIdColumn::getInt ( rownr_t  rownr,
Int dataPtr 
)
virtual

Reimplemented from casacore::DataManagerColumn.

◆ getInt64()

virtual void casacore::TSMIdColumn::getInt64 ( rownr_t  rownr,
Int64 dataPtr 
)
virtual

Reimplemented from casacore::DataManagerColumn.

◆ getString()

virtual void casacore::TSMIdColumn::getString ( rownr_t  rownr,
String dataPtr 
)
virtual

Reimplemented from casacore::DataManagerColumn.

◆ getuInt()

virtual void casacore::TSMIdColumn::getuInt ( rownr_t  rownr,
uInt dataPtr 
)
virtual

Reimplemented from casacore::DataManagerColumn.

◆ operator=()

TSMIdColumn& casacore::TSMIdColumn::operator= ( const TSMIdColumn )
private

Forbid assignment.

◆ putBool()

virtual void casacore::TSMIdColumn::putBool ( rownr_t  rownr,
const Bool dataPtr 
)
virtual

Put a scalar value in the given row.

The buffer pointed to by dataPtr has to have the correct length (which is guaranteed by the ScalarColumn get function). The value to be put must match the value which has already been inserted by the TiledStMan::addHypercube function. The put function is only there to be fully orthogonal.

Reimplemented from casacore::DataManagerColumn.

◆ putComplex()

virtual void casacore::TSMIdColumn::putComplex ( rownr_t  rownr,
const Complex *  dataPtr 
)
virtual

Reimplemented from casacore::DataManagerColumn.

◆ putDComplex()

virtual void casacore::TSMIdColumn::putDComplex ( rownr_t  rownr,
const DComplex *  dataPtr 
)
virtual

Reimplemented from casacore::DataManagerColumn.

◆ putdouble()

virtual void casacore::TSMIdColumn::putdouble ( rownr_t  rownr,
const double *  dataPtr 
)
virtual

Reimplemented from casacore::DataManagerColumn.

◆ putfloat()

virtual void casacore::TSMIdColumn::putfloat ( rownr_t  rownr,
const float *  dataPtr 
)
virtual

Reimplemented from casacore::DataManagerColumn.

◆ putInt()

virtual void casacore::TSMIdColumn::putInt ( rownr_t  rownr,
const Int dataPtr 
)
virtual

Reimplemented from casacore::DataManagerColumn.

◆ putInt64()

virtual void casacore::TSMIdColumn::putInt64 ( rownr_t  rownr,
const Int64 dataPtr 
)
virtual

Reimplemented from casacore::DataManagerColumn.

◆ putString()

virtual void casacore::TSMIdColumn::putString ( rownr_t  rownr,
const String dataPtr 
)
virtual

Reimplemented from casacore::DataManagerColumn.

◆ putuInt()

virtual void casacore::TSMIdColumn::putuInt ( rownr_t  rownr,
const uInt dataPtr 
)
virtual

Reimplemented from casacore::DataManagerColumn.


The documentation for this class was generated from the following file: