A column in a reference table. More...

#include <RefColumn.h>

Inheritance diagram for casacore::RefColumn:

Public Member Functions
	RefColumn (const BaseColumnDesc , RefTable , BaseColumn *referencedColumn)
	Construct the RefColumn. More...

	~RefColumn ()

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

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

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

virtual TableRecord &	keywordSet ()

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

virtual Bool	isDefined (uInt rownr) const
	Test if a value in a particular cell has been defined. More...

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

virtual void	setShape (uInt rownr, const IPosition &shape, const IPosition &tileShape)
	Set the shape and tile shape of the array in the given row. More...

virtual uInt	ndimColumn () const
	Get the global #dimensions of an array (i.e. More...

virtual IPosition	shapeColumn () const
	Get the global shape of an array (i.e. More...

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

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

virtual Bool	canChangeShape () const
	It can change shape if the underlying column can. More...

virtual Bool	canAccessScalarColumn (Bool &reask) const
	It can handle a scalar column if the underlying column can handle cells in a scalar column. More...

virtual Bool	canAccessArrayColumn (Bool &reask) const
	It can handle an array column if the underlying column can handle cells in an array column. More...

virtual Bool	canAccessSlice (Bool &reask) const
	It can handle a cell slice if the underlying column can do it. More...

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

virtual Bool	canAccessScalarColumnCells (Bool &reask) const
	It can handle cells in a scalar column if the underlying column can do it. More...

virtual Bool	canAccessArrayColumnCells (Bool &reask) const
	It can handle cells in an array column if the underlying column can do it. 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...

virtual void	get (uInt rownr, void *dataPtr) const
	Get the value from a particular cell. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual ColumnCache &	columnCache ()
	Get 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...

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

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 IPosition	tileShape (uInt rownr) const
	Get the tile shape of an array in a particular cell. 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	makeRefSortKey (Sort &, CountedPtr< BaseCompare > &cmpObj, Int order, const Vector< uInt > &rownrs, const void *&dataSave)
	Do it only for the given row numbers. More...

Protected Attributes
RefTable *	refTabPtr_p

BaseColumn *	colPtr_p

ColumnCache	colCache_p

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

Additional Inherited Members
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

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

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

casacore::RefColumn::~RefColumn ( )

Member Function Documentation

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

Public Member Functions

Protected Attributes

Additional Inherited Members