Class to define columns of scalar records in tables. More...

#include <ScaRecordColDesc.h>

Inheritance diagram for casa::ScalarRecordColumnDesc:

Public Member Functions
	ScalarRecordColumnDesc (const String &name)
	Construct the column with the given name.
	ScalarRecordColumnDesc (const String &name, const String &comment)
	Construct the column with the given name and comment.
	ScalarRecordColumnDesc (const String &name, const String &comment, const String &dataManName, const String &dataManGroup)
	Construct the column with the given name, comment, and default data manager type and group.
	ScalarRecordColumnDesc (const ScalarRecordColumnDesc &)
	Copy constructor (copy semantics);.
	~ScalarRecordColumnDesc ()
ScalarRecordColumnDesc &	operator= (const ScalarRecordColumnDesc &)
	Assignment (copy semantics);.
virtual BaseColumnDesc *	clone () const
	Clone this column description.
virtual String	className () const
	Get the name of this class.
virtual PlainColumn *	makeColumn (ColumnSet *) const
	Create a Column object out of this.
virtual void	show (ostream &os) const
	Show the column.
	ScalarRecordColumnDesc (SimpleOrderedMap< String, BaseColumnDesc ()(const String &)> &)
	The purpose of this constructor is to register the makeDesc function of this class and map it to a name.
Private Member Functions
virtual void	putDesc (AipsIO &) const
	Put the object.
virtual void	getDesc (AipsIO &)
	Get the object.
Static Private Member Functions
static BaseColumnDesc *	makeDesc (const String &name)
	Create the object from AipsIO (this function is registered by ColumnDesc.cc).
Friends
class	ColumnDesc

Detailed Description

Class to define columns of scalar records in tables.

Review Status

Reviewed By:: Wim Brouw
Date Reviewed:: 1998/12/09
Test programs:: tTableDesc

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

Synopsis

ScalarRecordColumnDesc is the class for defining a table column containing scalar record values. The only record class supported is TableRecord .
This class is similar to the templated class ScalarColumnDesc used to define column descriptions for scalars with a standard data type.

The data managers handle a record as an indirect Vector of uChar, because class ScalarRecordColumnData converts a record to such a vector before passing it to the data manager.

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.
        ScalarRecordColumnDesc<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 (ScalarRecordColumnDesc<String>("name", "comments"));

Motivation

This class resembles the templated class ScalarColumnDesc a lot, but is different enough to make that templated class not usable for records.
In principle it could have been a template specialization, but not all compilers support specializations so well.

To Do

Introduce a class ArrayRecordColumnDesc to support arrays of records.

Definition at line 120 of file ScaRecordColDesc.h.

Constructor & Destructor Documentation

casa::ScalarRecordColumnDesc::ScalarRecordColumnDesc ( const String & name ) [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.

casa::ScalarRecordColumnDesc::ScalarRecordColumnDesc	(	const String &	name,
		const String &	comment
	)

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.

casa::ScalarRecordColumnDesc::ScalarRecordColumnDesc	(	const String &	name,
		const String &	comment,
		const String &	dataManName,
		const String &	dataManGroup
	)

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.

casa::ScalarRecordColumnDesc::ScalarRecordColumnDesc ( const ScalarRecordColumnDesc & )

Copy constructor (copy semantics);.

casa::ScalarRecordColumnDesc::~ScalarRecordColumnDesc ( )

casa::ScalarRecordColumnDesc::ScalarRecordColumnDesc ( SimpleOrderedMap< String, BaseColumnDesc *(*)(const String &)> & )

The purpose of this constructor is to register the makeDesc function of this class and map it to a name.

ColumnDesc.cc registers such functions by using these constructors.

Member Function Documentation

virtual String casa::ScalarRecordColumnDesc::className ( ) const [virtual]

Get the name of this class.

It is used by the registration process.

Implements casa::BaseColumnDesc.

virtual BaseColumnDesc* casa::ScalarRecordColumnDesc::clone ( ) const [virtual]

Clone this column description.

Implements casa::BaseColumnDesc.

virtual void casa::ScalarRecordColumnDesc::getDesc ( AipsIO & ) [private, virtual]

Get the object.

Implements casa::BaseColumnDesc.

virtual PlainColumn* casa::ScalarRecordColumnDesc::makeColumn ( ColumnSet * ) const [virtual]

Create a Column object out of this.

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

Implements casa::BaseColumnDesc.

static BaseColumnDesc* casa::ScalarRecordColumnDesc::makeDesc ( const String & name ) [static, private]

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

ScalarRecordColumnDesc& casa::ScalarRecordColumnDesc::operator= ( const ScalarRecordColumnDesc & )

Assignment (copy semantics);.

virtual void casa::ScalarRecordColumnDesc::putDesc ( AipsIO & ) const [private, virtual]

Put the object.

Implements casa::BaseColumnDesc.

virtual void casa::ScalarRecordColumnDesc::show ( ostream & os ) const [virtual]

Show the column.

Implements casa::BaseColumnDesc.

Friends And Related Function Documentation

friend class ColumnDesc [friend]

Reimplemented from casa::BaseColumnDesc.

Definition at line 122 of file ScaRecordColDesc.h.

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

tables/Tables/ScaRecordColDesc.h

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

casa::ScalarRecordColumnDesc Class Reference [Tables_module]

Public Member Functions

Private Member Functions

Static Private Member Functions

Friends

Detailed Description

Review Status

Intended use:

Prerequisite

Etymology

Synopsis

Example

Motivation

To Do

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

casa::ScalarRecordColumnDesc Class Reference
[Tables_module]