Column in the Memory table storage manager class. More...

#include <MSMColumn.h>

Inheritance diagram for casacore::MSMColumn:

Public Member Functions
	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...

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

void	resize (rownr_t nrval)
	Resize the data blocks. More...

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

virtual void	doCreate (rownr_t nrrow)
	Create the number of rows in a new table. More...

virtual void	putFile (rownr_t nrval, AipsIO &)
	Make it possible to write the column data. More...

virtual void	getFile (rownr_t nrval, AipsIO &)
	Make it possible to read the column data. 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 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 item in the given row. 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	getArrayV (rownr_t rownr, ArrayBase &dataPtr)
	Get the array value in the given row. More...

virtual void	putArrayV (rownr_t rownr, const ArrayBase &data)
	Put the array value into the given row. 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...

Protected Member Functions
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...

virtual void	initData (void *datap, rownr_t nrval)
	Initialize the data (after an open). 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
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...

Private Member Functions
	MSMColumn (const MSMColumn &)
	Forbid copy constructor. More...

MSMColumn &	operator= (const MSMColumn &)
	Forbid assignment. 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...

Detailed Description

Column in the Memory table storage manager class.

Intended use:

Internal

Review Status

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

Prerequisite

Etymology

MSMColumn handles a column for the memory-based storage manager.

Synopsis

MSMColumn is used by MemoryStMan to handle the access to the data in a table column. It is an storage manager based in memory. Thus the data is lost when the table is closed. On reopen it will be initialized to the default column value. It fully supports addition and removal of rows.

MSMColumn serves 2 purposes:

It handles a column containing scalar values.
It serves as a base class for MSMDirColumn and MSMIndColumn These classes handle arrays and use MSMColumn to hold a pointer to the array in each row.

MSMColumn does not hold a column as a consecutive array, because extending the column (i.e. adding rows) proved be too expensive due to the repeated copying involved when creating a table (this method was used by the first version of the table system). Instead it has a number of data blocks (extensions) indexed to by a super block. Accessing a row means finding the appropriate extension via a binary search. Because there is only 1 extension when a table is read back, the overhead in finding a row is small.

Motivation

MSMColumn 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

StManAipsIO should use this class

Definition at line 103 of file MSMColumn.h.

Constructor & Destructor Documentation

casacore::MSMColumn::MSMColumn	(	MSMBase *	smptr,
		int	dataType,
		Bool	byPtr
	)

Create a column of the given type.

It will maintain a pointer to its parent storage manager.

virtual casacore::MSMColumn::~MSMColumn ( )

virtual

Frees up the storage.

casacore::MSMColumn::MSMColumn ( const MSMColumn & )

private

Forbid copy constructor.

Member Function Documentation

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

virtual

Add (newNrrow-oldNrrow) rows to the column.

Reimplemented in casacore::StManColumnIndArrayAipsIO, casacore::StManColumnArrayAipsIO, and casacore::MSMDirColumn.

void* casacore::MSMColumn::allocData	(	rownr_t	nrval,
		Bool	byPtr
	)

protected

Allocate an extension with the data type of the column.

void casacore::MSMColumn::deleteAll ( )

protected

Delete all extensions.

Possible underlying data (as used by StManArrayColumnMemory) will not be deleted and should have been deleted beforehand.

void casacore::MSMColumn::deleteData	(	void *	datap,
		Bool	byPtr
	)

protected

Delete an extension.

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

virtual

Create the number of rows in a new table.

This is used when a table gets created or opened.

Reimplemented in casacore::StManColumnIndArrayAipsIO, casacore::StManColumnArrayAipsIO, and casacore::MSMDirColumn.

uInt casacore::MSMColumn::findExt	(	rownr_t	rownr,
		Bool	setCache
	)

protected

Find the extension in which the row number is.

If the flag is true, it also sets the columnCache object.

void* casacore::MSMColumn::getArrayPtr ( rownr_t rownr )

protected

Get the pointer for the given row.

This is for the derived classes like StManArrayColumnMemory.

Referenced by casacore::MSMDirColumn::doGetSlice(), and casacore::MSMDirColumn::doPutSlice().

virtual void casacore::MSMColumn::getBool	(	rownr_t	rownr,
		Bool *	dataPtr
	)

virtual

Get a scalar value in the given row.

The buffer pointed to by dataPtr has to have the correct length (which is guaranteed by the Scalar/ArrayColumn get function).

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::getComplex	(	rownr_t	rownr,
		Complex *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::getDComplex	(	rownr_t	rownr,
		DComplex *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::getdouble	(	rownr_t	rownr,
		double *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

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

virtual

Make it possible to read the column data.

It is only used by derived classes.

Reimplemented in casacore::StManColumnIndArrayAipsIO, casacore::StManColumnArrayAipsIO, and casacore::StManColumnAipsIO.

virtual void casacore::MSMColumn::getfloat	(	rownr_t	rownr,
		float *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::getInt	(	rownr_t	rownr,
		Int *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::getInt64	(	rownr_t	rownr,
		Int64 *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::getScalarColumnV ( ArrayBase & data )

virtual

Get all scalar values in the column.

The vector given in data has to have the correct length (which is guaranteed by the ScalarColumn getColumn function).

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::getShort	(	rownr_t	rownr,
		Short *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::getString	(	rownr_t	rownr,
		String *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::getuChar	(	rownr_t	rownr,
		uChar *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::getuInt	(	rownr_t	rownr,
		uInt *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::getuShort	(	rownr_t	rownr,
		uShort *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::initData	(	void *	datap,
		rownr_t	nrval
	)

protectedvirtual

Initialize the data (after an open).

Reimplemented in casacore::StManColumnAipsIO.

virtual Bool casacore::MSMColumn::ok ( ) const

virtual

Check if the class invariants still hold.

Reimplemented in casacore::StManColumnIndArrayAipsIO.

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

private

Forbid assignment.

void casacore::MSMColumn::putArrayPtr	(	rownr_t	rownr,
		void *	dataPtr
	)

protected

Put the pointer for the given row.

This is for the derived classes like StManArrayColumnMemory.

virtual void casacore::MSMColumn::putBool	(	rownr_t	rownr,
		const Bool *	dataPtr
	)

virtual

Put a scalar value into the given row.

The buffer pointed to by dataPtr has to have the correct length (which is guaranteed by the Scalar/ArrayColumn put function).

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::putComplex	(	rownr_t	rownr,
		const Complex *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::putDComplex	(	rownr_t	rownr,
		const DComplex *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::putdouble	(	rownr_t	rownr,
		const double *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

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

virtual

Make it possible to write the column data.

It is only used by derived classes.

Reimplemented in casacore::StManColumnIndArrayAipsIO, casacore::StManColumnArrayAipsIO, and casacore::StManColumnAipsIO.

virtual void casacore::MSMColumn::putfloat	(	rownr_t	rownr,
		const float *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::putInt	(	rownr_t	rownr,
		const Int *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::putInt64	(	rownr_t	rownr,
		const Int64 *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::putScalarColumnV ( const ArrayBase & data )

virtual

Put all scalar values in the column.

The vector given in data has to have the correct length (which is guaranteed by the ScalarColumn putColumn function).

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::putShort	(	rownr_t	rownr,
		const Short *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::putString	(	rownr_t	rownr,
		const String *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::putuChar	(	rownr_t	rownr,
		const uChar *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::putuInt	(	rownr_t	rownr,
		const uInt *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

virtual void casacore::MSMColumn::putuShort	(	rownr_t	rownr,
		const uShort *	dataPtr
	)

virtual

Reimplemented from casacore::DataManagerColumn.

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

virtual

Remove the given row.

If no rows remain in the extension, the extension is also removed.

Reimplemented in casacore::StManColumnIndArrayAipsIO, casacore::MSMIndColumn, casacore::StManColumnArrayAipsIO, and casacore::MSMDirColumn.

void casacore::MSMColumn::removeData	(	void *	datap,
		rownr_t	inx,
		rownr_t	nrvalAfter
	)

protected

Remove an entry (i.e.

a row) from an extension at the given index. It will do this by shifting the rest (nrvalAfter elements) one position to the left.

virtual void casacore::MSMColumn::reopenRW ( )

virtual

Reopen the storage manager files for read/write.

Reimplemented in casacore::StManColumnIndArrayAipsIO.

void casacore::MSMColumn::resize ( rownr_t nrval )

Resize the data blocks.

This adds an extension when needed.

Member Data Documentation

Bool casacore::MSMColumn::byPtr_p

protected

The data is indirectly accessed via a pointer (for the derived classes).

Definition at line 191 of file MSMColumn.h.

Block<void*> casacore::MSMColumn::data_p

protected

The assembly of all extensions (actually Block<T*>).

Definition at line 197 of file MSMColumn.h.

Block<rownr_t> casacore::MSMColumn::ncum_p

protected

The cumulative nr of rows in all extensions.

Definition at line 199 of file MSMColumn.h.

rownr_t casacore::MSMColumn::nralloc_p

protected

The number of allocated rows in the column.

Definition at line 193 of file MSMColumn.h.

uInt casacore::MSMColumn::nrext_p

protected

The nr of extensions in use.

Definition at line 195 of file MSMColumn.h.

MSMBase* casacore::MSMColumn::stmanPtr_p

protected

Definition at line 189 of file MSMColumn.h.

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

tables/DataMan/MSMColumn.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Motivation

To Do

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation