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

#include <StArrAipsIO.h>

Inheritance diagram for casacore::StManColumnArrayAipsIO:

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

virtual	~StManColumnArrayAipsIO ()
	Frees up the storage. 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 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 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	remove (rownr_t rownr)
	Remove the value in the given row. More...

virtual void	doCreate (rownr_t nrrow)
	Let the column create its arrays. 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...

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

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

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	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 String &	columnName () const
	Get rhe column name. More...

Private Member Functions
void	deleteArray (rownr_t index)
	Delete the array at the given index. More...

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

virtual void	getData (void *datap, uInt index, uInt nrval, AipsIO &, uInt version)
	Get data arrays into a data block at the given index. More...

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

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

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

IPosition	shape_p
	The shape of the array. More...

uInt	nrelem_p
	The nr of elements in the array. 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 direct table arrays.

Intended use:

Internal

Review Status

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

Prerequisite

Etymology

StManColumnArrayAipsIO handles the access to a direct array in a table column using the AipsIO storage manager.

Synopsis

StManColumnArrayAipsIO holds the direct arrays in memory and writes them into the AipsIO file when the table gets closed. It fully supports addition and removal of rows. When a row is added to the table, the direct array gets allocated. This is possible, because the shape of direct arrays is known.

The class is derived from StManColumnAipsIO which is used to hold a pointer to the array.

Motivation

StManColumnArrayAipsIO 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

Maybe TpArrayInt, etc. should be used instead of TpInt.
get/putSlice use too many array operations. To solve this requires an array constructor taking a pointer to the data (which is foreseen in the new Array classes).

Definition at line 89 of file StArrAipsIO.h.

Constructor & Destructor Documentation

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

Create a column of the given data type.

virtual casacore::StManColumnArrayAipsIO::~StManColumnArrayAipsIO ( )

virtual

Frees up the storage.

casacore::StManColumnArrayAipsIO::StManColumnArrayAipsIO ( const StManColumnArrayAipsIO & )

private

Forbid copy constructor.

Member Function Documentation

virtual void casacore::StManColumnArrayAipsIO::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.

void casacore::StManColumnArrayAipsIO::deleteArray ( rownr_t index )

private

Delete the array at the given index.

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

virtual

Let the column create its arrays.

Reimplemented from casacore::MSMColumn.

virtual void casacore::StManColumnArrayAipsIO::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.

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

privatevirtual

Get data arrays into a data block at the given index.

datap is an array of pointers to arrays. nrval arrays will be allocated and read starting at datap[index].

Reimplemented from casacore::StManColumnAipsIO.

virtual void casacore::StManColumnArrayAipsIO::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.

virtual uInt casacore::StManColumnArrayAipsIO::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.

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

private

Forbid assignment.

virtual void casacore::StManColumnArrayAipsIO::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.

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

privatevirtual

Put the data of a data block.

datap is an array of nrval pointers to arrays.

Reimplemented from casacore::StManColumnAipsIO.

virtual void casacore::StManColumnArrayAipsIO::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::StManColumnArrayAipsIO::remove ( rownr_t rownr )

virtual

Remove the value in the given row.

Reimplemented from casacore::MSMColumn.

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

virtual

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

Reimplemented from casacore::DataManagerColumn.

virtual IPosition casacore::StManColumnArrayAipsIO::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

uInt casacore::StManColumnArrayAipsIO::nrelem_p

private

The nr of elements in the array.

Definition at line 146 of file StArrAipsIO.h.

uInt casacore::StManColumnArrayAipsIO::seqnr_p

private

The (unique) sequence number of the column.

Definition at line 142 of file StArrAipsIO.h.

IPosition casacore::StManColumnArrayAipsIO::shape_p

private

The shape of the array.

Definition at line 144 of file StArrAipsIO.h.

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

tables/DataMan/StArrAipsIO.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Motivation

To Do

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation