casacore
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
casacore::StManColumnAipsIO Class Reference

More...

#include <StManAipsIO.h>

Public Member Functions

 StManColumnAipsIO (StManAipsIO *stMan, int dataType, Bool byPtr)
 Create a column of the given type. More...
 
virtual ~StManColumnAipsIO ()
 Frees up the storage. More...
 
virtual void putFile (rownr_t nrval, AipsIO &)
 Write the column data into AipsIO. More...
 
virtual void getFile (rownr_t nrval, AipsIO &)
 Read the column data from AipsIO. More...
 
- Public Member Functions inherited from casacore::MSMColumn
 MSMColumn (MSMBase *smptr, int dataType, Bool byPtr)
 Create a column of the given type. More...
 
virtual ~MSMColumn ()
 Frees up the storage. More...
 
virtual void getBool (rownr_t rownr, Bool *dataPtr)
 Get a 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 putBool (rownr_t rownr, const Bool *dataPtr)
 Put a 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 getScalarColumnV (ArrayBase &data)
 Get all scalar values in the column. More...
 
virtual void putScalarColumnV (const ArrayBase &data)
 Put all scalar values in the column. More...
 
virtual void addRow (rownr_t newNrrow, rownr_t oldNrrow)
 Add (newNrrow-oldNrrow) rows to the column. More...
 
void resize (rownr_t nrval)
 Resize the data blocks. More...
 
virtual void remove (rownr_t rownr)
 Remove the given row. More...
 
virtual void doCreate (rownr_t nrrow)
 Create the number of rows in a new table. More...
 
virtual void reopenRW ()
 Reopen the storage manager files for read/write. More...
 
virtual Bool ok () const
 Check if the class invariants still hold. 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...
 
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 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...
 

Protected Member Functions

virtual void initData (void *datap, rownr_t nrval)
 initData does not do anything (only used in MSMColumn). More...
 
virtual void putData (void *datap, uInt nrval, AipsIO &)
 Put the data (nrval elements) in an extension (starting at datap) into AipsIO. More...
 
virtual void getData (void *datap, uInt index, uInt nrval, AipsIO &, uInt version)
 Get data (nrval elements) into an extension (starting at datap plus the given index). More...
 
- Protected Member Functions inherited from casacore::MSMColumn
uInt findExt (rownr_t rownr, Bool setCache)
 Find the extension in which the row number is. More...
 
void * allocData (rownr_t nrval, Bool byPtr)
 Allocate an extension with the data type of the column. More...
 
void deleteAll ()
 Delete all extensions. More...
 
void deleteData (void *datap, Bool byPtr)
 Delete an extension. More...
 
void removeData (void *datap, rownr_t inx, rownr_t nrvalAfter)
 Remove an entry (i.e. More...
 
void * getArrayPtr (rownr_t rownr)
 Get the pointer for the given row. More...
 
void putArrayPtr (rownr_t rownr, void *dataPtr)
 Put the pointer for the given row. 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)
 

Private Member Functions

 StManColumnAipsIO (const StManColumnAipsIO &)
 Forbid copy constructor. More...
 
StManColumnAipsIOoperator= (const StManColumnAipsIO &)
 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 Attributes inherited from casacore::MSMColumn
MSMBasestmanPtr_p
 
Bool byPtr_p
 The data is indirectly accessed via a pointer (for the derived classes). More...
 
rownr_t nralloc_p
 The number of allocated rows in the column. More...
 
uInt nrext_p
 The nr of extensions in use. More...
 
Block< void * > data_p
 The assembly of all extensions (actually Block<T*>). More...
 
Block< rownr_tncum_p
 The cumulative nr of rows in all extensions. More...
 

Detailed Description

AipsIO table column storage manager class

Intended use:

Internal

Review Status

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

Prerequisite

Etymology

StManColumnAipsIO handles a column for an AipsIO storage manager.

Synopsis

StManColumnAipsIO is used by StManAipsIO to handle the access to the data in a table column. It is an storage manager based on AipsIO. The entire column is kept in memory and only written when the storage manager closes. When the storage manager gets opened, the entire column gets read back. It fully supports addition and removal of rows.

StManColumnAipsIO serves 2 purposes:

  1. It handles a column containing scalar values.
  2. It serves as a base class for StManArrayColumnAipsIO and StManIndArrayColumnAipsIO. These classes handle arrays and use StManColumnAipsIO to hold a pointer to the array in each row.

StManColumnAipsIO does not hold a column as a consecutive array, because extending the column (i.e. adding rows) proofed be too expensive due to the repeated copying involved when creating a table (this method was used by the old table system). Instead it has a number of data blocks (extensions) indexed to by a super block. Accessing a row means finding the appropriate extension via a binary search. Because there is only 1 extension when a table is read back, the overhead in finding a row is small.

Motivation

StManColumnAipsIO handles the standard data types. The class is not templated, but a switch statement is used instead. Templates would cause too many instantiations.

Definition at line 107 of file StManAipsIO.h.

Constructor & Destructor Documentation

◆ StManColumnAipsIO() [1/2]

casacore::StManColumnAipsIO::StManColumnAipsIO ( StManAipsIO stMan,
int  dataType,
Bool  byPtr 
)

Create a column of the given type.

It will maintain a pointer to its parent storage manager.

◆ ~StManColumnAipsIO()

virtual casacore::StManColumnAipsIO::~StManColumnAipsIO ( )
virtual

Frees up the storage.

◆ StManColumnAipsIO() [2/2]

casacore::StManColumnAipsIO::StManColumnAipsIO ( const StManColumnAipsIO )
private

Forbid copy constructor.

Member Function Documentation

◆ getData()

virtual void casacore::StManColumnAipsIO::getData ( void *  datap,
uInt  index,
uInt  nrval,
AipsIO ,
uInt  version 
)
protectedvirtual

Get data (nrval elements) into an extension (starting at datap plus the given index).

Reimplemented in casacore::StManColumnIndArrayAipsIO, and casacore::StManColumnArrayAipsIO.

◆ getFile()

virtual void casacore::StManColumnAipsIO::getFile ( rownr_t  nrval,
AipsIO  
)
virtual

Read the column data from AipsIO.

One extension gets allocated to hold all rows in the column.

Reimplemented from casacore::MSMColumn.

Reimplemented in casacore::StManColumnIndArrayAipsIO, and casacore::StManColumnArrayAipsIO.

◆ initData()

virtual void casacore::StManColumnAipsIO::initData ( void *  datap,
rownr_t  nrval 
)
protectedvirtual

initData does not do anything (only used in MSMColumn).

Reimplemented from casacore::MSMColumn.

◆ operator=()

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

Forbid assignment.

◆ putData()

virtual void casacore::StManColumnAipsIO::putData ( void *  datap,
uInt  nrval,
AipsIO  
)
protectedvirtual

Put the data (nrval elements) in an extension (starting at datap) into AipsIO.

Reimplemented in casacore::StManColumnIndArrayAipsIO, and casacore::StManColumnArrayAipsIO.

◆ putFile()

virtual void casacore::StManColumnAipsIO::putFile ( rownr_t  nrval,
AipsIO  
)
virtual

Write the column data into AipsIO.

It will successively write all extensions using putData.

Reimplemented from casacore::MSMColumn.

Reimplemented in casacore::StManColumnIndArrayAipsIO, and casacore::StManColumnArrayAipsIO.


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