Access to a table column containing arrays. More...

#include <ArrColData.h>

Inheritance diagram for casacore::ArrayColumnData< T >:

Public Member Functions
	ArrayColumnData (const ArrayColumnDesc< T > , ColumnSet )
	Construct an array column object from the given description in the given column set. More...

	~ArrayColumnData ()

virtual Bool	canChangeShape () const
	Ask the data manager if the shape of an existing array can be changed. More...

virtual Bool	canAccessSlice (Bool &reask) const
	Ask if the data manager can handle a cell slice. More...

virtual Bool	canAccessArrayColumn (Bool &reask) const
	Ask if the data manager can handle a column. More...

virtual Bool	canAccessArrayColumnCells (Bool &reask) const
	Ask if the data manager can handle some cells in a column. More...

virtual Bool	canAccessColumnSlice (Bool &reask) const
	Ask if the data manager can handle a column slice. More...

void	initialize (uInt startRownr, uInt endRownr)
	Initialize the rows from startRownr till endRownr (inclusive) with the default value defined in the column description (if defined). More...

uInt	ndimColumn () const
	Get the global #dimensions of an array (ie. More...

IPosition	shapeColumn () const
	Get the global shape of an array (ie. More...

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

uInt	ndim (uInt rownr) const
	Get the #dimensions of an array in a particular cell. More...

IPosition	shape (uInt rownr) const
	Get the shape of an array in a particular cell. More...

IPosition	tileShape (uInt rownr) const
	Get the tile shape of an array in a particular cell. More...

void	setShape (uInt rownr, const IPosition &shape)
	Set dimensions of array in a particular cell. More...

void	setShape (uInt rownr, const IPosition &shape, const IPosition &tileShape)
	The shape of tiles in the array can also be defined. More...

Bool	isDefined (uInt rownr) const
	Test if the given cell contains an array. More...

void	get (uInt rownr, void *arrayPtr) const
	Get the array from a particular cell. More...

void	getSlice (uInt rownr, const Slicer &, void *arrayPtr) const
	Get a slice of an N-dimensional array in a particular cell. More...

void	getArrayColumn (void *arrayPtr) const
	Get the array of all values in a column. More...

void	getArrayColumnCells (const RefRows &rownrs, void *arrayPtr) const
	Get the array of some values in a column. More...

void	getColumnSlice (const Slicer &, void *arrayPtr) const
	Get subsections from all arrays in the column. More...

void	getColumnSliceCells (const RefRows &rownrs, const Slicer &, void *arrayPtr) const
	Get subsections from some arrays in the column. More...

void	put (uInt rownr, const void *arrayPtr)
	Put the value in a particular cell. More...

void	putSlice (uInt rownr, const Slicer &, const void *arrayPtr)
	Put a slice of an N-dimensional array in a particular cell. More...

void	putArrayColumn (const void *arrayPtr)
	Put the array of all values in the column. More...

void	putArrayColumnCells (const RefRows &rownrs, const void *arrayPtr)
	Put the array of some values in the column. More...

void	putColumnSlice (const Slicer &, const void *arrayPtr)
	Put into subsections of all table arrays in the column. More...

void	putColumnSliceCells (const RefRows &rownrs, const Slicer &, const void *arrayPtr)
	Put into subsections of some table arrays in the column. More...

void	createDataManagerColumn ()
	Create a data manager column object for this column. More...

Public Member Functions inherited from casacore::PlainColumn
	PlainColumn (const BaseColumnDesc , ColumnSet )

virtual	~PlainColumn ()

virtual Bool	isWritable () const
	Test if the column is in principle writable. More...

virtual Bool	isStored () const
	Test if the column is stored (otherwise it is virtual). More...

TableRecord &	rwKeywordSet ()
	Get access to the column keyword set. More...

TableRecord &	keywordSet ()

uInt	nrow () const
	Get nr of rows in the column. More...

virtual Bool	isBound () const
	Test if the column is bound to a storage manager or virtual column engine. More...

virtual void	bind (DataManager *)
	Bind the column to a data manager. More...

DataManager *	dataManager () const
	Get the pointer to the data manager. More...

DataManagerColumn *&	dataManagerColumn ()
	Get the pointer to the data manager column. More...

virtual ColumnCache &	columnCache ()
	Get a pointer to the underlying column cache. More...

virtual void	setMaximumCacheSize (uInt nbytes)
	Set the maximum cache size (in bytes) to be used by a storage manager. More...

void	putFile (AipsIO &, const TableAttr &)
	Write the column. More...

void	getFile (AipsIO &, const ColumnSet &, const TableAttr &)
	Read the column. More...

Public Member Functions inherited from casacore::BaseColumn
	BaseColumn (const BaseColumnDesc *)
	Construct it using the given column description. More...

virtual	~BaseColumn ()

const ColumnDesc &	columnDesc () const
	Get const access to the column description. More...

virtual Bool	canAccessScalarColumn (Bool &reask) const
	Ask if the data manager can handle a scalar column. More...

virtual Bool	canAccessScalarColumnCells (Bool &reask) const
	Ask if the data manager can handle a collection of cells in a scalar column. More...

virtual void	getScalarColumn (void *dataPtr) const
	Get the vector of all scalar values in a column. More...

virtual void	getScalarColumnCells (const RefRows &rownrs, void *dataPtr) const
	Get the vector of some scalar values in a column. More...

virtual void	putScalarColumn (const void *dataPtr)
	Put the vector of all scalar values in the column. More...

virtual void	putScalarColumnCells (const RefRows &rownrs, const void *dataPtr)
	Get the vector of some scalar values in a column. More...

void	getScalar (uInt rownr, Bool &value) const
	Get the value from the row and convert it to the required type. More...

void	getScalar (uInt rownr, uChar &value) const

void	getScalar (uInt rownr, Short &value) const

void	getScalar (uInt rownr, uShort &value) const

void	getScalar (uInt rownr, Int &value) const

void	getScalar (uInt rownr, uInt &value) const

void	getScalar (uInt rownr, Int64 &value) const

void	getScalar (uInt rownr, float &value) const

void	getScalar (uInt rownr, double &value) const

void	getScalar (uInt rownr, Complex &value) const

void	getScalar (uInt rownr, DComplex &value) const

void	getScalar (uInt rownr, String &value) const

void	getScalar (uInt rownr, TableRecord &value) const

void	getScalar (uInt rownr, void *value, const String &dataTypeId) const
	Get a scalar for the other data types. More...

void	putScalar (uInt rownr, const Bool &value)
	Put the value into the row and convert it from the given type. More...

void	putScalar (uInt rownr, const uChar &value)

void	putScalar (uInt rownr, const Short &value)

void	putScalar (uInt rownr, const uShort &value)

void	putScalar (uInt rownr, const Int &value)

void	putScalar (uInt rownr, const uInt &value)

void	putScalar (uInt rownr, const Int64 &value)

void	putScalar (uInt rownr, const float &value)

void	putScalar (uInt rownr, const double &value)

void	putScalar (uInt rownr, const Complex &value)

void	putScalar (uInt rownr, const DComplex &value)

void	putScalar (uInt rownr, const String &value)

void	putScalar (uInt rownr, const Char *value)

void	putScalar (uInt rownr, const TableRecord &value)

virtual void	makeSortKey (Sort &, CountedPtr< BaseCompare > &cmpObj, Int order, const void *&dataSave)
	Add this column and its data to the Sort object. More...

virtual void	makeRefSortKey (Sort &, CountedPtr< BaseCompare > &cmpObj, Int order, const Vector< uInt > &rownrs, const void *&dataSave)
	Do it only for the given row numbers. More...

virtual void	freeSortKey (const void *&dataSave)
	Free storage on the heap allocated by makeSortkey(). More...

virtual void	allocIterBuf (void &lastVal, void &curVal, CountedPtr< BaseCompare > &cmpObj)
	Allocate value buffers for the table iterator. More...

virtual void	freeIterBuf (void &lastVal, void &curVal)
	Free the value buffers allocated by allocIterBuf. More...

Private Member Functions
	ArrayColumnData (const ArrayColumnData< T > &)
	Copy constructor cannot be used. More...

ArrayColumnData< T > &	operator= (const ArrayColumnData< T > &)
	Assignment cannot be used. More...

void	checkShape (const IPosition &shape) const
	Check if the shape of an array can be set and if it is set correctly (i.e. More...

void	putFileDerived (AipsIO &)
	Write the column data. More...

void	getFileDerived (AipsIO &, const ColumnSet &)
	Read the column data back. More...

Private Attributes
const ArrayColumnDesc< T > *	arrDescPtr_p
	Pointer to column description. More...

Bool	shapeColDef_p
	Is the shape for all arrays in the columns defined. More...

IPosition	shapeCol_p
	Shape for all arrays in the column. More...

Additional Inherited Members
Protected Member Functions inherited from casacore::PlainColumn
int	traceId () const
	Get the trace-id of the table. More...

void	checkValueLength (const void *) const
	Check the length of a value. More...

void	checkValueLength (const String *value) const

void	checkValueLength (const Array< String > *value) const

void	checkReadLock (Bool wait) const
	Lock the table before reading or writing. More...

void	checkWriteLock (Bool wait) const

void	autoReleaseLock () const
	Inspect the auto lock when the inspection interval has expired and release it when another process needs the lock. More...

Protected Member Functions inherited from casacore::BaseColumn
void	throwGetScalar () const
	Throw exceptions for invalid scalar get or put. More...

void	throwPutScalar () const

void	throwGetType (const String &type) const

void	throwPutType (const String &type) const

Protected Attributes inherited from casacore::PlainColumn
DataManager *	dataManPtr_p

DataManagerColumn *	dataColPtr_p

ColumnSet *	colSetPtr_p

String	originalName_p

Bool	rtraceColumn_p

Bool	wtraceColumn_p

Protected Attributes inherited from casacore::BaseColumn
const BaseColumnDesc *	colDescPtr_p

Detailed Description

template<class T>
class casacore::ArrayColumnData< T >

Access to a table column containing arrays.

Intended use:

Internal

Review Status

Reviewed By:: Gareth Hunt
Date Reviewed:: 94Nov17

Prerequisite

Etymology

ArrayColumnData represents a table column containing array data.

Synopsis

The class ArrayColumnData is derived from PlainColumn. It implements the virtual functions accessing a table column containing arrays with an arbitrary data type. Both direct and indirect arrays are supported.

It is possible to access an array or a subsection of it in an individual cell (i.e. table row) or in the entire column. The functions accessing the entire column are implemented by looping over the individual cells.

The main task of this class is to communicate with the data manager column object. This consists of:

Binding itself to a data manager.
Letting the data manager create its column object and setting the shape for direct arrays.
Closing the data manager column object (in putFileDerived).
Reconstructing the data manager object for an existing table (in getFileDerived).
Transferring get/put calls to the data manager column object.

The class is hidden from the user by the envelope class ArrayColumn. It used directly, it should be done with care. It assumes that the arrays in the various get and put functions have the correct length. ArrayColumn does that check.

Template Type Argument Requirements (T)

Default constructor
Copy constructor
Assignment operator

To Do

support tiling

Definition at line 105 of file ArrColData.h.

Constructor & Destructor Documentation

template<class T>

casacore::ArrayColumnData< T >::ArrayColumnData	(	const ArrayColumnDesc< T > *	,
		ColumnSet *
	)

Construct an array column object from the given description in the given column set.

This constructor is used by ArrayColumnDesc::makeColumn.

template<class T>

casacore::ArrayColumnData< T >::~ArrayColumnData ( )

template<class T>

casacore::ArrayColumnData< T >::ArrayColumnData ( const ArrayColumnData< T > & )

private

Copy constructor cannot be used.

Member Function Documentation

template<class T>

virtual Bool casacore::ArrayColumnData< T >::canAccessArrayColumn ( Bool & reask ) const

virtual

Ask if the data manager can handle a column.

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class T> class casacore::ArrayColumnData< T >

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Template Type Argument Requirements (T)

To Do

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class T>
class casacore::ArrayColumnData< T >