Templated class to define columns of scalars in tables. More...

#include <ScaColData.h>

Inheritance diagram for casacore::ScalarColumnDesc< T >:

Public Member Functions
	ScalarColumnDesc (const String &name, int options=0)
	Construct the column with the given name. More...

	ScalarColumnDesc (const String &name, const String &comment, int options=0)
	Construct the column with the given name and comment. More...

	ScalarColumnDesc (const String &name, const String &comment, const String &dataManName, const String &dataManGroup, int options=0)
	Construct the column with the given name, comment, and default data manager type and group. More...

	ScalarColumnDesc (const String &name, const String &comment, const String &dataManName, const String &dataManGroup, const T &defaultValue, int options=0)
	Construct the column with the given name, comment, default data manager type and group, and default value. More...

	ScalarColumnDesc (const ScalarColumnDesc< T > &)
	Copy constructor (copy semantics);. More...

	~ScalarColumnDesc ()

ScalarColumnDesc< T > &	operator= (const ScalarColumnDesc< T > &)
	Assignment (copy semantics);. More...

BaseColumnDesc *	clone () const
	Clone this column description. More...

String	className () const
	Get the name of this class. More...

void	setDefault (const T &defaultValue)
	Set the default value. More...

const T &	defaultValue () const
	Get the default value. More...

virtual PlainColumn *	makeColumn (ColumnSet *) const
	Create a Column object out of this. More...

virtual ConcatColumn *	makeConcatColumn (ConcatTable *) const
	Make a ConcatColumn object out of the description. More...

void	show (ostream &os) const
	Show the column. More...

void	registerClass () const
	Register the construction function of this class. More...

Public Member Functions inherited from casacore::BaseColumnDesc
	BaseColumnDesc (const String &name, const String &comment, const String &dataManagerType, const String &dataManagerGroup, DataType, const String &dataTypeId, Int options, uInt ndim, const IPosition &shape, Bool isScalar, Bool isArray, Bool isTable)
	Construct the column base object. More...

	BaseColumnDesc (const BaseColumnDesc &)
	Copy constructor (copy semantics). More...

virtual	~BaseColumnDesc ()

TableRecord &	rwKeywordSet ()
	Get access to the set of keywords. More...

const TableRecord &	keywordSet () const

const String &	name () const
	Get the name of the column. More...

DataType	dataType () const
	Get the data type of the column. More...

const String &	dataTypeId () const
	Get the type id for non-standard data types (i.e. More...

const String &	dataManagerType () const
	Get the type name of the default data manager. More...

String &	dataManagerType ()
	Get the type name of the default data manager. More...

const String &	dataManagerGroup () const
	Get the data manager group. More...

String &	dataManagerGroup ()
	Get the data manager group. More...

void	setDefaultDataManager (Bool always)
	Set the data manager type and group to the default. More...

const String &	comment () const
	Get comment string. More...

String &	comment ()
	Get comment string (allowing it to be changed). More...

Int	options () const
	Get the options. More...

Bool	isScalar () const
	Test if column is scalar, array or table. More...

Bool	isArray () const

Bool	isTable () const

Int	ndim () const
	Get the number of dimensions. More...

const IPosition &	shape () const
	Get the predefined shape. More...

void	setNdim (uInt ndim)
	Set the number of dimensions. More...

void	setShape (const IPosition &shape)
	Set the predefined shape. More...

void	setShape (const IPosition &shape, Bool directOption)

void	setOptions (Int options)
	Set the options to the given value. More...

uInt	maxLength () const
	Get the maximum value length. More...

void	setMaxLength (uInt maxLength)
	Set the maximum value length. More...

const TableDesc *	tableDesc () const
	Get table description (in case column contains subtables). More...

virtual TableDesc *	tableDesc ()

void	setName (const String &name)
	Set the name of the column (for a rename). More...

Static Public Member Functions
static BaseColumnDesc *	makeDesc (const String &name)
	Create the object from AipsIO (this function is registered). More...

Private Member Functions
virtual void	putDesc (AipsIO &) const
	Put the object. More...

virtual void	getDesc (AipsIO &)
	Get the object. More...

Private Attributes
T	defaultVal_p

Friends
class	ColumnDesc

Additional Inherited Members
Protected Member Functions inherited from casacore::BaseColumnDesc
BaseColumnDesc &	operator= (const BaseColumnDesc &)
	Assignment (copy semantics). More...

void	putFile (AipsIO &, const TableAttr &) const
	Put the object. More...

void	getFile (AipsIO &, const TableAttr &)
	Get the object. More...

RefColumn *	makeRefColumn (RefTable , BaseColumn ) const
	Make a RefColumn object out of the description. More...

Protected Attributes inherited from casacore::BaseColumnDesc
String	colName_p

String	comment_p

String	dataManType_p

String	dataManGroup_p

DataType	dtype_p

String	dtypeId_p

Int	option_p

Int	nrdim_p

IPosition	shape_p

uInt	maxLength_p

TableRecord *	keySetPtr_p

Bool	isScalar_p

Bool	isArray_p

Bool	isTable_p

Detailed Description

template<class T>
class casacore::ScalarColumnDesc< T >

Templated class to define columns of scalars in tables.

Review Status

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

Intended use:

Public interface

Prerequisite

Etymology

This class builds descriptions of table columns where each cell (which may also be called a row) will hold a scalar value.

Synopsis

ScalarColumnDesc is a templated class for defining a table column containing scalar values. Note that class ScalarRecordColumnDesc has to be used to define the description of a column containing records.

The table values are handled by a data manager. This can be a storage manager to store the values in a file or it can be a virtual column engine to calculate them on-the-fly. Only the basic data types are allowed when storing in a file. These are: Bool, uChar, Short, uShort, Int, uInt, Int64, float, double, Complex, DComplex and String.

At table creation time (when a table gets created from a table description), each column needs to be bound to a data manager. If not done explicitly, the table system will bind a column to the default data manager defined in the column description.

A scalar column description consists of the following attributes:

Name, which has to be unique and must also be different from possible table keyword names.
Data type, which is determined by the template parameter (e.g. ArrayColumnDesc<Int>).
A data type id, which tells the unique name of non-standard data types (i.e. for data type == TpOther).
Comment, which defaults to an empty string. This serves purely as an informational string for the user.
Default value, which is only possible for the standard data types. It defaults to the undefined value defined in ValType.h. When a row gets added to a table, it is possible to initialize the column fields in the row with this default value.
Default data manager, which will be used if a column for a newly created table is not explicitly bound to a data manager.
Data manager group, which serves 2 purposes. Firstly it can be used in class SetupNewTable to bind a group of columns. Secondly, when the default data managers are used, it allows, for example, to have 2 StandardStMan storage managers. One for one group of columns and one for another group of columns.
Options. These are defined in ColumnDesc.h and can be combined by or-ing them. Currently only the Undefined flag applies to scalars.
Default keyword set, which defaults to an empty set. When a table column gets created from the description, it gets a copy of this keyword set as its initial keyword set.

There are several constructors, which allow to define most of the above mentioned attributes. Others, like the default keyword set, have to be defined explicitly.

This class is derived from BaseColumnDesc, thus the functions in there also apply to this class.
Once a column description is setup satisfactorily, it must be added to a table description before it can be used by the table system.

Example

TableDesc tabDesc("tTableDesc", "1", TableDesc::New);
// Add a scalar integer column ac, define keywords for it
// and define a default value 0.
ScalarColumnDesc<Int> acColumn("ac");
acColumn.rwKeywordSet().define ("scale", Complex(0));
acColumn.rwKeywordSet().define ("unit", "");
acColumn.setDefault (0);
tabDesc.addColumn (acColumn);
// Add another column, now with data type String.\.
// This can be added directly, because no special things like
// keywords or default values have to be set.
tabDesc.addColumn (ScalarColumnDesc<String>("name", "comments"));

Motivation

Several column description classes are needed to allow the user to define attributes which are special for each column type. For scalars the special attribute is the default value. They all have to be templated to support arbitrary data types.

Template Type Argument Requirements (T)

Default constructor
Copy constructor
Assignment operator
static String dataTypeId(); // (not needed for builtin types) This should return the unique "name" of the class.

Definition at line 39 of file ScaColData.h.

Constructor & Destructor Documentation

template<class T >

casacore::ScalarColumnDesc< T >::ScalarColumnDesc	(	const String &	name,
		int	options = `0`
	)

explicit

Construct the column with the given name.

The data manager type defaults to the StandardStMan storage manager. The data manager group defaults to the data manager type. The possible options are defined in ColumnDesc.h.

template<class T >

casacore::ScalarColumnDesc< T >::ScalarColumnDesc	(	const String &	name,
		const String &	comment,
		int	options = `0`
	)

Construct the column with the given name and comment.

The data manager type defaults to the StandardStMan storage manager. The data manager group defaults to the data manager type. The possible options are defined in ColumnDesc.h.

template<class T >

casacore::ScalarColumnDesc< T >::ScalarColumnDesc	(	const String &	name,
		const String &	comment,
		const String &	dataManName,
		const String &	dataManGroup,
		int	options = `0`
	)

Construct the column with the given name, comment, and default data manager type and group.

A blank data manager group defaults to the data manager type. The possible options are defined in ColumnDesc.h.

template<class T >

casacore::ScalarColumnDesc< T >::ScalarColumnDesc	(	const String &	name,
		const String &	comment,
		const String &	dataManName,
		const String &	dataManGroup,
		const T &	defaultValue,
		int	options = `0`
	)

Construct the column with the given name, comment, default data manager type and group, and default value.

A blank data manager group defaults to the data manager type. The possible options are defined in ColumnDesc.h.

template<class T >

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

Copy constructor (copy semantics);.

template<class T >

casacore::ScalarColumnDesc< T >::~ScalarColumnDesc ( )

Member Function Documentation

template<class T >

String casacore::ScalarColumnDesc< T >::className ( ) const

virtual

Get the name of this class.

It is used by the registration process. The template argument gets part of the name.

Implements casacore::BaseColumnDesc.

template<class T >

BaseColumnDesc* casacore::ScalarColumnDesc< T >::clone ( ) const

virtual

Clone this column description.

Implements casacore::BaseColumnDesc.

template<class T >

const T& casacore::ScalarColumnDesc< T >::defaultValue ( ) const

inline

Get the default value.

Definition at line 217 of file ScaColDesc.h.

References casacore::ScalarColumnDesc< T >::defaultVal_p.

Referenced by casacore::ScalarColumnDesc< T >::setDefault().

template<class T >

virtual void casacore::ScalarColumnDesc< T >::getDesc ( AipsIO & )

privatevirtual

Get the object.

Implements casacore::BaseColumnDesc.

template<class T >

virtual PlainColumn* casacore::ScalarColumnDesc< T >::makeColumn ( ColumnSet * ) const

virtual

Create a Column object out of this.

This is used by class ColumnSet to construct a table column object.

Implements casacore::BaseColumnDesc.

template<class T >

virtual ConcatColumn* casacore::ScalarColumnDesc< T >::makeConcatColumn ( ConcatTable * ) const

virtual

Make a ConcatColumn object out of the description.

Reimplemented from casacore::BaseColumnDesc.

template<class T >

static BaseColumnDesc* casacore::ScalarColumnDesc< T >::makeDesc ( const String & name )

static

Create the object from AipsIO (this function is registered).

template<class T >

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

Assignment (copy semantics);.

template<class T >

virtual void casacore::ScalarColumnDesc< T >::putDesc ( AipsIO & ) const

privatevirtual

Put the object.

Implements casacore::BaseColumnDesc.

template<class T >

void casacore::ScalarColumnDesc< T >::registerClass ( ) const

Register the construction function of this class.

template<class T >

void casacore::ScalarColumnDesc< T >::setDefault ( const T & defaultValue )

inline

Set the default value.

Definition at line 213 of file ScaColDesc.h.

References casacore::ScalarColumnDesc< T >::defaultVal_p, and casacore::ScalarColumnDesc< T >::defaultValue().

template<class T >

void casacore::ScalarColumnDesc< T >::show ( ostream & os ) const

virtual

Show the column.

Implements casacore::BaseColumnDesc.

Friends And Related Function Documentation

template<class T >

friend class ColumnDesc

friend

Definition at line 165 of file ScaColDesc.h.

Member Data Documentation

template<class T >

T casacore::ScalarColumnDesc< T >::defaultVal_p

private

Definition at line 237 of file ScaColDesc.h.

Referenced by casacore::ScalarColumnDesc< T >::defaultValue(), and casacore::ScalarColumnDesc< T >::setDefault().

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

casa/casacore/tables/Tables/ScaColData.h
casa/casacore/tables/Tables/ScaColDesc.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

template<class T> class casacore::ScalarColumnDesc< T >

Review Status

Intended use:

Prerequisite

Etymology

Synopsis

Example

Motivation

Template Type Argument Requirements (T)

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<class T>
class casacore::ScalarColumnDesc< T >