Virtual column forwarding to another row/column. More...

#include <ForwardColRow.h>

Inheritance diagram for casacore::ForwardColumnIndexedRow:

Public Member Functions
	ForwardColumnIndexedRow (ForwardColumnIndexedRowEngine *enginePtr, const String &columnName, int dataType, const String &dataTypeId, const Table &referencedTable)
	Construct it for the given column. More...

	~ForwardColumnIndexedRow ()
	Destructor is mandatory. More...

void	prepare (const Table &thisTable)
	Initialize the object. More...

Public Member Functions inherited from casacore::ForwardColumn
	ForwardColumn (ForwardColumnEngine *enginePtr, const String &columnName, int dataType, const String &dataTypeId, const Table &referencedTable)
	Construct it for the given column. More...

virtual	~ForwardColumn ()
	Destructor is mandatory. More...

void	fillTableName (const Table &thisTable, const Table &referencedTable)
	Define the special keyword containing the name of the original table. More...

void	setRW ()
	Set the column to writable if its underlying table is writable. 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 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	setShapeTiled (uInt rownr, const IPosition &shape, const IPosition &tileShape)
	Set the shape and tile shape of an (variable-shaped) array in the given row. More...

virtual IPosition	tileShape (uInt rownr)
	Get the tile shape of the item in the given row. More...

virtual Bool	canAccessScalarColumnCells (Bool &reask) const
	Can the column data manager handle access to a clooection of cells in a scalar column? If not, the caller should access the column cells by looping through the cells in the column. More...

virtual Bool	canAccessArrayColumnCells (Bool &reask) const
	Can the column data manager handle access to a collection of cells in an array column? If not, the caller should access the column cells by looping through the cells in the column. More...

ColumnCache &	columnCache ()
	Get access to the ColumnCache object. More...

const ColumnCache *	columnCachePtr () const

void	get (uInt rownr, Bool *dataPtr)
	Get the scalar value in the given row. More...

void	get (uInt rownr, uChar *dataPtr)

void	get (uInt rownr, Short *dataPtr)

void	get (uInt rownr, uShort *dataPtr)

void	get (uInt rownr, Int *dataPtr)

void	get (uInt rownr, uInt *dataPtr)

void	get (uInt rownr, Int64 *dataPtr)

void	get (uInt rownr, float *dataPtr)

void	get (uInt rownr, double *dataPtr)

void	get (uInt rownr, Complex *dataPtr)

void	get (uInt rownr, DComplex *dataPtr)

void	get (uInt rownr, String *dataPtr)

void	get (uInt rownr, void *dataPtr)
	This function is the get for all non-standard data types. More...

void	put (uInt rownr, const Bool *dataPtr)
	Put the scalar value into the given row. More...

void	put (uInt rownr, const uChar *dataPtr)

void	put (uInt rownr, const Short *dataPtr)

void	put (uInt rownr, const uShort *dataPtr)

void	put (uInt rownr, const Int *dataPtr)

void	put (uInt rownr, const uInt *dataPtr)

void	put (uInt rownr, const Int64 *dataPtr)

void	put (uInt rownr, const float *dataPtr)

void	put (uInt rownr, const double *dataPtr)

void	put (uInt rownr, const Complex *dataPtr)

void	put (uInt rownr, const DComplex *dataPtr)

void	put (uInt rownr, const String *dataPtr)

void	put (uInt rownr, const void *dataPtr)
	This function is the put for all non-standard data types. More...

virtual uInt	getBlockV (uInt rownr, uInt nrmax, void *dataPtr)
	Get scalars from the given row on with a maximum of nrmax values. More...

virtual void	putBlockV (uInt rownr, uInt nrmax, const void *dataPtr)
	Put nrmax scalars from the given row on. 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...

Private Member Functions
	ForwardColumnIndexedRow (const ForwardColumnIndexedRow &)
	Copy constructor is not needed and therefore forbidden (so make it private). More...

ForwardColumnIndexedRow &	operator= (const ForwardColumnIndexedRow &)
	Assignment is not needed and therefore forbidden (so make it private). More...

Bool	canChangeShape () const
	This data manager cannot handle changing array shapes. More...

Bool	canAccessScalarColumn (Bool &reask) const
	This data manager cannot do get/putColumn. More...

