casacore::MSTable< ColEnum, KeyEnum > Class Template Reference

A Table intended to hold astronomical data. More...

#include <MSTable.h>

Inheritance diagram for casacore::MSTable< ColEnum, KeyEnum >:

Public Member Functions
Bool	validate () const
	validate self (make sure that this MS is valid)
void	removeColumn (const String &columnName)
	Remove a column from a table No exception is thrown if this invalidates the table in order to permit more complex operations with invalid intermediate states.
void	removeColumn (const Vector< String > &columnNames)
	Remove columns from a table.
void	renameColumn (const String &newName, const String &oldName)
	Rename a column No exception is thrown if this invalidates the table in order to permit more complex operations with invalid intermediate states.
Static Public Member Functions
static Bool	validate (const TableDesc &tabDesc)
	tableDesc convenience functions
static Bool	validate (const TableRecord &tabKeySet)
	check that the keyword set is valid
static const TableDesc &	requiredTableDesc ()
	return the required table description
static void	addColumnCompression (TableDesc &td, ColEnum which, Bool autoScale=True, const String &type=String())
	Add the compress option for the given column to the TableDesc.
Protected Member Functions
	~MSTable ()
MSTable &	operator= (const MSTable< ColEnum, KeyEnum > &)
	Assignment operator, reference semantics.
Table	referenceCopy (const String &newTableName, const Block< String > &writableColumns) const
	Return a table that references all columns in this table except for those given in writableColumns, those are empty and writable.
Static Protected Member Functions
static void	colMapDef (ColEnum col, const String &colName, DataType colType, const String &colComment, const String &colUnit="", const String &colMeasureType="")
	Define an entry in the column maps.
static void	keyMapDef (KeyEnum key, const String &keyName, DataType keyType, const String &keyComment)
	Define an entry in the keyword maps.
Static Protected Attributes
static SimpleOrderedMap< Int, String >	columnMap_p
	These are the static ordered maps which contain the above info ColEnum -> name.
static SimpleOrderedMap< Int, Int >	colDTypeMap_p
	ColEnum -> DataType.
static SimpleOrderedMap< Int, String >	colCommentMap_p
	ColEnum -> comment string.
static SimpleOrderedMap< Int, String >	colUnitMap_p
	ColEnum -> UNIT string.
static SimpleOrderedMap< Int, String >	colMeasureTypeMap_p
	ColEnum -> MEASURE_TYPE string.
static SimpleOrderedMap< Int, String >	keywordMap_p
	KeyEnum -> name.
static SimpleOrderedMap< Int, Int >	keyDTypeMap_p
	KeyEnum -> DataType.
static SimpleOrderedMap< Int, String >	keyCommentMap_p
	KeyEnum -> comment string.
static CountedPtr< TableDesc >	requiredTD_p
	The required TableDesc.

Bool	isColumn (ColEnum which) const
	ColEnum convenience functions.
Bool	isColumnWritable (ColEnum which) const
	check to see if a column is writable
Bool	isColumnWritable (const String &columnName) const
	Test if the given column is writable.
Bool	isColumnWritable (uInt columnIndex) const
Bool	isScalar (ColEnum which) const
	Information about scalar vs array of a column.
Bool	isArray (ColEnum which) const
const String &	unit (const String &which) const
	Return the UNIT keyword value associated with the specified column.
const String &	unit (ColEnum which) const
Bool	isKeyword (KeyEnum which) const
	check to see if a keyword exists
static const String &	columnName (ColEnum which)
	Convert a ColEnum to the actual column name.
static ColEnum	columnType (const String &name)
	Convert a name to a ColEnum.
static DataType	columnDataType (ColEnum which)
	return the data type for a given ColEnum
static const String &	columnStandardComment (ColEnum which)
	return the standard comment for a given ColEnum
static const String &	columnUnit (ColEnum which)
	return the UNIT string for a given ColEnum
static const String &	columnMeasureType (ColEnum which)
	return the MEASURE_TYPE string for a given ColEnum
static void	addColumnToDesc (TableDesc &tabDesc, ColEnum which, Int ndim=-1, const String &refCol="")
	add a column to a TableDesc An exception is thrown for an invalid data type.
static void	addColumnToDesc (TableDesc &tabDesc, ColEnum which, const IPosition &shape, ColumnDesc::Option option, const String &refCol="")
	add a column to a TableDesc, defining the shape and setting the ColumnDesc option (Fixed, Undefined, Direct) For Measure columns you can define a variable reference column.
static const String &	keywordName (KeyEnum which)
	KeyEnum convenience functions.
static KeyEnum	keywordType (const String &name)
static DataType	keywordDataType (KeyEnum which)
static const String &	keywordStandardComment (KeyEnum which)
static void	addKeyToDesc (TableDesc &tabDesc, KeyEnum key)
	add a keyword to a TableDesc An exception is thrown for an invalid data type.
	MSTable ()
	These constructors mirror the Table ones.
	MSTable (const String &tableName, TableOption option)
	MSTable (const String &tableName, const TableLock &lockOptions, TableOption option)
	MSTable (const String &tableName, const String &tableDescName, TableOption option)
	MSTable (const String &tableName, const String &tableDescName, const TableLock &lockOptions, TableOption option)
	MSTable (SetupNewTable &newTab, uInt nrrow, Bool initialize)
	MSTable (SetupNewTable &newTab, const TableLock &lockOptions, uInt nrrow, Bool initialize)
	MSTable (const Table &table)
	MSTable (const MSTable< ColEnum, KeyEnum > &other)

Detailed Description

template<class ColEnum, class KeyEnum>
class casacore::MSTable< ColEnum, KeyEnum >

A Table intended to hold astronomical data.

Intended use:

Public interface

Review Status

Reviewed By:: Bob Garwood
Date Reviewed:: 1997/02/01

Prerequisite

Tables module

Etymology

The MSTable is the base class for all MeasurementSet Tables, hence the name.

Synopsis

A MSTable is a Table. Most operations on a MSTable are Table operations. See the Tables module for a list of those operations. The member functions provided by this class are primarily convenience functions to help users follow the agreed upon column and keyword naming conventions. They are useful when creating a Table following the MSTable conventions from scratch as well as when creating the column objects to access those columns. All actual MeasurementSet Tables will be derived from this class.

The standard way of accessing table columns is through Strings. Mistakes in typing the column name will not be caught at compile time (and may not be caught at run time). We have therefore decided to use an enumeration to specify columns so that many mistakes will be caught at compile time. This requires functions to map to and from this enumeration to the strings that are ultimately used.

Upon destruction, the table is checked to see that all required columns and keywords are still present. If not an exception is thrown. (Not a good idea!) Nevertheless, the table will be flushed to disk if it is writable - preserving its state.

Example

For examples of use, see the MeasurementSet class.

Motivation

The Table module is more than adequate as a container of data. However, in order for applications to be useful with data from different sources, some conventions need to be adopted in the use of Tables to store data. The MSTable provides the framework for these conventions and conversion functions. The actual definitions of columns and keywords are found in the derived classes and their "enum" base class (e.g. MSAntenna and MSAntennaEnums).