Templated base class for virtual scalar column. More...

#include <VirtScaCol.h>

Inheritance diagram for casacore::VirtualScalarColumn< T >:

Public Member Functions
	VirtualScalarColumn ()
	Create a column. More...

virtual	~VirtualScalarColumn ()
	Frees up the storage. More...

int	dataType () const
	Return the data type of the column. More...

String	dataTypeId () const
	Return the data type Id of the column. More...

virtual Bool	isWritable () const
	By default no data can be put in a virtual column. More...

virtual void	get (uInt rownr, T &data)=0
	Get the scalar value in the given row. More...

virtual void	put (uInt rownr, const T &data)
	Put the scalar value into the given row. 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	setShape (uInt rownr, const IPosition &shape)
	Set the shape of an (variable-shaped) array in the given row. 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 Bool	isShapeDefined (uInt rownr)
	Is the value shape defined in the given row? By default it returns True. More...

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

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

virtual IPosition	tileShape (uInt 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...

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	canAccessArrayColumn (Bool &reask) const
	Can the column data manager handle access to a scalar column? If not, the caller should access the column by looping through all 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...

virtual Bool	canAccessSlice (Bool &reask) const
	Can the column data manager handle access to a cell slice? If not, the caller should do slicing itself (by accessing the entire array and slicing it). More...

virtual Bool	canAccessColumnSlice (Bool &reask) const
	Can the column data manager handle access to a column slice? If not, the caller should access the column slice by looping through all cell slices 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 void	getScalarColumnCellsV (const RefRows &rownrs, void *dataPtr)
	Get some scalar values in the column. More...

virtual void	putScalarColumnCellsV (const RefRows &rownrs, const void *dataPtr)
	Put some scalar values in the column. More...

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

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

virtual void	getArrayColumnV (void *dataPtr)
	Get all array values in the column. More...

virtual void	putArrayColumnV (const void *dataPtr)
	Put all array values in the column. More...

virtual void	getArrayColumnCellsV (const RefRows &rownrs, void *dataPtr)
	Get some array values in the column. More...

virtual void	putArrayColumnCellsV (const RefRows &rownrs, const void *dataPtr)
	Put some array values in the column. More...

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

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

virtual void	getColumnSliceV (const Slicer &slicer, void *dataPtr)
	Get a section of all arrays in the column. More...

virtual void	putColumnSliceV (const Slicer &slicer, const void *dataPtr)
	Put into a section of all arrays in the column. More...

virtual void	getColumnSliceCellsV (const RefRows &rownrs, const Slicer &slicer, void *dataPtr)
	Get a section of some arrays in the column. More...

virtual void	putColumnSliceCellsV (const RefRows &rownrs, const Slicer &slicer, const void *dataPtr)
	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
Bool	canAccessScalarColumn (Bool &reask) const
	The class can handle a get/putScalarColumn. More...

virtual void	getScalarColumn (Vector< T > &data)
	Get all scalar values in the column. More...

virtual void	putScalarColumn (const Vector< T > &data)
	Put all scalar values in the column. More...

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

virtual void	putBlock (uInt rownr, uInt nrmax, const T *dataPtr)
	Put nrmax scalars from the given row on. More...

Private Member Functions
void	getBoolV (uInt rownr, Bool *dataPtr)
	Implement the virtual functions defined in DataManagerColumn. 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)
	This function is the get for all non-standard data types. More...

void	putBoolV (uInt rownr, const Bool *dataPtr)
	Implement the virtual functions defined in DataManagerColumn. 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)
	This function is the put for all non-standard data types. More...

void	getScalarColumnV (void *dataPtr)
	Implement the virtual functions defined in DataManagerColumn. More...

void	putScalarColumnV (const void *dataPtr)
	Implement the virtual functions defined in DataManagerColumn. More...

uInt	getBlockV (uInt rownr, uInt nrmax, void *dataPtr)
	Implement the virtual functions defined in DataManagerColumn. More...

void	putBlockV (uInt rownr, uInt nrmax, const void *dataPtr)
	Implement the virtual functions defined in DataManagerColumn. More...

	VirtualScalarColumn (const VirtualScalarColumn< T > &)
	The object cannot be copied. More...

VirtualScalarColumn< T > &	operator= (const VirtualScalarColumn< T > &)
	The object cannot be assigned to. More...

Detailed Description

template<class T>
class casacore::VirtualScalarColumn< T >

Templated base class for virtual scalar column.

Intended use:

Internal

Review Status

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

Prerequisite

Etymology

VirtualScalarColumn handles a virtual column containing a scalar.

Synopsis

VirtualScalarColumn is the abstract base class to handle a scalar column for a virtual column engine. It is derived from DataManagerColumn and reimplements some virtual functions to make life easier for the derived classes. It does the following:

It implements the dataType function, so it is not needed to implement that in derived classes.
It has a default implementation of False for function isWritable. Thus by default virtual scalar columns are not writable, which will often be the case. Only if a virtual scalar column can be writable, it has to be implemented in the derived class.
Declare a get/put function with the template parameter as its argument. The virtual functions get/putBoolV, etc. (defined in DataManagerColumn) are by default implemented using this (templated) get/put function. This allows for the default implementation of get/putBlock and makes life easier for the implementor of a derived class. However, the disadvantage of this is an extra virtual function call. (E.g. for a Bool value the first one is getBoolV and the second one get(T&), where T is Bool). If efficiency is really necessary, getBoolV, etc. should also be implemented in the derived class.
In DataManagerColumn the functions get/putBlockV and get/putColumnV are defined, which have a void* data argument. This is necessary to handle arbitrary data types in the non-templated base class DataManagerColumn. In this templated VirtualScalarColumn class, virtual functions get/putBlock and get/putColumn have been defined. They cast the void* data argument to T&, so in a derived class no care has to be taken for that cast. Furthermore a default implementation of them has been made.
- getBlock gets one value using function get.
- putBlock puts one value at the time using function put.
- getColumn uses function getBlock.
- putColumn uses function putBlock.
If efficiency is an issue, these functions should be implemented in the derived class.

Motivation

This class reimplements some virtual functions implemented by DataManagerColumn and types the data argument. In that way they are easier to implement in derived classes. Furthermore they allow default implementations.

Template Type Argument Requirements (T)

default constructor
copy constructor
assignment operator
static String dataTypeId(); // unique name of the class

Definition at line 126 of file VirtScaCol.h.

Constructor & Destructor Documentation

template<class T>

casacore::VirtualScalarColumn< T >::VirtualScalarColumn ( )

inline

Create a column.

Definition at line 131 of file VirtScaCol.h.

template<class T>

virtual casacore::VirtualScalarColumn< T >::~VirtualScalarColumn ( )

virtual

Frees up the storage.

template<class T>

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

private

The object cannot be copied.

Member Function Documentation

template<class T>

Bool casacore::VirtualScalarColumn< T >::canAccessScalarColumn ( Bool & reask ) const

protectedvirtual

The class can handle a get/putScalarColumn.

Reimplemented from casacore::DataManagerColumn.

template<class T>

int casacore::VirtualScalarColumn< T >::dataType ( ) const

virtual

Return the data type of the column.

Implements casacore::DataManagerColumn.

template<class T>

String casacore::VirtualScalarColumn< T >::dataTypeId ( ) const

virtual

Return the data type Id of the column.

Reimplemented from casacore::DataManagerColumn.

template<class T>

virtual void casacore::VirtualScalarColumn< T >::get	(	uInt	rownr,
		T &	data
	)

pure virtual

Get the scalar value in the given row.

Implemented in casacore::ParAngleColumn, casacore::LASTColumn, and casacore::HourangleColumn.

Referenced by casacore::VirtScaCol_global_functions_getVirtualScalarColumn::getVirtualScalarColumn().

template<class T>

virtual uInt casacore::VirtualScalarColumn< T >::getBlock	(	uInt	rownr,
		uInt	nrmax,
		T *	dataPtr
	)

protectedvirtual

Get scalars from the given row on with a maximum of nrmax values.

It returns the actual number of values got. This can be used to get an entire column of scalars or to get a part of a column (for a cache for example). The argument dataPtr is in fact a T*, but a void* is needed to be generic. It must have length nrmax.

template<class T>

uInt casacore::VirtualScalarColumn< T >::getBlockV	(	uInt	rownr,
		uInt	nrmax,
		void *	dataPtr
	)

privatevirtual

Implement the virtual functions defined in DataManagerColumn.

Get scalars from the given row on with a maximum of nrmax values.

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::getBoolV	(	uInt	rownr,
		Bool *	dataPtr
	)

privatevirtual

Implement the virtual functions defined in DataManagerColumn.

Get the scalar value in the given row.

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::getComplexV	(	uInt	rownr,
		Complex *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::getDComplexV	(	uInt	rownr,
		DComplex *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::getdoubleV	(	uInt	rownr,
		double *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::getfloatV	(	uInt	rownr,
		float *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::getInt64V	(	uInt	rownr,
		Int64 *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::getIntV	(	uInt	rownr,
		Int *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::getOtherV	(	uInt	rownr,
		void *	dataPtr
	)

privatevirtual

This function is the get for all non-standard data types.

Reimplemented from casacore::DataManagerColumn.

template<class T>

virtual void casacore::VirtualScalarColumn< T >::getScalarColumn ( Vector< T > & data )

protectedvirtual

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).

template<class T>

void casacore::VirtualScalarColumn< T >::getScalarColumnV ( void * dataPtr )

privatevirtual

Implement the virtual functions defined in DataManagerColumn.

Get all scalar values in the column.

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::getShortV	(	uInt	rownr,
		Short *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::getStringV	(	uInt	rownr,
		String *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::getuCharV	(	uInt	rownr,
		uChar *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::getuIntV	(	uInt	rownr,
		uInt *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::getuShortV	(	uInt	rownr,
		uShort *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

template<class T>

virtual Bool casacore::VirtualScalarColumn< T >::isWritable ( ) const

virtual

By default no data can be put in a virtual column.

Reimplemented from casacore::DataManagerColumn.

Reimplemented in casacore::VSCEngine< T >.

template<class T>

VirtualScalarColumn<T>& casacore::VirtualScalarColumn< T >::operator= ( const VirtualScalarColumn< T > & )

private

The object cannot be assigned to.

template<class T>

virtual void casacore::VirtualScalarColumn< T >::put	(	uInt	rownr,
		const T &	data
	)

virtual

Put the scalar value into the given row.

The default implementation throws an exception.

Referenced by casacore::VirtScaCol_global_functions_getVirtualScalarColumn::putVirtualScalarColumn().

template<class T>

virtual void casacore::VirtualScalarColumn< T >::putBlock	(	uInt	rownr,
		uInt	nrmax,
		const T *	dataPtr
	)

protectedvirtual

Put nrmax scalars from the given row on.

It returns the actual number of values put. This can be used to put an entire column of scalars or to put a part of a column (for a cache for example). The argument dataPtr is in fact a const T*, but a const void* is needed to be generic. It must have length nrmax.

template<class T>

void casacore::VirtualScalarColumn< T >::putBlockV	(	uInt	rownr,
		uInt	nrmax,
		const void *	dataPtr
	)

privatevirtual

Implement the virtual functions defined in DataManagerColumn.

Put nrmax scalars from the given row on.

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::putBoolV	(	uInt	rownr,
		const Bool *	dataPtr
	)

privatevirtual

Implement the virtual functions defined in DataManagerColumn.

Put the scalar value into the given row.

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::putComplexV	(	uInt	rownr,
		const Complex *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::putDComplexV	(	uInt	rownr,
		const DComplex *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::putdoubleV	(	uInt	rownr,
		const double *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::putfloatV	(	uInt	rownr,
		const float *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::putInt64V	(	uInt	rownr,
		const Int64 *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::putIntV	(	uInt	rownr,
		const Int *	dataPtr
	)

privatevirtual

Reimplemented from casacore::DataManagerColumn.

template<class T>

void casacore::VirtualScalarColumn< T >::putOtherV	(	uInt	rownr,
		const void *	dataPtr
	)

privatevirtual

This function is the put for all non-standard data types.

Reimplemented from casacore::DataManagerColumn.

template<class T>

virtual void casacore::VirtualScalarColumn< T >::putScalarColumn ( const Vector< T > & data )

protectedvirtual

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).

template<class T>

void casacore::VirtualScalarColumn< T >::putScalarColumnV ( const void * dataPtr )

privatevirtual

Implement the virtual functions defined in DataManagerColumn.

Put all scalar values in the column.

Reimplemented from casacore::DataManagerColumn.

template<class T>