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

#include <TableMeasRefDesc.h>

Public Types
typedef void	TypesFunc (Vector< String > &types, Vector< uInt > &codes, const MeasureHolder &)
	Set the function used to get all reference codes for a MeasureHolder. More...

Public Member Functions
	TableMeasRefDesc (uInt refCode=0)
	Define a fixed MeasRef by supplying its reference code Optionally a Measure offset can be specified. More...

	TableMeasRefDesc (uInt refCode, const TableMeasOffsetDesc &)

	TableMeasRefDesc (const TableDesc &, const String &column)
	Define a variable reference by supplying the name of the column in which the reference is to be stored. More...

	TableMeasRefDesc (const TableDesc &, const String &column, const TableMeasOffsetDesc &)

	TableMeasRefDesc (const TableRecord &measInfo, const Table &, const MeasureHolder &measHolder, const TableMeasDescBase &)
	Reconstruct the object from the MEASINFO record. More...

	TableMeasRefDesc (const TableMeasRefDesc &that)
	Copy constructor (copy semantics) More...

	~TableMeasRefDesc ()

TableMeasRefDesc &	operator= (const TableMeasRefDesc &that)
	Assignment operator (copy semantics). More...

uInt	getRefCode () const
	Return the reference code. More...

Bool	isRefCodeVariable () const
	Is the reference variable? More...

const String &	columnName () const
	Return the name of its variable reference code column. More...

Bool	isRefCodeColumnInt () const
	Is the reference code variable and stored in an integer column? More...

Bool	hasRefTab () const
	Do the keywords contain the reference codes and types. More...

Bool	hasOffset () const
	Returns True if the reference has an offset. More...

Bool	isOffsetVariable () const
	Returns True if the offset is variable. More...

Bool	isOffsetArray () const
	Returns True is the offset is variable and it is an ArrayMeasColumn. More...

const Measure &	getOffset () const
	Return the fixed Measure offset. More...

const String &	offsetColumnName () const
	Return the name of the Measure offset column. More...

void	resetRefCode (uInt refCode)
	Reset the refCode or offset. More...

void	resetOffset (const Measure &offset)

void	write (TableDesc &, TableRecord &measInfo, const TableMeasDescBase &)
	Make the Measure value descriptor persistent. More...

void	write (Table &, TableRecord &measInfo, const TableMeasDescBase &)

void	initTabRef (const MeasureHolder &measHolder)
	Initialize the table reference codes and types and the maps (mapping a code onto itself). More...

uInt	tab2cur (uInt tabRefCode) const
	Reference codes can be persistent in tables. More...

uInt	cur2tab (uInt curRefCode) const

Static Public Member Functions
static void	setTypesFunc (TypesFunc *func)

static void	defaultTypesFunc (Vector< String > &types, Vector< uInt > &codes, const MeasureHolder &)

Static Public Attributes
static TypesFunc *	theirTypesFunc

Private Member Functions
void	initTabRefMap ()
	Fill the reference code mappings for table<->current. More...

void	fillTabRefMap (const MeasureHolder &measHolder)

uInt	fillMap (Block< Int > &f2t, const Vector< uInt > &codesf, const Vector< String > &typesf, Vector< uInt > &codest, Vector< String > &typest, Int maxnr)

void	writeKeys (TableRecord &measInfo, const TableMeasDescBase &measDesc)
	Write the actual keywords. More...

void	checkColumn (const TableDesc &td)
	Throw an exception if the column doesn't exist or is of the wrong type. More...

Private Attributes
uInt	itsRefCode

String	itsColumn
	The name of column containing its variable references. More...

Bool	itsRefCodeColInt
	Is the reference code column a string column? More...

Bool	itsHasRefTab
	Do the keywords contain the reference codes and types? More...

TableMeasOffsetDesc *	itsOffset

Vector< String >	itsTabRefTypes

Vector< uInt >	itsTabRefCodes

Block< Int >	itsTab2Cur

Block< Int >	itsCur2Tab

Detailed Description

Definition of a Measure Reference in a Table.

Intended use:

Public interface

Review Status

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

Prerequisite