Bool	canAccessArrayColumn (Bool &reask) const
	This data manager cannot do get/putColumn. More...

Bool	canAccessColumnSlice (Bool &reask) const
	This data manager cannot do get/putColumn. More...

void	setShape (uInt rownr, const IPosition &shape)
	Set the shape of an (indirect) array in the given row. More...

Bool	isShapeDefined (uInt rownr)
	Is the value shape defined in the given row? More...

uInt	ndim (uInt rownr)
	Get the dimensionality of the item in the given row. More...

IPosition	shape (uInt rownr)
	Get the shape of the item in the given row. More...

void	getBoolV (uInt rownr, Bool *dataPtr)
	Get the scalar value with a standard data type in the given row. More...

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	getInt64V (uInt rownr, Int64 *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. More...

void	putBoolV (uInt rownr, const Bool *dataPtr)
	Put the scalar value with a standard data type into the given row. More...

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	putInt64V (uInt rownr, const Int64 *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. More...

void	getArrayV (uInt rownr, void *dataPtr)
	Get the array value in the given row. More...

void	putArrayV (uInt rownr, const void *dataPtr)
	Put the array value into the given row. More...

void	getSliceV (uInt rownr, const Slicer &slicer, void *dataPtr)
	Get a section of the array in the given row. More...

void	putSliceV (uInt rownr, const Slicer &slicer, const void *dataPtr)
	Put into a section of the array in the given row. More...

uInt	convertRownr (uInt rownr)
	Convert the rownr to the rownr in the underlying table. More...

Private Attributes
ForwardColumnIndexedRowEngine *	enginePtr_p

Additional Inherited Members
Protected Member Functions inherited from casacore::ForwardColumn
void	basePrepare (const Table &thisTable, Bool writable)
	Do the preparation of the base class column object. More...

BaseColumn *	colPtr () const

Detailed Description

Virtual column forwarding to another row/column.

Review Status

Reviewed By:: Paul Shannon
Date Reviewed:: 1995/05/22
Test programs:: tForwardColRow

Intended use:

Internal

Prerequisite

Etymology

ForwardColumnIndexedRow handles the forwarding of the gets and puts for an individual row/column on behalf of the virtual column engine ForwardColumnIndexedRowEngine. It forwards them to a row/column in another table. The row forwarding is done using a special column containing row numbers indexing the referenced table.

Synopsis

ForwardColumnIndexedRow 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 row numbers in the column are mapped to row numbers in the referenced column using a special column containing the mapping. The name of the other table is stored as a keyword in the forwarding column. When the referenced column is in its turn a ForwardColumn (note: not a ForwardColumnIndexedRow), the table mentioned in there will be used. In this way, the length of the forwarding chain is kept to a minimum.

An object of this class is created (and deleted) by the virtual column engine

ForwardColumnIndexedRowEngine which creates a ForwardColumnIndexedRow object for each column being forwarded.

Definition at line 86 of file ForwardColRow.h.

Constructor & Destructor Documentation

casacore::ForwardColumnIndexedRow::ForwardColumnIndexedRow	(	ForwardColumnIndexedRowEngine *	enginePtr,
		const String &	columnName,
		int	dataType,
		const String &	dataTypeId,
		const Table &	referencedTable
	)

Construct it for the given column.

casacore::ForwardColumnIndexedRow::~ForwardColumnIndexedRow ( )

Destructor is mandatory.

casacore::ForwardColumnIndexedRow::ForwardColumnIndexedRow ( const ForwardColumnIndexedRow & )

private

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

Member Function Documentation

Bool casacore::ForwardColumnIndexedRow::canAccessArrayColumn ( Bool & reask ) const

privatevirtual

This data manager cannot do get/putColumn.

Reimplemented from casacore::DataManagerColumn.

Bool casacore::ForwardColumnIndexedRow::canAccessColumnSlice ( Bool & reask ) const

privatevirtual

This data manager cannot do get/putColumn.

Reimplemented from casacore::DataManagerColumn.

Bool casacore::ForwardColumnIndexedRow::canAccessScalarColumn ( Bool & reask ) const

privatevirtual

This data manager cannot do get/putColumn.

Reimplemented from casacore::DataManagerColumn.

Bool casacore::ForwardColumnIndexedRow::canChangeShape ( ) const

privatevirtual

This data manager cannot handle changing array shapes.

Reimplemented from casacore::DataManagerColumn.

uInt casacore::ForwardColumnIndexedRow::convertRownr ( uInt rownr )

inlineprivate

Convert the rownr to the rownr in the underlying table.

Definition at line 409 of file ForwardColRow.h.

References casacore::ForwardColumnIndexedRowEngine::convertRownr(), and enginePtr_p.

void casacore::ForwardColumnIndexedRow::getArrayV	(	uInt	rownr,
		void *	dataPtr
	)

privatevirtual

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 casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::getBoolV	(	uInt	rownr,
		Bool *	dataPtr
	)

privatevirtual

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

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::getComplexV	(	uInt	rownr,
		Complex *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::getDComplexV	(	uInt	rownr,
		DComplex *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::getdoubleV	(	uInt	rownr,
		double *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::getfloatV	(	uInt	rownr,
		float *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::getInt64V	(	uInt	rownr,
		Int64 *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::getIntV	(	uInt	rownr,
		Int *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::getOtherV	(	uInt	rownr,
		void *	dataPtr
	)

privatevirtual

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

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::getShortV	(	uInt	rownr,
		Short *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::getSliceV	(	uInt	rownr,
		const Slicer &	slicer,
		void *	dataPtr
	)

privatevirtual

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 casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::getStringV	(	uInt	rownr,
		String *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::getuCharV	(	uInt	rownr,
		uChar *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::getuIntV	(	uInt	rownr,
		uInt *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::getuShortV	(	uInt	rownr,
		uShort *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

Bool casacore::ForwardColumnIndexedRow::isShapeDefined ( uInt rownr )

privatevirtual

Is the value shape defined in the given row?

Reimplemented from casacore::DataManagerColumn.

uInt casacore::ForwardColumnIndexedRow::ndim ( uInt rownr )

privatevirtual

Get the dimensionality of the item in the given row.

Reimplemented from casacore::DataManagerColumn.

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

private

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

void casacore::ForwardColumnIndexedRow::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.

Reimplemented from casacore::ForwardColumn.

void casacore::ForwardColumnIndexedRow::putArrayV	(	uInt	rownr,
		const void *	dataPtr
	)

privatevirtual

Put the array value into the given row.

This throws an exception, because putting is not supported.

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::putBoolV	(	uInt	rownr,
		const Bool *	dataPtr
	)

privatevirtual

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

This throws an exception, because putting is not supported.

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::putComplexV	(	uInt	rownr,
		const Complex *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::putDComplexV	(	uInt	rownr,
		const DComplex *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::putdoubleV	(	uInt	rownr,
		const double *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::putfloatV	(	uInt	rownr,
		const float *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::putInt64V	(	uInt	rownr,
		const Int64 *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::putIntV	(	uInt	rownr,
		const Int *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::putOtherV	(	uInt	rownr,
		const void *	dataPtr
	)

privatevirtual

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

This throws an exception, because putting is not supported.

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::putShortV	(	uInt	rownr,
		const Short *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::putSliceV	(	uInt	rownr,
		const Slicer &	slicer,
		const void *	dataPtr
	)

privatevirtual

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

This throws an exception, because putting is not supported.

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::putStringV	(	uInt	rownr,
		const String *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::putuCharV	(	uInt	rownr,
		const uChar *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::putuIntV	(	uInt	rownr,
		const uInt *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::putuShortV	(	uInt	rownr,
		const uShort *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

void casacore::ForwardColumnIndexedRow::setShape	(	uInt	rownr,
		const IPosition &	shape
	)

privatevirtual

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

This throws an exception, because putting is not supported.

Reimplemented from casacore::DataManagerColumn.

IPosition casacore::ForwardColumnIndexedRow::shape ( uInt rownr )

privatevirtual

Get the shape of the item in the given row.

Reimplemented from casacore::DataManagerColumn.

Member Data Documentation

ForwardColumnIndexedRowEngine* casacore::ForwardColumnIndexedRow::enginePtr_p

private

Definition at line 205 of file ForwardColRow.h.

Referenced by convertRownr().

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

casa/casacore/tables/DataMan/ForwardColRow.h

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Review Status

Intended use:

Prerequisite

Etymology

Synopsis

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation