Virtual column forwarding to another column. More...

#include <ForwardCol.h>

Inheritance diagram for casa::ForwardColumn:

Public Member Functions
	ForwardColumn (ForwardColumnEngine *enginePtr, const String &columnName, int dataType, const String &dataTypeId, const Table &referencedTable)
	Construct it for the given column.
virtual	~ForwardColumn ()
	Destructor is mandatory.
void	fillTableName (const Table &thisTable, const Table &referencedTable)
	Define the special keyword containing the name of the original table.
virtual void	prepare (const Table &thisTable)
	Initialize the object.
void	setRW ()
	Set the column to writable if its underlying table is writable.
Protected Member Functions
void	basePrepare (const Table &thisTable, Bool writable)
	Do the preparation of the base class column object.
BaseColumn *	colPtr () const
Private Member Functions
	ForwardColumn (const ForwardColumn &)
	Copy constructor is not needed and therefore forbidden (so make it private).
ForwardColumn &	operator= (const ForwardColumn &)
	Assignment is not needed and therefore forbidden (so make it private).
Bool	canChangeShape () const
	This data manager may be able to handle changing array shapes.
Bool	canAccessScalarColumn (Bool &reask) const
	This data manager may be able to do get/putScalarColumn.
Bool	canAccessArrayColumn (Bool &reask) const
	This data manager may be able to do get/putArrayColumn.
Bool	canAccessSlice (Bool &reask) const
	This data manager may be able to do get/putSlice.
Bool	canAccessColumnSlice (Bool &reask) const
	This data manager may be able to do get/putColumnSlice.
int	dataType () const
	Get the data type of the column as defined in DataType.h.
String	dataTypeId () const
	Get the data type id of the column for dataType==TpOther.
Bool	isWritable () const
	Test if data can be put into this column.
void	setShapeColumn (const IPosition &shape)
	Set the shape of an direct array.
void	setShape (uInt rownr, const IPosition &shape)
	Set the shape of an (indirect) array in the given row.
Bool	isShapeDefined (uInt rownr)
	Is the value shape defined in the given row?
uInt	ndim (uInt rownr)
	Get the dimensionality of the item in the given row.
IPosition	shape (uInt rownr)
	Get the shape of the item in the given row.
void	getBoolV (uInt rownr, Bool *dataPtr)
	Get the scalar value with a standard data type in the given row.
void	getuCharV (uInt rownr, uChar *dataPtr)
void	getShortV (uInt rownr, Short *dataPtr)
void	getuShortV (uInt rownr, uShort *dataPtr)
void	getIntV (uInt rownr, Int *dataPtr)
void	getuIntV (uInt rownr, uInt *dataPtr)
void	getfloatV (uInt rownr, float *dataPtr)
void	getdoubleV (uInt rownr, double *dataPtr)
void	getComplexV (uInt rownr, Complex *dataPtr)
void	getDComplexV (uInt rownr, DComplex *dataPtr)
void	getStringV (uInt rownr, String *dataPtr)
void	getOtherV (uInt rownr, void *dataPtr)
	Get the scalar value with a non-standard data type in the given row.
void	putBoolV (uInt rownr, const Bool *dataPtr)
	Put the scalar value with a standard data type into the given row.
void	putuCharV (uInt rownr, const uChar *dataPtr)
void	putShortV (uInt rownr, const Short *dataPtr)
void	putuShortV (uInt rownr, const uShort *dataPtr)
void	putIntV (uInt rownr, const Int *dataPtr)
void	putuIntV (uInt rownr, const uInt *dataPtr)
void	putfloatV (uInt rownr, const float *dataPtr)
void	putdoubleV (uInt rownr, const double *dataPtr)
void	putComplexV (uInt rownr, const Complex *dataPtr)
void	putDComplexV (uInt rownr, const DComplex *dataPtr)
void	putStringV (uInt rownr, const String *dataPtr)
void	putOtherV (uInt rownr, const void *dataPtr)
	Put the scalar value with a non-standard data type into the given row.
void	getScalarColumnV (void *dataPtr)
	Get all scalar values in the column.
void	putScalarColumnV (const void *dataPtr)
	Put all scalar values in the column.
virtual void	getScalarColumnCellsV (const RefRows &rownrs, void *dataPtr)
	Get some scalar values in the column.
virtual void	putScalarColumnCellsV (const RefRows &rownrs, const void *dataPtr)
	Put some scalar values in the column.
void	getArrayV (uInt rownr, void *dataPtr)
	Get the array value in the given row.
void	putArrayV (uInt rownr, const void *dataPtr)
	Put the array value into the given row.
void	getSliceV (uInt rownr, const Slicer &slicer, void *dataPtr)
	Get a section of the array in the given row.
void	putSliceV (uInt rownr, const Slicer &slicer, const void *dataPtr)
	Put into a section of the array in the given row.
void	getArrayColumnV (void *dataPtr)
	Get all scalar values in the column.
void	putArrayColumnV (const void *dataPtr)
	Put all scalar values in the column.
virtual void	getArrayColumnCellsV (const RefRows &rownrs, void *dataPtr)
	Get some array values in the column.
virtual void	putArrayColumnCellsV (const RefRows &rownrs, const void *dataPtr)
	Put some array values in the column.
void	getColumnSliceV (const Slicer &slicer, void *dataPtr)
	Get a section of all arrays in the column.
void	putColumnSliceV (const Slicer &slicer, const void *dataPtr)
	Put a section into all arrays in the column.
virtual void	getColumnSliceCellsV (const RefRows &rownrs, const Slicer &slicer, void *dataPtr)
	Get a section of some arrays in the column.
virtual void	putColumnSliceCellsV (const RefRows &rownrs, const Slicer &slicer, const void *dataPtr)
	Put into a section of some arrays in the column.
Static Private Member Functions
static SetupNewTable	setupNewTable (const Table &table, const String &tableName, Table::TableOption option)
	Create a SetupNewTable object with the given name and option and with the description from the given table.
Private Attributes
ForwardColumnEngine *	enginePtr_p
String	colName_p
int	dataType_p
String	dataTypeId_p
ROTableColumn	refCol_p
Bool	writable_p
Table	origTable_p
BaseColumn *	colPtr_p

Detailed Description

Virtual column forwarding to another column.

Review Status

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

Intended use:

Internal

Prerequisite

Synopsis

ForwardColumn represents a virtual column which forwards the gets and puts to a column with the same name in another table. It is, in fact, a reference to the other column. The name of the other table is stored as a keyword in the forwarding column. When there is a forwarding chain (i.e. forwarding to a forwarding column), the name of the last table in the chain is stored in the keyword. In this way, the length of the chain is kept to a minimum. Otherwise a very long chain could occur, which would slow things down.

Addition and deletion of rows is allowed, but the functions addRow and removeRow do not do anything at all. They are implemented to override the default "throw exception" implementation. Because the engine allows this, it can be used in a table supporting addition and removal of rows.

An object of this class is created (and deleted) by ForwardColumnEngine which creates a ForwardColumn object for each column being forwarded.

Motivation

This class will be used by the calibration software. Most columns in a measurement table will be forwarded, while a few (i.e. the data themselves) will be calculated by a dedicated calibration engine.

Definition at line 90 of file ForwardCol.h.

Constructor & Destructor Documentation

casa::ForwardColumn::ForwardColumn	(	ForwardColumnEngine *	enginePtr,
		const String &	columnName,
		int	dataType,
		const String &	dataTypeId,
		const Table &	referencedTable
	)

Construct it for the given column.

virtual casa::ForwardColumn::~ForwardColumn ( ) [virtual]

Destructor is mandatory.

casa::ForwardColumn::ForwardColumn ( const ForwardColumn & ) [private]

Copy constructor is not needed and therefore forbidden (so make it private).

Member Function Documentation

void casa::ForwardColumn::basePrepare	(	const Table &	thisTable,
		Bool	writable
	)		`[protected]`

Do the preparation of the base class column object.

Bool casa::ForwardColumn::canAccessArrayColumn ( Bool & reask ) const [private, virtual]

This data manager may be able to do get/putArrayColumn.

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

Bool casa::ForwardColumn::canAccessColumnSlice ( Bool & reask ) const [private, virtual]

This data manager may be able to do get/putColumnSlice.

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

Bool casa::ForwardColumn::canAccessScalarColumn ( Bool & reask ) const [private, virtual]

This data manager may be able to do get/putScalarColumn.

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

Bool casa::ForwardColumn::canAccessSlice ( Bool & reask ) const [private, virtual]

This data manager may be able to do get/putSlice.

Reimplemented from casa::DataManagerColumn.

Bool casa::ForwardColumn::canChangeShape ( ) const [private, virtual]

This data manager may be able to handle changing array shapes.

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

BaseColumn* casa::ForwardColumn::colPtr ( ) const [inline, protected]

Definition at line 126 of file ForwardCol.h.

References colPtr_p.

int casa::ForwardColumn::dataType ( ) const [private, virtual]

Get the data type of the column as defined in DataType.h.

Implements casa::DataManagerColumn.

String casa::ForwardColumn::dataTypeId ( ) const [private, virtual]

Get the data type id of the column for dataType==TpOther.

This function is required for virtual column engines handling non-standard data types. It is used to check the data type.

Reimplemented from casa::DataManagerColumn.

void casa::ForwardColumn::fillTableName	(	const Table &	thisTable,
		const Table &	referencedTable
	)

Define the special keyword containing the name of the original table.

If the column in the referenced table contains that special keyword, it is in its turn a forwarding column. In that case the special keyword value will be copied over to shortcut the forwarding chain. The suffix is appended to the keyword name when defining it. This makes this function usable for derived classes.

virtual void casa::ForwardColumn::getArrayColumnCellsV	(	const RefRows &	rownrs,
		void *	dataPtr
	)		`[private, virtual]`

Get some array values in the column.

The argument dataPtr is in fact an Array<T>*, but a void* is needed to be generic. The vector pointed to by dataPtr has to have the correct length (which is guaranteed by the ArrayColumn getColumn function).

Reimplemented from casa::DataManagerColumn.

void casa::ForwardColumn::getArrayColumnV ( void * dataPtr ) [private, virtual]

Get all scalar values in the column.

The argument dataPtr is in fact a Vector<T>*, but a void* is needed to be generic. The vector pointed to by dataPtr has to have the correct length (which is guaranteed by the ScalarColumn getColumn function).

Reimplemented from casa::DataManagerColumn.

void casa::ForwardColumn::getArrayV	(	uInt	rownr,
		void *	dataPtr
	)		`[private, virtual]`

Get the array value in the given row.

The argument dataPtr is in fact a Array<T>*, but a void* is needed to be generic. The array pointed to by dataPtr has to have the correct shape (which is guaranteed by the ArrayColumn get function).

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::getBoolV	(	uInt	rownr,
		Bool *	dataPtr
	)		`[private, virtual]`

Get the scalar value with a standard data type in the given row.

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

virtual void casa::ForwardColumn::getColumnSliceCellsV	(	const RefRows &	rownrs,
		const Slicer &	slicer,
		void *	dataPtr
	)		`[private, virtual]`

Get a section of some arrays in the column.

The argument dataPtr is in fact an Array<T>*, but a void* is needed to be generic. The array pointed to by dataPtr has to have the correct shape (which is guaranteed by the ArrayColumn getColumn function).

Reimplemented from casa::DataManagerColumn.

void casa::ForwardColumn::getColumnSliceV	(	const Slicer &	slicer,
		void *	dataPtr
	)		`[private, virtual]`

Get a section of all arrays in the column.

The argument dataPtr is in fact a Array<T>*, but a void* is needed to be generic. The array pointed to by dataPtr has to have the correct shape (which is guaranteed by the ArrayColumn getColumn function).

Reimplemented from casa::DataManagerColumn.

void casa::ForwardColumn::getComplexV	(	uInt	rownr,
		Complex *	dataPtr
	)		`[private, virtual]`

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::getDComplexV	(	uInt	rownr,
		DComplex *	dataPtr
	)		`[private, virtual]`

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::getdoubleV	(	uInt	rownr,
		double *	dataPtr
	)		`[private, virtual]`

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::getfloatV	(	uInt	rownr,
		float *	dataPtr
	)		`[private, virtual]`

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::getIntV	(	uInt	rownr,
		Int *	dataPtr
	)		`[private, virtual]`

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::getOtherV	(	uInt	rownr,
		void *	dataPtr
	)		`[private, virtual]`

Get the scalar value with a non-standard data type in the given row.

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

virtual void casa::ForwardColumn::getScalarColumnCellsV	(	const RefRows &	rownrs,
		void *	dataPtr
	)		`[private, virtual]`

Get some scalar values in the column.

The argument dataPtr is in fact a Vector<T>*, but a void* is needed to be generic. The vector pointed to by dataPtr has to have the correct length (which is guaranteed by the ScalarColumn getColumn function).

Reimplemented from casa::DataManagerColumn.

void casa::ForwardColumn::getScalarColumnV ( void * dataPtr ) [private, virtual]

Get all scalar values in the column.

The argument dataPtr is in fact a Vector<T>*, but a void* is needed to be generic. The vector pointed to by dataPtr has to have the correct length (which is guaranteed by the ScalarColumn getColumn function).

Reimplemented from casa::DataManagerColumn.

void casa::ForwardColumn::getShortV	(	uInt	rownr,
		Short *	dataPtr
	)		`[private, virtual]`

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::getSliceV	(	uInt	rownr,
		const Slicer &	slicer,
		void *	dataPtr
	)		`[private, virtual]`

Get a section of the array in the given row.

The argument dataPtr is in fact a Array<T>*, but a void* is needed to be generic. The array pointed to by dataPtr has to have the correct shape (which is guaranteed by the ArrayColumn getSlice function).

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::getStringV	(	uInt	rownr,
		String *	dataPtr
	)		`[private, virtual]`

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::getuCharV	(	uInt	rownr,
		uChar *	dataPtr
	)		`[private, virtual]`

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::getuIntV	(	uInt	rownr,
		uInt *	dataPtr
	)		`[private, virtual]`

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::getuShortV	(	uInt	rownr,
		uShort *	dataPtr
	)		`[private, virtual]`

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

Bool casa::ForwardColumn::isShapeDefined ( uInt rownr ) [private, virtual]

Is the value shape defined in the given row?

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

Bool casa::ForwardColumn::isWritable ( ) const [private, virtual]

Test if data can be put into this column.

Reimplemented from casa::DataManagerColumn.

uInt casa::ForwardColumn::ndim ( uInt rownr ) [private, virtual]

Get the dimensionality of the item in the given row.

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

ForwardColumn& casa::ForwardColumn::operator= ( const ForwardColumn & ) [private]

Assignment is not needed and therefore forbidden (so make it private).

virtual void casa::ForwardColumn::prepare ( const Table & thisTable ) [virtual]

Initialize the object.

This means binding the column to the column with the same name in the original table. It checks if the description of both columns is the same. It also determines if the column is writable.

Reimplemented in casa::ForwardColumnIndexedRow.

virtual void casa::ForwardColumn::putArrayColumnCellsV	(	const RefRows &	rownrs,
		const void *	dataPtr
	)		`[private, virtual]`

Put some array values in the column.

The argument dataPtr is in fact an const Array<T>*, but a const void* is needed to be generic. The vector pointed to by dataPtr has to have the correct length (which is guaranteed by the ArrayColumn getColumn function).

Reimplemented from casa::DataManagerColumn.

void casa::ForwardColumn::putArrayColumnV ( const void * dataPtr ) [private, virtual]

Put all scalar values in the column.

The argument dataPtr is in fact a const Vector<T>*, but a const void* is needed to be generic. The vector pointed to by dataPtr has to have the correct length (which is guaranteed by the ScalarColumn putColumn function).

Reimplemented from casa::DataManagerColumn.

void casa::ForwardColumn::putArrayV	(	uInt	rownr,
		const void *	dataPtr
	)		`[private, virtual]`

Put the array value into the given row.

The argument dataPtr is in fact a const Array<T>*, but a const void* is needed to be generic. The array pointed to by dataPtr has to have the correct shape (which is guaranteed by the ArrayColumn put function).

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::putBoolV	(	uInt	rownr,
		const Bool *	dataPtr
	)		`[private, virtual]`

Put the scalar value with a standard data type into the given row.

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

virtual void casa::ForwardColumn::putColumnSliceCellsV	(	const RefRows &	rownrs,
		const Slicer &	slicer,
		const void *	dataPtr
	)		`[private, virtual]`

Put into a section of some arrays in the column.

The argument dataPtr is in fact a const Array<T>*, but a const void* is needed to be generic. The array pointed to by dataPtr has to have the correct shape (which is guaranteed by the ArrayColumn putColumn function).

Reimplemented from casa::DataManagerColumn.

void casa::ForwardColumn::putColumnSliceV	(	const Slicer &	slicer,
		const void *	dataPtr
	)		`[private, virtual]`

Put a section into all arrays in the column.

The argument dataPtr is in fact a const Array<T>*, but a const void* is needed to be generic. The array pointed to by dataPtr has to have the correct shape (which is guaranteed by the ArrayColumn putColumn function).

Reimplemented from casa::DataManagerColumn.

void casa::ForwardColumn::putComplexV	(	uInt	rownr,
		const Complex *	dataPtr
	)		`[private, virtual]`

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::putDComplexV	(	uInt	rownr,
		const DComplex *	dataPtr
	)		`[private, virtual]`

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::putdoubleV	(	uInt	rownr,
		const double *	dataPtr
	)		`[private, virtual]`

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::putfloatV	(	uInt	rownr,
		const float *	dataPtr
	)		`[private, virtual]`

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::putIntV	(	uInt	rownr,
		const Int *	dataPtr
	)		`[private, virtual]`

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::putOtherV	(	uInt	rownr,
		const void *	dataPtr
	)		`[private, virtual]`

Put the scalar value with a non-standard data type into the given row.

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

virtual void casa::ForwardColumn::putScalarColumnCellsV	(	const RefRows &	rownrs,
		const void *	dataPtr
	)		`[private, virtual]`

Put some scalar values in the column.

The argument dataPtr is in fact a const Vector<T>*, but a const void* is needed to be generic. The vector pointed to by dataPtr has to have the correct length (which is guaranteed by the ScalarColumn getColumn function).

Reimplemented from casa::DataManagerColumn.

void casa::ForwardColumn::putScalarColumnV ( const void * dataPtr ) [private, virtual]

Put all scalar values in the column.

The argument dataPtr is in fact a const Vector<T>*, but a const void* is needed to be generic. The vector pointed to by dataPtr has to have the correct length (which is guaranteed by the ScalarColumn putColumn function).

Reimplemented from casa::DataManagerColumn.

void casa::ForwardColumn::putShortV	(	uInt	rownr,
		const Short *	dataPtr
	)		`[private, virtual]`

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::putSliceV	(	uInt	rownr,
		const Slicer &	slicer,
		const void *	dataPtr
	)		`[private, virtual]`

Put into a section of the array in the given row.

The argument dataPtr is in fact a const Array<T>*, but a const void* is needed to be generic. The array pointed to by dataPtr has to have the correct shape (which is guaranteed by the ArrayColumn putSlice function).

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::putStringV	(	uInt	rownr,
		const String *	dataPtr
	)		`[private, virtual]`

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::putuCharV	(	uInt	rownr,
		const uChar *	dataPtr
	)		`[private, virtual]`

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::putuIntV	(	uInt	rownr,
		const uInt *	dataPtr
	)		`[private, virtual]`

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::putuShortV	(	uInt	rownr,
		const uShort *	dataPtr
	)		`[private, virtual]`

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::setRW ( )

Set the column to writable if its underlying table is writable.

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

Set the shape of an (indirect) array in the given row.

Reimplemented from casa::DataManagerColumn.

Reimplemented in casa::ForwardColumnIndexedRow.

void casa::ForwardColumn::setShapeColumn ( const IPosition & shape ) [private, virtual]

Set the shape of an direct array.

This only checks if the shape matches the referenced column.

Reimplemented from casa::DataManagerColumn.

static SetupNewTable casa::ForwardColumn::setupNewTable	(	const Table &	table,
		const String &	tableName,
		Table::TableOption	option
	)		`[static, private]`

Create a SetupNewTable object with the given name and option and with the description from the given table.

The SetupNewTable object will use a single ForwardColumn engine which forwards all columns to the given table. Later the SetupNewTable::bind functions can be used to bind one or more columns to another data manager.

IPosition casa::ForwardColumn::shape ( uInt rownr ) [private, virtual]