casacore::StManColumnIndArrayAipsIO Class Reference

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.
	~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.
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.
uInt	ndim (uInt rownr)
	Get the dimensionality of the item in the given row.
IPosition	shape (uInt rownr)
	Get the shape of the array in the given row.
Bool	canChangeShape () const
	This storage manager can handle changing array shapes for non-FixedShape columns.
void	getArrayBoolV (uInt rownr, Array< Bool > *dataPtr)
	Get an array value in the given row.
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)
	Put an array value into the given row.
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)
	Get a section of the array in the given row.
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)
	Put into a section of the array in the given row.
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)
	Remove the value in the given row.
void	doCreate (uInt nrrow)
	Let the column create its array file.
void	putFile (uInt nrval, AipsIO &)
	Write the data into AipsIO.
void	getFile (uInt nrval, AipsIO &)
	Read the data from AipsIO.
virtual void	reopenRW ()
	Reopen the storage manager files for read/write.
Bool	ok () const
	Check if the class invariants still hold.
Private Member Functions
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.
void	putData (void *datap, uInt nrval, AipsIO &)
	Put the data of a data block.
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.
	StManColumnIndArrayAipsIO (const StManColumnIndArrayAipsIO &)
	Forbid copy constructor.
StManColumnIndArrayAipsIO &	operator= (const StManColumnIndArrayAipsIO &)
	Forbid assignment.
Private Attributes
uInt	seqnr_p
	The (unique) sequence number of the column.
IPosition	fixedShape_p
	The shape of all arrays in case it is fixed.
Bool	shapeIsFixed_p
	Switch indicating if the shape is fixed.
uInt	version_p
	The version of the object retrieved from a file.
StManArrayFile *	iosfile_p
	The file containing the indirect arrays.

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.

casacore::StManColumnIndArrayAipsIO::~StManColumnIndArrayAipsIO ( )

Frees up the storage and delete the StManArrayFile object.

casacore::StManColumnIndArrayAipsIO::StManColumnIndArrayAipsIO ( const StManColumnIndArrayAipsIO & ) [private]

Forbid copy constructor.

Member Function Documentation

void casacore::StManColumnIndArrayAipsIO::addRow	(	uInt	newNrrow,
		uInt	oldNrrow
	)			`[virtual]`

Add (newNrrow-oldNrrow) rows to the column.

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

Reimplemented from casacore::StManColumnAipsIO.

Bool casacore::StManColumnIndArrayAipsIO::canAccessSlice ( Bool & reask ) const [virtual]

It can handle access to a slice in a cell.

Reimplemented from casacore::DataManagerColumn.

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 ( uInt rownr ) [private]

Delete the array in the given row.

void casacore::StManColumnIndArrayAipsIO::doCreate ( uInt nrrow ) [virtual]

Let the column create its array file.

Reimplemented from casacore::StManColumnAipsIO.

void casacore::StManColumnIndArrayAipsIO::getArrayBoolV	(	uInt	rownr,
		Array< Bool > *	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::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getArrayComplexV	(	uInt	rownr,
		Array< Complex > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getArrayDComplexV	(	uInt	rownr,
		Array< DComplex > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getArraydoubleV	(	uInt	rownr,
		Array< double > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getArrayfloatV	(	uInt	rownr,
		Array< float > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getArrayIntV	(	uInt	rownr,
		Array< Int > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getArrayShortV	(	uInt	rownr,
		Array< Short > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getArrayStringV	(	uInt	rownr,
		Array< String > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getArrayuCharV	(	uInt	rownr,
		Array< uChar > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getArrayuIntV	(	uInt	rownr,
		Array< uInt > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getArrayuShortV	(	uInt	rownr,
		Array< uShort > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getData	(	void *	datap,
		uInt	index,
		uInt	nrval,
		AipsIO &	,
		uInt	version
	)			`[private, virtual]`

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.

void casacore::StManColumnIndArrayAipsIO::getFile	(	uInt	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 ( uInt rownr ) [private]

Read the shape at the given row.

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

void casacore::StManColumnIndArrayAipsIO::getSliceBoolV	(	uInt	rownr,
		const Slicer &	,
		Array< Bool > *	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::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getSliceComplexV	(	uInt	rownr,
		const Slicer &	,
		Array< Complex > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getSliceDComplexV	(	uInt	rownr,
		const Slicer &	,
		Array< DComplex > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getSlicedoubleV	(	uInt	rownr,
		const Slicer &	,
		Array< double > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getSlicefloatV	(	uInt	rownr,
		const Slicer &	,
		Array< float > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getSliceIntV	(	uInt	rownr,
		const Slicer &	,
		Array< Int > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getSliceShortV	(	uInt	rownr,
		const Slicer &	,
		Array< Short > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getSliceStringV	(	uInt	rownr,
		const Slicer &	,
		Array< String > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getSliceuCharV	(	uInt	rownr,
		const Slicer &	,
		Array< uChar > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getSliceuIntV	(	uInt	rownr,
		const Slicer &	,
		Array< uInt > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::getSliceuShortV	(	uInt	rownr,
		const Slicer &	,
		Array< uShort > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

Bool casacore::StManColumnIndArrayAipsIO::isShapeDefined ( uInt rownr ) [virtual]

Is the shape defined (i.e.

is there an array) in this row?

Reimplemented from casacore::DataManagerColumn.

uInt casacore::StManColumnIndArrayAipsIO::ndim ( uInt 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::StManColumnAipsIO.

void casacore::StManColumnIndArrayAipsIO::openFile ( ByteIO::OpenOption opt ) [private]

Open the file with the given mode.

StManColumnIndArrayAipsIO& casacore::StManColumnIndArrayAipsIO::operator= ( const StManColumnIndArrayAipsIO & ) [private]

Forbid assignment.

Reimplemented from casacore::StManColumnAipsIO.

void casacore::StManColumnIndArrayAipsIO::putArrayBoolV	(	uInt	rownr,
		const Array< Bool > *	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::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putArrayComplexV	(	uInt	rownr,
		const Array< Complex > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putArrayDComplexV	(	uInt	rownr,
		const Array< DComplex > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putArraydoubleV	(	uInt	rownr,
		const Array< double > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putArrayfloatV	(	uInt	rownr,
		const Array< float > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putArrayIntV	(	uInt	rownr,
		const Array< Int > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putArrayShortV	(	uInt	rownr,
		const Array< Short > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putArrayStringV	(	uInt	rownr,
		const Array< String > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putArrayuCharV	(	uInt	rownr,
		const Array< uChar > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putArrayuIntV	(	uInt	rownr,
		const Array< uInt > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putArrayuShortV	(	uInt	rownr,
		const Array< uShort > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putData	(	void *	datap,
		uInt	nrval,
		AipsIO &
	)			`[private, virtual]`

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.

void casacore::StManColumnIndArrayAipsIO::putFile	(	uInt	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.

void casacore::StManColumnIndArrayAipsIO::putSliceBoolV	(	uInt	rownr,
		const Slicer &	,
		const Array< Bool > *	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::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putSliceComplexV	(	uInt	rownr,
		const Slicer &	,
		const Array< Complex > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putSliceDComplexV	(	uInt	rownr,
		const Slicer &	,
		const Array< DComplex > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putSlicedoubleV	(	uInt	rownr,
		const Slicer &	,
		const Array< double > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putSlicefloatV	(	uInt	rownr,
		const Slicer &	,
		const Array< float > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putSliceIntV	(	uInt	rownr,
		const Slicer &	,
		const Array< Int > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putSliceShortV	(	uInt	rownr,
		const Slicer &	,
		const Array< Short > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putSliceStringV	(	uInt	rownr,
		const Slicer &	,
		const Array< String > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putSliceuCharV	(	uInt	rownr,
		const Slicer &	,
		const Array< uChar > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putSliceuIntV	(	uInt	rownr,
		const Slicer &	,
		const Array< uInt > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::putSliceuShortV	(	uInt	rownr,
		const Slicer &	,
		const Array< uShort > *	dataPtr
	)			`[virtual]`

Reimplemented from casacore::StManColumn.

void casacore::StManColumnIndArrayAipsIO::remove ( uInt rownr ) [virtual]

Remove the value in the given row.

This will result in lost file space.

Reimplemented from casacore::StManColumnAipsIO.

virtual void casacore::StManColumnIndArrayAipsIO::reopenRW ( ) [virtual]

Reopen the storage manager files for read/write.

Reimplemented from casacore::StManColumnAipsIO.

void casacore::StManColumnIndArrayAipsIO::setShape	(	uInt	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.

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

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

Reimplemented from casacore::DataManagerColumn.

IPosition casacore::StManColumnIndArrayAipsIO::shape ( uInt 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 243 of file StIndArrAIO.h.

StManArrayFile* casacore::StManColumnIndArrayAipsIO::iosfile_p [private]

The file containing the indirect arrays.

Definition at line 251 of file StIndArrAIO.h.

uInt casacore::StManColumnIndArrayAipsIO::seqnr_p [private]

The (unique) sequence number of the column.

Definition at line 241 of file StIndArrAIO.h.

Bool casacore::StManColumnIndArrayAipsIO::shapeIsFixed_p [private]

Switch indicating if the shape is fixed.

Definition at line 245 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 249 of file StIndArrAIO.h.

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

casacore/tables/DataMan/StIndArrAIO.h

casacore::StManColumnIndArrayAipsIO Class Reference

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Motivation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation