AipsIO storage manager for indirect table arrays. More...

#include <StIndArrAIO.h>

Inheritance diagram for casacore::StManColumnIndArrayAipsIO:

Public Member Functions
	StManColumnIndArrayAipsIO (StManAipsIO *, int dataType)
	Create a column of the given type. More...

virtual	~StManColumnIndArrayAipsIO ()
	Frees up the storage and delete the StManArrayFile object. More...

virtual void	setShapeColumn (const IPosition &shape)
	Set the (fixed) shape of the arrays in the entire column. More...

virtual void	addRow (rownr_t newNrrow, rownr_t oldNrrow)
	Add (newNrrow-oldNrrow) rows to the column. More...

virtual void	setShape (rownr_t rownr, const IPosition &shape)
	Set the shape of the array in the given row and allocate the array in the file. More...

virtual Bool	isShapeDefined (rownr_t rownr)
	Is the shape defined (i.e. 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 array in the given row. More...

virtual Bool	canChangeShape () const
	This storage manager can handle changing array shapes for non-FixedShape columns. More...

virtual void	getArrayV (rownr_t rownr, ArrayBase &dataPtr)
	Get an array value in the given row. More...

virtual void	putArrayV (rownr_t rownr, const ArrayBase &dataPtr)
	Put an array value into the given row. More...

virtual void	getSliceV (rownr_t rownr, const Slicer &, ArrayBase &dataPtr)
	Get a section of the array in the given row. More...

virtual void	putSliceV (rownr_t rownr, const Slicer &, const ArrayBase &dataPtr)
	Put into a section of the array in the given row. More...

virtual void	remove (rownr_t rownr)
	Remove the value in the given row. More...

virtual void	doCreate (rownr_t nrrow)
	Let the column create its array file. More...

virtual void	putFile (rownr_t nrval, AipsIO &)
	Write the data into AipsIO. More...

virtual void	getFile (rownr_t nrval, AipsIO &)
	Read the data from AipsIO. More...

virtual void	reopenRW ()
	Reopen the storage manager files for read/write. More...

Bool	ok () const
	Check if the class invariants still hold. More...

Public Member Functions inherited from casacore::StManColumnAipsIO
	StManColumnAipsIO (StManAipsIO *stMan, int dataType, Bool byPtr)
	Create a column of the given type. More...

virtual	~StManColumnAipsIO ()
	Frees up the storage. 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...

void	resize (rownr_t nrval)
	Resize the data blocks. 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	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 IPosition	tileShape (rownr_t rownr)
	Get the tile shape of the item in the given row. 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	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	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...

Private Member Functions
void	openFile (ByteIO::OpenOption opt)
	Open the file with the given mode. More...

void	deleteArray (rownr_t rownr)
	Delete the array in the given row. More...

StIndArray *	getShape (rownr_t rownr)
	Read the shape at the given row. More...

void	putData (void *datap, uInt nrval, AipsIO &)
	Put the data of a data block. More...

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. More...

	StManColumnIndArrayAipsIO (const StManColumnIndArrayAipsIO &)
	Forbid copy constructor. More...

StManColumnIndArrayAipsIO &	operator= (const StManColumnIndArrayAipsIO &)
	Forbid assignment. More...

Private Attributes
StManAipsIO *	staioPtr_p
	The storage manager. More...

uInt	seqnr_p
	The (unique) sequence number of the column. More...

IPosition	fixedShape_p
	The shape of all arrays in case it is fixed. More...

Bool	shapeIsFixed_p
	Switch indicating if the shape is fixed. More...

uInt	version_p
	The version of the object retrieved from a file. More...

StManArrayFile *	iosfile_p
	The file containing the indirect arrays. 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::StManColumnAipsIO
virtual void	initData (void *datap, rownr_t nrval)
	initData does not do anything (only used in MSMColumn). 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)

Protected Attributes inherited from casacore::MSMColumn
MSMBase *	stmanPtr_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_t >	ncum_p
	The cumulative nr of rows in all extensions. More...

Detailed Description

AipsIO storage manager for indirect table arrays.

Intended use:

Internal

Review Status

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

Prerequisite

Etymology

StManColumnIndArrayAipsIO handles the access to an indirect array in a table column using the AipsIO storage manager.

Synopsis

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.

Definition at line 97 of file StIndArrAIO.h.

Constructor & Destructor Documentation

casacore::StManColumnIndArrayAipsIO::StManColumnIndArrayAipsIO	(	StManAipsIO *	,
		int	dataType
	)

Create a column of the given type.

The StManArrayFile object is not allocated here but by doCreate.

virtual casacore::StManColumnIndArrayAipsIO::~StManColumnIndArrayAipsIO ( )

virtual

Frees up the storage and delete the StManArrayFile object.

casacore::StManColumnIndArrayAipsIO::StManColumnIndArrayAipsIO ( const StManColumnIndArrayAipsIO & )

private

Forbid copy constructor.

Member Function Documentation

virtual void casacore::StManColumnIndArrayAipsIO::addRow	(	rownr_t	newNrrow,
		rownr_t	oldNrrow
	)

virtual

Add (newNrrow-oldNrrow) rows to the column.

Allocate the data arrays in these rows if the shape is fixed.

Reimplemented from casacore::MSMColumn.

virtual Bool casacore::StManColumnIndArrayAipsIO::canChangeShape ( ) const

virtual

This storage manager can handle changing array shapes for non-FixedShape columns.

Reimplemented from casacore::DataManagerColumn.

void casacore::StManColumnIndArrayAipsIO::deleteArray ( rownr_t rownr )

private

Delete the array in the given row.

virtual void casacore::StManColumnIndArrayAipsIO::doCreate ( rownr_t nrrow )

virtual

Let the column create its array file.

Reimplemented from casacore::MSMColumn.

virtual void casacore::StManColumnIndArrayAipsIO::getArrayV	(	rownr_t	rownr,
		ArrayBase &	dataPtr
	)

virtual

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).

Reimplemented from casacore::DataManagerColumn.

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

privatevirtual

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.

Reimplemented from casacore::StManColumnAipsIO.

virtual void casacore::StManColumnIndArrayAipsIO::getFile	(	rownr_t	nrval,
		AipsIO &
	)

virtual

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.

Reimplemented from casacore::StManColumnAipsIO.

StIndArray* casacore::StManColumnIndArrayAipsIO::getShape ( rownr_t rownr )

private

Read the shape at the given row.

This will cache the information in the StIndArray object for that row.

virtual void casacore::StManColumnIndArrayAipsIO::getSliceV	(	rownr_t	rownr,
		const Slicer &	,
		ArrayBase &	dataPtr
	)

virtual

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).

Reimplemented from casacore::DataManagerColumn.

virtual Bool casacore::StManColumnIndArrayAipsIO::isShapeDefined ( rownr_t rownr )

virtual

Is the shape defined (i.e.

is there an array) in this row?

Reimplemented from casacore::DataManagerColumn.

virtual uInt casacore::StManColumnIndArrayAipsIO::ndim ( rownr_t rownr )

virtual

Get the dimensionality of the item in the given row.

0 is returned if there is no array.

Reimplemented from casacore::DataManagerColumn.

Bool casacore::StManColumnIndArrayAipsIO::ok ( ) const

virtual

Check if the class invariants still hold.

Reimplemented from casacore::MSMColumn.

void casacore::StManColumnIndArrayAipsIO::openFile ( ByteIO::OpenOption opt )

private

Open the file with the given mode.

StManColumnIndArrayAipsIO& casacore::StManColumnIndArrayAipsIO::operator= ( const StManColumnIndArrayAipsIO & )

private

Forbid assignment.

virtual void casacore::StManColumnIndArrayAipsIO::putArrayV	(	rownr_t	rownr,
		const ArrayBase &	dataPtr
	)

virtual

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).

Reimplemented from casacore::DataManagerColumn.

void casacore::StManColumnIndArrayAipsIO::putData	(	void *	datap,
		uInt	nrval,
		AipsIO &
	)

privatevirtual

Put the data of a data block.

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

Reimplemented from casacore::StManColumnAipsIO.

virtual void casacore::StManColumnIndArrayAipsIO::putFile	(	rownr_t	nrval,
		AipsIO &
	)

virtual

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.

Reimplemented from casacore::StManColumnAipsIO.

virtual void casacore::StManColumnIndArrayAipsIO::putSliceV	(	rownr_t	rownr,
		const Slicer &	,
		const ArrayBase &	dataPtr
	)

virtual

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).

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::StManColumnIndArrayAipsIO::remove ( rownr_t rownr )

virtual

Remove the value in the given row.

This will result in lost file space.

Reimplemented from casacore::MSMColumn.

virtual void casacore::StManColumnIndArrayAipsIO::reopenRW ( )

virtual

Reopen the storage manager files for read/write.

Reimplemented from casacore::MSMColumn.

virtual void casacore::StManColumnIndArrayAipsIO::setShape	(	rownr_t	rownr,
		const IPosition &	shape
	)

virtual

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

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::StManColumnIndArrayAipsIO::setShapeColumn ( const IPosition & shape )

virtual

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

Reimplemented from casacore::DataManagerColumn.

virtual IPosition casacore::StManColumnIndArrayAipsIO::shape ( rownr_t rownr )

virtual

Get the shape of the array in the given row.

An zero-length IPosition is returned if there is no array.

Reimplemented from casacore::DataManagerColumn.

Member Data Documentation

IPosition casacore::StManColumnIndArrayAipsIO::fixedShape_p

private

The shape of all arrays in case it is fixed.

Definition at line 183 of file StIndArrAIO.h.

StManArrayFile* casacore::StManColumnIndArrayAipsIO::iosfile_p

private

The file containing the indirect arrays.

Definition at line 191 of file StIndArrAIO.h.

uInt casacore::StManColumnIndArrayAipsIO::seqnr_p

private

The (unique) sequence number of the column.

Definition at line 181 of file StIndArrAIO.h.

Bool casacore::StManColumnIndArrayAipsIO::shapeIsFixed_p

private

Switch indicating if the shape is fixed.

Definition at line 185 of file StIndArrAIO.h.

StManAipsIO* casacore::StManColumnIndArrayAipsIO::staioPtr_p

private

The storage manager.

Definition at line 179 of file StIndArrAIO.h.

uInt casacore::StManColumnIndArrayAipsIO::version_p

private

The version of the object retrieved from a file.

Versions < 2 use a StManArrayFile of their own. Newer versions share the one in StManAipsIO.

Definition at line 189 of file StIndArrAIO.h.

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

tables/DataMan/StIndArrAIO.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Motivation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation