MSMIndColumn.h

Classes

MSMIndColumn -- Mmeory storage manager for variable shaped table arrays (full description)

class MSMIndColumn : public MSMColumn

Interface

Public Members
MSMIndColumn (MSMBase*, int dataType)
~MSMIndColumn()
Bool canAccessSlice (Bool& reask) const
void setShapeColumn (const IPosition& shape)
const IPosition& columnShape() const
void setShape (uInt rownr, const IPosition& shape)
Bool isShapeDefined (uInt rownr)
uInt ndim (uInt rownr)
IPosition shape (uInt rownr)
Bool canChangeShape() const
void getArrayBoolV (uInt rownr, Array<Bool>* dataPtr)
void getArrayuCharV (uInt rownr, Array<uChar>* dataPtr)
void getArrayShortV (uInt rownr, Array<Short>* dataPtr)
void getArrayuShortV (uInt rownr, Array<uShort>* dataPtr)
void getArrayIntV (uInt rownr, Array<Int>* dataPtr)
void getArrayuIntV (uInt rownr, Array<uInt>* dataPtr)
void getArrayfloatV (uInt rownr, Array<float>* dataPtr)
void getArraydoubleV (uInt rownr, Array<double>* dataPtr)
void getArrayComplexV (uInt rownr, Array<Complex>* dataPtr)
void getArrayDComplexV (uInt rownr, Array<DComplex>* dataPtr)
void getArrayStringV (uInt rownr, Array<String>* dataPtr)
void putArrayBoolV (uInt rownr, const Array<Bool>* dataPtr)
void putArrayuCharV (uInt rownr, const Array<uChar>* dataPtr)
void putArrayShortV (uInt rownr, const Array<Short>* dataPtr)
void putArrayuShortV (uInt rownr, const Array<uShort>* dataPtr)
void putArrayIntV (uInt rownr, const Array<Int>* dataPtr)
void putArrayuIntV (uInt rownr, const Array<uInt>* dataPtr)
void putArrayfloatV (uInt rownr, const Array<float>* dataPtr)
void putArraydoubleV (uInt rownr, const Array<double>* dataPtr)
void putArrayComplexV (uInt rownr, const Array<Complex>* dataPtr)
void putArrayDComplexV (uInt rownr, const Array<DComplex>* dataPtr)
void putArrayStringV (uInt rownr, const Array<String>* dataPtr)
void getSliceBoolV (uInt rownr, const Slicer&, Array<Bool>* dataPtr)
void getSliceuCharV (uInt rownr, const Slicer&, Array<uChar>* dataPtr)
void getSliceShortV (uInt rownr, const Slicer&, Array<Short>* dataPtr)
void getSliceuShortV (uInt rownr, const Slicer&, Array<uShort>* dataPtr)
void getSliceIntV (uInt rownr, const Slicer&, Array<Int>* dataPtr)
void getSliceuIntV (uInt rownr, const Slicer&, Array<uInt>* dataPtr)
void getSlicefloatV (uInt rownr, const Slicer&, Array<float>* dataPtr)
void getSlicedoubleV (uInt rownr, const Slicer&, Array<double>* dataPtr)
void getSliceComplexV (uInt rownr, const Slicer&, Array<Complex>* dataPtr)
void getSliceDComplexV (uInt rownr, const Slicer&, Array<DComplex>* dataPtr)
void getSliceStringV (uInt rownr, const Slicer&, Array<String>* dataPtr)
void putSliceBoolV (uInt rownr, const Slicer&, const Array<Bool>* dataPtr)
void putSliceuCharV (uInt rownr, const Slicer&, const Array<uChar>* dataPtr)
void putSliceShortV (uInt rownr, const Slicer&, const Array<Short>* dataPtr)
void putSliceuShortV (uInt rownr, const Slicer&, const Array<uShort>* dataPtr)
void putSliceIntV (uInt rownr, const Slicer&, const Array<Int>* dataPtr)
void putSliceuIntV (uInt rownr, const Slicer&, const Array<uInt>* dataPtr)
void putSlicefloatV (uInt rownr, const Slicer&, const Array<float>* dataPtr)
void putSlicedoubleV (uInt rownr, const Slicer&, const Array<double>* dataPtr)
void putSliceComplexV (uInt rownr, const Slicer&, const Array<Complex>* dataPtr)
void putSliceDComplexV (uInt rownr, const Slicer&, const Array<DComplex>* dataPtr)
void putSliceStringV (uInt rownr, const Slicer&, const Array<String>* dataPtr)
void remove (uInt rownr)
Private Members
void deleteArray (uInt rownr)
Data* getShape (uInt rownr)
void* getDataPtr (uInt rownr)
MSMIndColumn (const MSMIndColumn&)
MSMIndColumn& operator= (const MSMIndColumn&)

Description

Review Status

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

Prerequisite

Synopsis

StManColumnArrayAipsIO handles indirect arrays in a table column.

An array (or section of an array) is only read when needed. It, however, caches the array shape using the helper class StIndArray. Pointers to these objects are maintained using the standard StManColumnAipsIO facilities. When the column gets written, the offsets in the StManArrayFile file get written. Those will be read back when the column is read in.

When a row gets deleted or when the array gets bigger, the file space is lost. This storage manager is a simple one and no attempts are done to make it smart.

Member Description

MSMIndColumn (MSMBase*, int dataType)

Create a column of the given type.

~MSMIndColumn()

Frees up the storage.

Bool canAccessSlice (Bool& reask) const

It can handle access to a slice in a cell.

void setShapeColumn (const IPosition& shape)

Set the (fixed) shape of the arrays in the entire column.

const IPosition& columnShape() const

Get the column shape.

void setShape (uInt rownr, const IPosition& shape)

Set the shape of the array in the given row and allocate the array in the file.

Bool isShapeDefined (uInt rownr)

Is the shape defined (i.e. is there an array) in this row?

uInt ndim (uInt rownr)

Get the dimensionality of the item in the given row. 0 is returned if there is no array.

IPosition shape (uInt rownr)

Get the shape of the array in the given row. An zero-length IPosition is returned if there is no array.

Bool canChangeShape() const

This storage manager can handle changing array shapes.

void getArrayBoolV (uInt rownr, Array<Bool>* dataPtr)
void getArrayuCharV (uInt rownr, Array<uChar>* dataPtr)
void getArrayShortV (uInt rownr, Array<Short>* dataPtr)
void getArrayuShortV (uInt rownr, Array<uShort>* dataPtr)
void getArrayIntV (uInt rownr, Array<Int>* dataPtr)
void getArrayuIntV (uInt rownr, Array<uInt>* dataPtr)
void getArrayfloatV (uInt rownr, Array<float>* dataPtr)
void getArraydoubleV (uInt rownr, Array<double>* dataPtr)
void getArrayComplexV (uInt rownr, Array<Complex>* dataPtr)
void getArrayDComplexV (uInt rownr, Array<DComplex>* dataPtr)
void getArrayStringV (uInt rownr, Array<String>* dataPtr)

Get an array value in the given row. The buffer pointed to by dataPtr has to have the correct length (which is guaranteed by the ArrayColumn get function).

void putArrayBoolV (uInt rownr, const Array<Bool>* dataPtr)
void putArrayuCharV (uInt rownr, const Array<uChar>* dataPtr)
void putArrayShortV (uInt rownr, const Array<Short>* dataPtr)
void putArrayuShortV (uInt rownr, const Array<uShort>* dataPtr)
void putArrayIntV (uInt rownr, const Array<Int>* dataPtr)
void putArrayuIntV (uInt rownr, const Array<uInt>* dataPtr)
void putArrayfloatV (uInt rownr, const Array<float>* dataPtr)
void putArraydoubleV (uInt rownr, const Array<double>* dataPtr)
void putArrayComplexV (uInt rownr, const Array<Complex>* dataPtr)
void putArrayDComplexV (uInt rownr, const Array<DComplex>* dataPtr)
void putArrayStringV (uInt rownr, const Array<String>* dataPtr)

Put an array value into the given row. The buffer pointed to by dataPtr has to have the correct length (which is guaranteed by the ArrayColumn put function).

void getSliceBoolV (uInt rownr, const Slicer&, Array<Bool>* dataPtr)
void getSliceuCharV (uInt rownr, const Slicer&, Array<uChar>* dataPtr)
void getSliceShortV (uInt rownr, const Slicer&, Array<Short>* dataPtr)
void getSliceuShortV (uInt rownr, const Slicer&, Array<uShort>* dataPtr)
void getSliceIntV (uInt rownr, const Slicer&, Array<Int>* dataPtr)
void getSliceuIntV (uInt rownr, const Slicer&, Array<uInt>* dataPtr)
void getSlicefloatV (uInt rownr, const Slicer&, Array<float>* dataPtr)
void getSlicedoubleV (uInt rownr, const Slicer&, Array<double>* dataPtr)
void getSliceComplexV (uInt rownr, const Slicer&, Array<Complex>* dataPtr)
void getSliceDComplexV (uInt rownr, const Slicer&, Array<DComplex>* dataPtr)
void getSliceStringV (uInt rownr, const Slicer&, Array<String>* dataPtr)

Get a section of the array in the given row. The buffer pointed to by dataPtr has to have the correct length (which is guaranteed by the ArrayColumn getSlice function).

void putSliceBoolV (uInt rownr, const Slicer&, const Array<Bool>* dataPtr)
void putSliceuCharV (uInt rownr, const Slicer&, const Array<uChar>* dataPtr)
void putSliceShortV (uInt rownr, const Slicer&, const Array<Short>* dataPtr)
void putSliceuShortV (uInt rownr, const Slicer&, const Array<uShort>* dataPtr)
void putSliceIntV (uInt rownr, const Slicer&, const Array<Int>* dataPtr)
void putSliceuIntV (uInt rownr, const Slicer&, const Array<uInt>* dataPtr)
void putSlicefloatV (uInt rownr, const Slicer&, const Array<float>* dataPtr)
void putSlicedoubleV (uInt rownr, const Slicer&, const Array<double>* dataPtr)
void putSliceComplexV (uInt rownr, const Slicer&, const Array<Complex>* dataPtr)
void putSliceDComplexV (uInt rownr, const Slicer&, const Array<DComplex>* dataPtr)
void putSliceStringV (uInt rownr, const Slicer&, const Array<String>* dataPtr)

Put into a section of the array in the given row. The buffer pointed to by dataPtr has to have the correct length (which is guaranteed by the ArrayColumn putSlice function).

void remove (uInt rownr)

Remove the value in the given row. This will result in lost file space.

void deleteArray (uInt rownr)

Delete the array in the given row.

Data* getShape (uInt rownr)

Read the shape at the given row. It throws an exception if undefined.

void* getDataPtr (uInt rownr)

Get a pointer to the data array.

MSMIndColumn (const MSMIndColumn&)

Forbid copy constructor.

MSMIndColumn& operator= (const MSMIndColumn&)

Forbid assignment.