Measures
Tables
TableMeasDesc

Synopsis

TableMeasRefDesc is a class for setting up the MeasRef component of a TableMeasDesc in the TableMeasures system. With the aid of a TableMeasRefDesc the following possibilities for defining a Measure column's reference exist:

a fixed, non-variable, reference code, where all Measures in a column are to have the same reference code.
a unique (and probably different) reference code stored in each row.
a unique reference code stored in each array element per (Array)column row.

For each of the above options an offset component can be specified along with a reference code. When a Measure offset is required a TableMeasOffsetDesc is supplied as an argument to the TableMeasRefDesc constructor. With references containing an offset component either component can be set to be variable or fixed independently of the other.

Tip: It is not necessary to specify a Reference when defining a Measure column; In such cases the Measures retrieved from the column will have the default reference for the type of Measure stored in the column;

A fixed reference code is trivially stored as part of the column keywords in the Measure column but a variable reference code requires its own column. A Scalar or Array column can be used dependent on your needs but its type must always be either Int or String. Note that it is legal to specify a Scalar reference column for use with an ArrayMeasColumn. In such cases a single reference code will be stored per array (row) of Measures. However, attempting to associate an Array column for references with a ScalarMeasColumn will generate an exception.
Note: Because the reference codes stored are the enums defined in the Measures classes, it is possible that they change over time; The type strings, however, wille never change; Therefore the reference codes and types valid at the time of the table creation, are stored in the column keywords if the reference codes are kept in an integer column;
This has only been added in March 2007, but is fully backward compatible; Older tables will get the codes and types stored when accessed for read/write;

Caution: When storing Measures into a Measure column with a fixed reference code the reference code component of the Measures stored is ignored;

Example

Simplest kind of TableMeasRefDesc (apart from not specifying one at all) is a fixed reference code. All Measures subsequently retrieved from the column will have the reference MEpoch::LAST.
// measure reference column

TableMeasRefDesc reference(MEpoch::LAST);
A variable reference code requires its own Int column.
// An int column for the variable references.

ScalarColumnDesc<Int> cdRefCol("refCol", "Measure reference column");

td.addColumn(cdRefCol);

..\.

// create the Measure reference descriptor

TableMeasRefDesc varRef(td, "refCol");
A fix Measure reference code with a fixed Offset
// Create the Offset descriptor

MEpoch offset(MVEpoch(MVTime(1996, 5, 17, (8+18./60.)/24.))

TableMeasOffsetDesc offsetDesc(offset);

// create the Measure reference descriptor

TableMeasRefDesc varRef(MEpoch::LAST, offsetDesc);

For an example of the use of a TableMeasRefDesc in the context of a full TableMeasDesc declaration 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 if the specified column doesn't exist or its type is not Int or String.

Definition at line 167 of file TableMeasRefDesc.h.

Member Typedef Documentation

typedef void casacore::TableMeasRefDesc::TypesFunc(Vector< String > &types, Vector< uInt > &codes, const MeasureHolder &)

Set the function used to get all reference codes for a MeasureHolder.

This is not really needed for normal practice, but makes it possible to add extra codes when testing.
The default function simply calls MeasureHolder.asMeasure.allTypes.

Definition at line 285 of file TableMeasRefDesc.h.

Constructor & Destructor Documentation

casacore::TableMeasRefDesc::TableMeasRefDesc ( uInt refCode = 0 )

explicit

Define a fixed MeasRef by supplying its reference code Optionally a Measure offset can be specified.

The reference code and offset should not need a reference frame.

casacore::TableMeasRefDesc::TableMeasRefDesc	(	uInt	refCode,
		const TableMeasOffsetDesc &
	)

casacore::TableMeasRefDesc::TableMeasRefDesc	(	const TableDesc &	,
		const String &	column
	)

Define a variable reference by supplying the name of the column in which the reference is to be stored.

Either an Int or String column can be specified. This determines how references are stored. Int columns are likely to be faster but storing references as Strings may be useful if there is a need to browse tables manually. Optionally supply a Measure offset. The reference code and offset should not need a reference frame.

casacore::TableMeasRefDesc::TableMeasRefDesc	(	const TableDesc &	,
		const String &	column,
		const TableMeasOffsetDesc &
	)

casacore::TableMeasRefDesc::TableMeasRefDesc	(	const TableRecord &	measInfo,
		const Table &	,
		const MeasureHolder &	measHolder,
		const TableMeasDescBase &
	)

Reconstruct the object from the MEASINFO record.

Not useful for the public.

casacore::TableMeasRefDesc::TableMeasRefDesc ( const TableMeasRefDesc & that )

Copy constructor (copy semantics)

casacore::TableMeasRefDesc::~TableMeasRefDesc ( )

Member Function Documentation

void casacore::TableMeasRefDesc::checkColumn ( const TableDesc & td )

private

Throw an exception if the column doesn't exist or is of the wrong type.

const String& casacore::TableMeasRefDesc::columnName ( ) const

inline

Return the name of its variable reference code column.

Definition at line 216 of file TableMeasRefDesc.h.

References itsColumn.

Referenced by casacore::TableMeasDescBase::refColumnName().

uInt casacore::TableMeasRefDesc::cur2tab ( uInt curRefCode ) const

static void casacore::TableMeasRefDesc::defaultTypesFunc	(	Vector< String > &	types,
		Vector< uInt > &	codes,
		const MeasureHolder &
	)

static

uInt casacore::TableMeasRefDesc::fillMap	(	Block< Int > &	f2t,
		const Vector< uInt > &	codesf,
		const Vector< String > &	typesf,
		Vector< uInt > &	codest,
		Vector< String > &	typest,
		Int	maxnr
	)

private

void casacore::TableMeasRefDesc::fillTabRefMap ( const MeasureHolder & measHolder )

private

const Measure& casacore::TableMeasRefDesc::getOffset ( ) const

inline

Return the fixed Measure offset.

It does not test if the offset is defined; hasOffset() should be used for that purpose.

Definition at line 243 of file TableMeasRefDesc.h.

References casacore::TableMeasOffsetDesc::getOffset(), and itsOffset.

Referenced by casacore::TableMeasDescBase::getOffset().

uInt casacore::TableMeasRefDesc::getRefCode ( ) const

inline

Return the reference code.

Definition at line 208 of file TableMeasRefDesc.h.

References itsRefCode.

Referenced by casacore::TableMeasDescBase::getRefCode().

Bool casacore::TableMeasRefDesc::hasOffset ( ) const

inline

Returns True if the reference has an offset.

Definition at line 229 of file TableMeasRefDesc.h.

References itsOffset.

Referenced by casacore::TableMeasDescBase::hasOffset().

Bool casacore::TableMeasRefDesc::hasRefTab ( ) const

inline

Do the keywords contain the reference codes and types.

For old tables this might not be the case.

Definition at line 225 of file TableMeasRefDesc.h.

References itsHasRefTab.

void casacore::TableMeasRefDesc::initTabRef ( const MeasureHolder & measHolder )

Initialize the table reference codes and types and the maps (mapping a code onto itself).

void casacore::TableMeasRefDesc::initTabRefMap ( )

private

Fill the reference code mappings for table<->current.

Bool casacore::TableMeasRefDesc::isOffsetArray ( ) const

inline

Returns True is the offset is variable and it is an ArrayMeasColumn.

Definition at line 237 of file TableMeasRefDesc.h.

References casacore::False, casacore::TableMeasOffsetDesc::isArray(), and itsOffset.

Referenced by casacore::TableMeasDescBase::isOffsetArray().

Bool casacore::TableMeasRefDesc::isOffsetVariable ( ) const

inline

Returns True if the offset is variable.

Definition at line 233 of file TableMeasRefDesc.h.

References casacore::False, casacore::TableMeasOffsetDesc::isVariable(), and itsOffset.

Referenced by casacore::TableMeasDescBase::isOffsetVariable().

Bool casacore::TableMeasRefDesc::isRefCodeColumnInt ( ) const

inline

Is the reference code variable and stored in an integer column?

Definition at line 220 of file TableMeasRefDesc.h.

References itsRefCodeColInt.

Bool casacore::TableMeasRefDesc::isRefCodeVariable ( ) const

inline

Is the reference variable?

Definition at line 212 of file TableMeasRefDesc.h.

References casacore::String::empty(), and itsColumn.

Referenced by casacore::TableMeasDescBase::isRefCodeVariable().

const String& casacore::TableMeasRefDesc::offsetColumnName ( ) const

inline

Return the name of the Measure offset column.

An empty string is returned if no variable offset is used.

Definition at line 248 of file TableMeasRefDesc.h.

References casacore::TableMeasOffsetDesc::columnName(), and itsOffset.

Referenced by casacore::TableMeasDescBase::offsetColumnName().

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

Assignment operator (copy semantics).

void casacore::TableMeasRefDesc::resetOffset ( const Measure & offset )

Referenced by casacore::TableMeasDescBase::resetOffset().

void casacore::TableMeasRefDesc::resetRefCode ( uInt refCode )

Reset the refCode or offset.

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

Referenced by casacore::TableMeasDescBase::resetRefCode().

static void casacore::TableMeasRefDesc::setTypesFunc ( TypesFunc * func )

inlinestatic

Definition at line 287 of file TableMeasRefDesc.h.

References theirTypesFunc.

uInt casacore::TableMeasRefDesc::tab2cur ( uInt tabRefCode ) const

Reference codes can be persistent in tables.

Because their enum values can change, a mapping of current table to table value is maintained. The mapping is created using their never-changing string representations. These functions convert current refcode to and from table refcode.

void casacore::TableMeasRefDesc::write	(	TableDesc &	,
		TableRecord &	measInfo,
		const TableMeasDescBase &
	)

Make the Measure value descriptor persistent.

Normally would not be called by the user directly.

void casacore::TableMeasRefDesc::write	(	Table &	,
		TableRecord &	measInfo,
		const TableMeasDescBase &
	)

void casacore::TableMeasRefDesc::writeKeys	(	TableRecord &	measInfo,
		const TableMeasDescBase &	measDesc
	)

private

Write the actual keywords.

Member Data Documentation

String casacore::TableMeasRefDesc::itsColumn

private

The name of column containing its variable references.

Definition at line 297 of file TableMeasRefDesc.h.

Referenced by columnName(), and isRefCodeVariable().

Block<Int> casacore::TableMeasRefDesc::itsCur2Tab

private

Definition at line 312 of file TableMeasRefDesc.h.

Bool casacore::TableMeasRefDesc::itsHasRefTab

private

Do the keywords contain the reference codes and types?

Definition at line 301 of file TableMeasRefDesc.h.

Referenced by hasRefTab().

TableMeasOffsetDesc* casacore::TableMeasRefDesc::itsOffset

private

Definition at line 303 of file TableMeasRefDesc.h.

Referenced by getOffset(), hasOffset(), isOffsetArray(), isOffsetVariable(), and offsetColumnName().

uInt casacore::TableMeasRefDesc::itsRefCode

private

Definition at line 295 of file TableMeasRefDesc.h.

Referenced by getRefCode().

Bool casacore::TableMeasRefDesc::itsRefCodeColInt

private

Is the reference code column a string column?

Definition at line 299 of file TableMeasRefDesc.h.

Referenced by isRefCodeColumnInt().

Block<Int> casacore::TableMeasRefDesc::itsTab2Cur

private

Definition at line 311 of file TableMeasRefDesc.h.

Vector<uInt> casacore::TableMeasRefDesc::itsTabRefCodes

private

Definition at line 308 of file TableMeasRefDesc.h.

Vector<String> casacore::TableMeasRefDesc::itsTabRefTypes

private

Definition at line 307 of file TableMeasRefDesc.h.

TypesFunc* casacore::TableMeasRefDesc::theirTypesFunc

static

Definition at line 291 of file TableMeasRefDesc.h.

Referenced by setTypesFunc().

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

casa/casacore/measures/TableMeasures/TableMeasRefDesc.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Intended use:

Review Status

Prerequisite

Synopsis

Example

Motivation

Thrown Exceptions

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation