StIndArrAIO.h

StManColumnArrayAipsIO handles indirect arrays in a table column. An StManArrayFile object is used to read and write the arrays from/into a file in a simple way. So this column has a file of its own to store the actual data in. It uses the (unique) column sequence number to make the file name unique.

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.

Motivation

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

To Do

Member Description

StManColumnIndArrayAipsIO (StManAipsIO*, int dataType)

Create a column of the given type. The StManArrayFile object is not allocated here but by doCreate.

~StManColumnIndArrayAipsIO()

Frees up the storage and delete the StManArrayFile object.

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.

void addRow (uInt newNrrow, uInt oldNrrow)

Add (newNrrow-oldNrrow) rows to the column. Allocate the data arrays in these rows if the shape is fixed.

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 for non-FixedShape columns.

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 doCreate (uInt nrrow)

Let the column create its array file.

void putFile (uInt nrval, AipsIO&)

Write the data into AipsIO. This will call StManColumnAipsIO::putFile which will in its turn call putData in this class for each of its chunks of data.

void getFile (uInt nrval, AipsIO&)

Read the data from AipsIO. This will call StManColumnAipsIO::getFile which will in its turn call getData in this class for each of its chunks of data.

virtual void reopenRW()

Reopen the storage manager files for read/write.

Bool ok() const

Check if the class invariants still hold.

void openFile (ByteIO::OpenOption opt)

Open the file with the given mode.

void deleteArray (uInt rownr)

Delete the array in the given row.

StIndArray* getShape (uInt rownr)

Read the shape at the given row. This will cache the information in the StIndArray object for that row.

void putData (void* datap, uInt nrval, AipsIO&)

Put the data of a data block. datap is an array of nrval pointers to StIndArray. Only the file offsets get written.

void getData (void* datap, uInt index, uInt nrval, AipsIO&, uInt version)

Get file offsets to the arrays into a data block at the given index. datap is an array of pointers to StIndArray. nrval blocks will be allocated and read starting at datap[index]. The actual shape and array data will be read when needed.

StManColumnIndArrayAipsIO (const StManColumnIndArrayAipsIO&)

Forbid copy constructor.

StManColumnIndArrayAipsIO& operator= (const StManColumnIndArrayAipsIO&)

Forbid assignment.