A column in a reference table. More...

#include <RefColumn.h>

Inheritance diagram for casa::RefColumn:

Public Member Functions
	RefColumn (const BaseColumnDesc , RefTable , BaseColumn *referencedColumn)
	Construct the RefColumn.
	~RefColumn ()
virtual Bool	isWritable () const
	Test if the column is writable in the parent table.
virtual Bool	isStored () const
	Test if the column is stored (otherwise it is virtual).
virtual TableRecord &	rwKeywordSet ()
	Get access to the column keyword set.
virtual TableRecord &	keywordSet ()
virtual uInt	nrow () const
	Get nr of rows in the column.
virtual Bool	isDefined (uInt rownr) const
	Test if a value in a particular cell has been defined.
virtual void	setShape (uInt rownr, const IPosition &shape)
	Set the shape of the array in the given row.
virtual void	setShape (uInt rownr, const IPosition &shape, const IPosition &tileShape)
	Set the shape and tile shape of the array in the given row.
virtual uInt	ndimColumn () const
	Get the global #dimensions of an array (i.e.
virtual IPosition	shapeColumn () const
	Get the global shape of an array (i.e.
virtual uInt	ndim (uInt rownr) const
	Get the #dimensions of an array in a particular cell.
virtual IPosition	shape (uInt rownr) const
	Get the shape of an array in a particular cell.
virtual Bool	canChangeShape () const
	It can change shape if the underlying column can.
virtual Bool	canAccessScalarColumn (Bool &reask) const
	It can handle a scalar column if the underlying column can handle cells in a scalar column.
virtual Bool	canAccessArrayColumn (Bool &reask) const
	It can handle an array column if the underlying column can handle cells in an array column.
virtual Bool	canAccessSlice (Bool &reask) const
	It can handle a cell slice if the underlying column can do it.
virtual Bool	canAccessColumnSlice (Bool &reask) const
	It can handle a column slice if the underlying column can handle a collection of cells in a column and a column slice.
virtual Bool	canAccessScalarColumnCells (Bool &reask) const
	It can handle cells in a scalar column if the underlying column can do it.
virtual Bool	canAccessArrayColumnCells (Bool &reask) const
	It can handle cells in an array column if the underlying column can do it.
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).
virtual void	get (uInt rownr, void *dataPtr) const
	Get the value from a particular cell.
virtual void	getSlice (uInt rownr, const Slicer &, void *dataPtr) const
	Get a slice of an N-dimensional array in a particular cell.
virtual void	getScalarColumn (void *dataPtr) const
	Get the vector of all scalar values in a column.
virtual void	getArrayColumn (void *dataPtr) const
	Get the array of all array values in a column.
virtual void	getColumnSlice (const Slicer &, void *dataPtr) const
	Get subsections from all arrays in the column.
virtual void	getScalarColumnCells (const RefRows &rownrs, void *dataPtr) const
	Get the vector of some scalar values in a column.
virtual void	getArrayColumnCells (const RefRows &rownrs, void *dataPtr) const
	Get the array of some array values in a column.
virtual void	getColumnSliceCells (const RefRows &rownrs, const Slicer &, void *dataPtr) const
	Get subsections from some arrays in the column.
virtual void	put (uInt rownr, const void *dataPtr)
	Put the value in a particular cell.
virtual void	putSlice (uInt rownr, const Slicer &, const void *dataPtr)
	Put a slice of an N-dimensional array in a particular cell.
virtual void	putScalarColumn (const void *dataPtr)
	Put the vector of all scalar values in the column.
virtual void	putArrayColumn (const void *dataPtr)
	Put the array of all array values in the column.
virtual void	putColumnSlice (const Slicer &, const void *dataPtr)
	Put into subsections of all table arrays in the column.
virtual void	putScalarColumnCells (const RefRows &rownrs, const void *dataPtr)
	Get the vector of some scalar values in a column.
virtual void	putArrayColumnCells (const RefRows &rownrs, const void *dataPtr)
	Get the array of some array values in a column.
virtual void	putColumnSliceCells (const RefRows &rownrs, const Slicer &, const void *dataPtr)
	Put subsections of some arrays in the column.
virtual ColumnCache &	columnCache ()
	Get the underlying column cache.
virtual void	setMaximumCacheSize (uInt nbytes)
	Set the maximum cache size (in bytes) to be used by a storage manager.
virtual void	makeSortKey (Sort &, CountedPtr< BaseCompare > &cmpObj, Int order, const void *&dataSave)
	Add this column and its data to the Sort object.
virtual void	freeSortKey (const void *&dataSave)
	Free storage on the heap allocated by makeSortkey().
virtual void	allocIterBuf (void &lastVal, void &curVal, CountedPtr< BaseCompare > &cmpObj)
	Allocate value buffers for the table iterator.
virtual void	freeIterBuf (void &lastVal, void &curVal)
	Free the value buffers allocated by allocIterBuf.
Protected Attributes
RefTable *	refTabPtr_p
BaseColumn *	colPtr_p
ColumnCache	colCache_p

Detailed Description

A column in a reference table.

Intended use:

Internal

Review Status

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

Prerequisite

Etymology

RefTable represents a column in a RefTable. A RefTable is a table referencing another table, usually as the result of a select, etc..

Synopsis

RefColumn handles the access of a column in a RefTable. It calls the corresponding function in the referenced column while converting the given row number to the row number in the referenced table.

Motivation

This class is untyped, i.e. not templated. Every call is sent to the underlying referenced BaseColumn which is typed by the virtual function mechanism. A RefColumn can never be used directly. A user always has to construct a typed ArrayColumn or ScalarColumn object to access a column. This means everyting is fully type safe.

To Do

Act upon removal of rows or the underlying column

Definition at line 90 of file RefColumn.h.

Constructor & Destructor Documentation

casa::RefColumn::RefColumn	(	const BaseColumnDesc *	,
		RefTable *	,
		BaseColumn *	referencedColumn
	)

Construct the RefColumn.

It will point to the given column description, RefTable and referenced column. The RefTable will be used to convert the rownr to the rownr in the referenced column.

casa::RefColumn::~RefColumn ( )

Member Function Documentation

virtual void casa::RefColumn::allocIterBuf	(	void *&	lastVal,
		void *&	curVal,
		CountedPtr< BaseCompare > &	cmpObj
	)		`[virtual]`

Allocate value buffers for the table iterator.

Also get a comparison functiuon if undefined. The function freeIterBuf must be called to free the buffers.

Reimplemented from casa::BaseColumn.

virtual Bool casa::RefColumn::canAccessArrayColumn ( Bool & reask ) const [virtual]

It can handle an array column if the underlying column can handle cells in an array column.

Reimplemented from casa::BaseColumn.

virtual Bool casa::RefColumn::canAccessArrayColumnCells ( Bool & reask ) const [virtual]

It can handle cells in an array column if the underlying column can do it.

Reimplemented from casa::BaseColumn.

virtual Bool casa::RefColumn::canAccessColumnSlice ( Bool & reask ) const [virtual]

It can handle a column slice if the underlying column can handle a collection of cells in a column and a column slice.

Reimplemented from casa::BaseColumn.

virtual Bool casa::RefColumn::canAccessScalarColumn ( Bool & reask ) const [virtual]

It can handle a scalar column if the underlying column can handle cells in a scalar column.

Reimplemented from casa::BaseColumn.

virtual Bool casa::RefColumn::canAccessScalarColumnCells ( Bool & reask ) const [virtual]

It can handle cells in a scalar column if the underlying column can do it.

Reimplemented from casa::BaseColumn.

virtual Bool casa::RefColumn::canAccessSlice ( Bool & reask ) const [virtual]

It can handle a cell slice if the underlying column can do it.

Reimplemented from casa::BaseColumn.

virtual Bool casa::RefColumn::canChangeShape ( ) const [virtual]

It can change shape if the underlying column can.

Reimplemented from casa::BaseColumn.

virtual ColumnCache& casa::RefColumn::columnCache ( ) [virtual]

Get the underlying column cache.

Implements casa::BaseColumn.

virtual void casa::RefColumn::freeIterBuf	(	void *&	lastVal,
		void *&	curVal
	)		`[virtual]`

Free the value buffers allocated by allocIterBuf.

Reimplemented from casa::BaseColumn.

virtual void casa::RefColumn::freeSortKey ( const void *& dataSave ) [virtual]

Free storage on the heap allocated by makeSortkey().

The pointer will be set to zero.

Reimplemented from casa::BaseColumn.

virtual void casa::RefColumn::get	(	uInt	rownr,
		void *	dataPtr
	)		const `[virtual]`

Get the value from a particular cell.

This can be a scalar or an array.

Implements casa::BaseColumn.

virtual void casa::RefColumn::getArrayColumn ( void * dataPtr ) const [virtual]

Get the array of all array values in a column.

If the column contains n-dim arrays, the resulting array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.

Reimplemented from casa::BaseColumn.

virtual void casa::RefColumn::getArrayColumnCells	(	const RefRows &	rownrs,
		void *	dataPtr
	)		const `[virtual]`

Get the array of some array values in a column.

If the column contains n-dim arrays, the resulting array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.

Reimplemented from casa::BaseColumn.

virtual void casa::RefColumn::getColumnSlice	(	const Slicer &	,
		void *	dataPtr
	)		const `[virtual]`

Get subsections from all arrays in the column.

If the column contains n-dim arrays, the resulting array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.

Reimplemented from casa::BaseColumn.

virtual void casa::RefColumn::getColumnSliceCells	(	const RefRows &	rownrs,
		const Slicer &	,
		void *	dataPtr
	)		const `[virtual]`

Get subsections from some arrays in the column.

If the column contains n-dim arrays, the resulting array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.

Reimplemented from casa::BaseColumn.

virtual void casa::RefColumn::getScalarColumn ( void * dataPtr ) const [virtual]

Get the vector of all scalar values in a column.

Reimplemented from casa::BaseColumn.

virtual void casa::RefColumn::getScalarColumnCells	(	const RefRows &	rownrs,
		void *	dataPtr
	)		const `[virtual]`

Get the vector of some scalar values in a column.

Reimplemented from casa::BaseColumn.

virtual void casa::RefColumn::getSlice	(	uInt	rownr,
		const Slicer &	,
		void *	dataPtr
	)		const `[virtual]`

Get a slice of an N-dimensional array in a particular cell.

Reimplemented from casa::BaseColumn.

void casa::RefColumn::initialize	(	uInt	startRownr,
		uInt	endRownr
	)		`[virtual]`

Initialize the rows from startRownr till endRownr (inclusive) with the default value defined in the column description (if defined).

Implements casa::BaseColumn.

virtual Bool casa::RefColumn::isDefined ( uInt rownr ) const [virtual]

Test if a value in a particular cell has been defined.

Implements casa::BaseColumn.

virtual Bool casa::RefColumn::isStored ( ) const [virtual]

Test if the column is stored (otherwise it is virtual).

Implements casa::BaseColumn.

virtual Bool casa::RefColumn::isWritable ( ) const [virtual]

Test if the column is writable in the parent table.

Implements casa::BaseColumn.

virtual TableRecord& casa::RefColumn::keywordSet ( ) [virtual]

Implements casa::BaseColumn.

virtual void casa::RefColumn::makeSortKey	(	Sort &	,
		CountedPtr< BaseCompare > &	cmpObj,
		Int	order,
		const void *&	dataSave
	)		`[virtual]`

Add this column and its data to the Sort object.

It may allocate some storage on the heap, which will be saved in the argument dataSave. The function freeSortKey must be called to free this storage.

Reimplemented from casa::BaseColumn.

virtual uInt casa::RefColumn::ndim ( uInt rownr ) const [virtual]

Get the #dimensions of an array in a particular cell.

Reimplemented from casa::BaseColumn.

virtual uInt casa::RefColumn::ndimColumn ( ) const [virtual]

Get the global #dimensions of an array (i.e.

for all rows).

Reimplemented from casa::BaseColumn.

virtual uInt casa::RefColumn::nrow ( ) const [virtual]

Get nr of rows in the column.

Implements casa::BaseColumn.

virtual void casa::RefColumn::put	(	uInt	rownr,
		const void *	dataPtr
	)		`[virtual]`

Put the value in a particular cell.

This can be a scalar or an array.

Implements casa::BaseColumn.

virtual void casa::RefColumn::putArrayColumn ( const void * dataPtr ) [virtual]

Put the array of all array values in the column.

If the column contains n-dim arrays, the source array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.

Reimplemented from casa::BaseColumn.

virtual void casa::RefColumn::putArrayColumnCells	(	const RefRows &	rownrs,
		const void *	dataPtr
	)		`[virtual]`

Get the array of some array values in a column.

If the column contains n-dim arrays, the resulting array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.

Reimplemented from casa::BaseColumn.

virtual void casa::RefColumn::putColumnSlice	(	const Slicer &	,
		const void *	dataPtr
	)		`[virtual]`

Put into subsections of all table arrays in the column.

If the column contains n-dim arrays, the source array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.

Reimplemented from casa::BaseColumn.

virtual void casa::RefColumn::putColumnSliceCells	(	const RefRows &	rownrs,
		const Slicer &	,
		const void *	dataPtr
	)		`[virtual]`

Put subsections of some arrays in the column.

If the column contains n-dim arrays, the source array is (n+1)-dim. The arrays in the column have to have the same shape in all cells.

Reimplemented from casa::BaseColumn.

virtual void casa::RefColumn::putScalarColumn ( const void * dataPtr ) [virtual]

Put the vector of all scalar values in the column.

Reimplemented from casa::BaseColumn.

virtual void casa::RefColumn::putScalarColumnCells	(	const RefRows &	rownrs,
		const void *	dataPtr
	)		`[virtual]`

Get the vector of some scalar values in a column.

Reimplemented from casa::BaseColumn.

virtual void casa::RefColumn::putSlice	(	uInt	rownr,
		const Slicer &	,
		const void *	dataPtr
	)		`[virtual]`

Put a slice of an N-dimensional array in a particular cell.

Reimplemented from casa::BaseColumn.

virtual TableRecord& casa::RefColumn::rwKeywordSet ( ) [virtual]

Get access to the column keyword set.

This is the keyword set in the referenced column.

Implements casa::BaseColumn.

virtual void casa::RefColumn::setMaximumCacheSize ( uInt nbytes ) [virtual]

Set the maximum cache size (in bytes) to be used by a storage manager.

Implements casa::BaseColumn.

virtual void casa::RefColumn::setShape	(	uInt	rownr,
		const IPosition &	shape
	)		`[virtual]`

Set the shape of the array in the given row.

Reimplemented from casa::BaseColumn.

virtual void casa::RefColumn::setShape	(	uInt	rownr,
		const IPosition &	shape,
		const IPosition &	tileShape
	)		`[virtual]`

Set the shape and tile shape of the array in the given row.

Reimplemented from casa::BaseColumn.

virtual IPosition casa::RefColumn::shape ( uInt rownr ) const [virtual]

Get the shape of an array in a particular cell.

Reimplemented from casa::BaseColumn.

virtual IPosition casa::RefColumn::shapeColumn ( ) const [virtual]

Get the global shape of an array (i.e.

for all rows).

Reimplemented from casa::BaseColumn.

Member Data Documentation

ColumnCache casa::RefColumn::colCache_p [protected]

Definition at line 271 of file RefColumn.h.

BaseColumn* casa::RefColumn::colPtr_p [protected]

Definition at line 270 of file RefColumn.h.

RefTable* casa::RefColumn::refTabPtr_p [protected]

Definition at line 269 of file RefColumn.h.

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

casacore/tables/Tables/RefColumn.h

Public Member Functions

Protected Attributes

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Motivation

To Do

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation