casacore::TableMeasDescBase Class Reference

Definition of a Measure in a Table. More...

#include <TableMeasDescBase.h>

Inheritance diagram for casacore::TableMeasDescBase:

Public Member Functions
	TableMeasDescBase ()
	Null constructor.
	TableMeasDescBase (const TableMeasValueDesc &, const TableMeasRefDesc &)
	Constructor with value and reference descriptors.
	TableMeasDescBase (const TableMeasDescBase &that)
	Copy constructor.
virtual	~TableMeasDescBase ()
virtual TableMeasDescBase *	clone () const
	Clone the object.
TableMeasDescBase &	operator= (const TableMeasDescBase &that)
	Assignment operator.
void	write (TableDesc &)
	Makes the descriptor persistent.
void	write (Table &)
void	writeIfOld (const Table &)
	Make the descriptor persistent if there was no refcode vector.
const String &	columnName () const
	Get the name of the underlying column.
uInt	getRefCode () const
	Return the reference code.
Bool	isRefCodeVariable () const
	Returns True if the reference varies per row.
const String &	refColumnName () const
	Returns the name of the ref code column when the ref code is variable.
const TableMeasRefDesc &	getRefDesc () const
	Returns a reference to its measure reference descriptor.
const String &	offsetColumnName () const
	Get the name of the offset column.
Bool	hasOffset () const
	Returns True if an offset has been defined.
Bool	isOffsetVariable () const
	Returns True if the offset is variable.
Bool	isOffsetArray () const
	Returns True if the offset is variable and is stored in an ArrayMeasColumn, i.e., offsets are stored per element.
const Measure &	getOffset () const
	Returns a reference to the offset.
const String &	type () const
	Returns the descriptors measure type as a String.
uInt	refCode (const String &refString) const
	Returns the reference code for this object given a string.
const String &	refType (uInt refCode) const
	Translates the refCode for the descriptors measure type.
const Vector< Unit > &	getUnits () const
	Return the Units of the Measure values.
void	resetRefCode (uInt refCode)
	Reset the refCode, offset, or units.
void	resetOffset (const Measure &offset)
void	resetUnits (const Vector< Unit > &units)
Static Public Member Functions
static TableMeasDescBase *	reconstruct (const Table &tab, const String &columnName)
	Reconstructs the object for the given table and column name.
static Bool	hasMeasures (const TableColumn &column)
	Does this column contain table measures?
Protected Member Functions
void	initTabRef (const MeasureHolder &measHolder)
	Set the initial reference codes and types in the table.
void	setMeasUnits (const Measure &meas, const Vector< Quantum< Double > > &val, const Vector< Unit > &units)
	Set the measure and possible units.
Private Attributes
TableMeasValueDesc	itsValue
TableMeasRefDesc	itsRef
TableMeasType	itsMeasType
Vector< Unit >	itsUnits

Detailed Description

Definition of a Measure in a Table.

Intended use:

Internal

Review Status

Reviewed By:: Bob Garwood
Date Reviewed:: 1999/12/23
Test programs:: tTableMeasures

Prerequisite

Measures
Tables
TableMeasDesc

Synopsis

Abstract base class for TableMeasDesc.

Example

See class TableMeasDesc .

Motivation

Creating the required keyword for the definition of a Measure in a Table is somewhat complicated. This class assists in that process.

Thrown Exceptions

AipsError during reconstruction if the column doesn't contain a MEASINFO record.
AipsError during reconstruction if the column has a MEASINFO but it Measure type is invalid.

Definition at line 93 of file TableMeasDescBase.h.

Constructor & Destructor Documentation

casacore::TableMeasDescBase::TableMeasDescBase ( )

Null constructor.

casacore::TableMeasDescBase::TableMeasDescBase	(	const TableMeasValueDesc &	,
		const TableMeasRefDesc &
	)

Constructor with value and reference descriptors.

Note that setMeasType is always called by the derived class.

casacore::TableMeasDescBase::TableMeasDescBase ( const TableMeasDescBase & that )

Copy constructor.

virtual casacore::TableMeasDescBase::~TableMeasDescBase ( ) [virtual]

Member Function Documentation

virtual TableMeasDescBase* casacore::TableMeasDescBase::clone ( ) const [virtual]

Clone the object.

Reimplemented in casacore::TableMeasDesc< M >.

const String& casacore::TableMeasDescBase::columnName ( ) const [inline]

Get the name of the underlying column.

Definition at line 125 of file TableMeasDescBase.h.

References casacore::TableMeasValueDesc::columnName(), and itsValue.

const Measure& casacore::TableMeasDescBase::getOffset ( ) const [inline]

Returns a reference to the offset.

Definition at line 164 of file TableMeasDescBase.h.

References casacore::TableMeasRefDesc::getOffset(), and itsRef.

uInt casacore::TableMeasDescBase::getRefCode ( ) const [inline]

Return the reference code.

Definition at line 129 of file TableMeasDescBase.h.

References casacore::TableMeasRefDesc::getRefCode(), and itsRef.

const TableMeasRefDesc& casacore::TableMeasDescBase::getRefDesc ( ) const [inline]

Returns a reference to its measure reference descriptor.

Definition at line 142 of file TableMeasDescBase.h.

References itsRef.

const Vector<Unit>& casacore::TableMeasDescBase::getUnits ( ) const [inline]

Return the Units of the Measure values.

Definition at line 181 of file TableMeasDescBase.h.

References itsUnits.

static Bool casacore::TableMeasDescBase::hasMeasures ( const TableColumn & column ) [static]

Does this column contain table measures?

Bool casacore::TableMeasDescBase::hasOffset ( ) const [inline]

Returns True if an offset has been defined.

Definition at line 151 of file TableMeasDescBase.h.

References casacore::TableMeasRefDesc::hasOffset(), and itsRef.

void casacore::TableMeasDescBase::initTabRef ( const MeasureHolder & measHolder ) [protected]

Set the initial reference codes and types in the table.

Bool casacore::TableMeasDescBase::isOffsetArray ( ) const [inline]

Returns True if the offset is variable and is stored in an ArrayMeasColumn, i.e., offsets are stored per element.

Definition at line 160 of file TableMeasDescBase.h.

References casacore::TableMeasRefDesc::isOffsetArray(), and itsRef.

Bool casacore::TableMeasDescBase::isOffsetVariable ( ) const [inline]

Returns True if the offset is variable.

Definition at line 155 of file TableMeasDescBase.h.

References casacore::TableMeasRefDesc::isOffsetVariable(), and itsRef.

Bool casacore::TableMeasDescBase::isRefCodeVariable ( ) const [inline]

Returns True if the reference varies per row.

Definition at line 133 of file TableMeasDescBase.h.

References casacore::TableMeasRefDesc::isRefCodeVariable(), and itsRef.

const String& casacore::TableMeasDescBase::offsetColumnName ( ) const [inline]

Get the name of the offset column.

Empty string is returned if no offset.

Definition at line 147 of file TableMeasDescBase.h.

References itsRef, and casacore::TableMeasRefDesc::offsetColumnName().

TableMeasDescBase& casacore::TableMeasDescBase::operator= ( const TableMeasDescBase & that )

Assignment operator.

Reimplemented in casacore::TableMeasDesc< M >.

static TableMeasDescBase* casacore::TableMeasDescBase::reconstruct	(	const Table &	tab,
		const String &	columnName
	)			`[static]`

Reconstructs the object for the given table and column name.

uInt casacore::TableMeasDescBase::refCode ( const String & refString ) const [inline]

Returns the reference code for this object given a string.

Throws an exception if the refString is invalid for this object.

Definition at line 173 of file TableMeasDescBase.h.

References itsMeasType, and casacore::TableMeasType::refCode().

const String& casacore::TableMeasDescBase::refColumnName ( ) const [inline]

Returns the name of the ref code column when the ref code is variable.

The null string is returned if the ref code is not variable.

Definition at line 138 of file TableMeasDescBase.h.

References casacore::TableMeasRefDesc::columnName(), and itsRef.

const String& casacore::TableMeasDescBase::refType ( uInt refCode ) const [inline]

Translates the refCode for the descriptors measure type.

Definition at line 177 of file TableMeasDescBase.h.

References itsMeasType, and casacore::TableMeasType::refType().

void casacore::TableMeasDescBase::resetOffset ( const Measure & offset ) [inline]

Definition at line 190 of file TableMeasDescBase.h.

References itsRef, and casacore::TableMeasRefDesc::resetOffset().

void casacore::TableMeasDescBase::resetRefCode ( uInt refCode ) [inline]

Reset the refCode, offset, or units.

It overwrites the value used when defining the TableMeasDesc. It is only possible if it was defined as fixed for the entire column.

Definition at line 188 of file TableMeasDescBase.h.

References itsRef, and casacore::TableMeasRefDesc::resetRefCode().

void casacore::TableMeasDescBase::resetUnits ( const Vector< Unit > & units )

void casacore::TableMeasDescBase::setMeasUnits	(	const Measure &	meas,
		const Vector< Quantum< Double > > &	val,
		const Vector< Unit > &	units
	)			`[protected]`