casa::ROScalarQuantColumn< T > Class Template Reference
[TableMeasures]

#include <ScalarQuantColumn.h>

Inheritance diagram for casa::ROScalarQuantColumn< T >:

[legend]Collaboration diagram for casa::ROScalarQuantColumn< T >:

[legend]List of all members.

Detailed Description

template<class T>
class casa::ROScalarQuantColumn< T >

Provides read-only access to Scalar Quantum Columns in Tables.

Intended use:

Part of API

Review Status

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

Prerequisite

Synopsis

The ROScalarQuantColumn class provides read-only access to quanta stored in a scalar Quantum Table column. The Quantum column should already exist in the table and would have been defined by means of a TableQuantumDesc object . In addition, for a ROScalarQuantColumn object to be useful the column should contain Quanta. Inserting Quanta into a column requires the use of a ScalarQuantColumn object.

A ROScalarQuantColumn object is used much in the same way as a ROScalarColumn object.

Quantum Units

Quanta retrieved from the column will normally have the Unit that was specified when the Quantum column was defined. However, it is possible to override the default column Unit by supplying a Unit in the ROScalarQuantColumn constructor. When constructed in this fashion the retrieved Quanta will by default be retrieved in this unit, i.e. they will by default be converted to this unit.
By giving a unit (as a Unit or Quantum object) to a get function, the data can be retrieved in another unit than the default.

Example

        Quantum<Double> q(5.3, "keV");
        // "QuantScalar" has previously been defined as a Quantum column
        // by means of a TableQuantumDesc. This example assumes the column
        // already contains quanta.
        ROScalarQuantColumn<Double> qCol(qtab, "QuantScalar");
        // return and print quanta as stored in the column
        for (i = 0; i < qtab.nrow(); i++) {
            cout << qCol(i) << endl;
        }
        // The following retrieves and converts the quanta to GHz.  They
        // are then divided by the Quantum constant QC::h (Planck).
        for (i=0; i < qtab.nrow(); i++) {
            cout << (qCol(i, "GHz"))/(QC::h);
        }

Motivation

Add support for Quanta in the Tables system.

Thrown Exceptions

TableInvOper if the Table column is null.

To Do

Functions like getColumn

Definition at line 121 of file ScalarQuantColumn.h.

Public Member Functions

ROScalarQuantColumn ()

The default constructor creates a null object.

ROScalarQuantColumn (const Table &tab, const String &columnName)

Create the ROScalarQuantColumn from the specified table and column name.

ROScalarQuantColumn (const Table &tab, const String &columnName, const Unit &)

Create the ROScalarQuantColumn from the specified table and column name.

ROScalarQuantColumn (const ROScalarQuantColumn< T > &that)

Copy constructor (copy semantics).

~ROScalarQuantColumn ()

void reference (const ROScalarQuantColumn< T > &that)

Change the reference to another column.

Bool isUnitVariable () const

Test whether the Quantum column has variable units.

const String & getUnits () const

Returns the column's value for Units as a string.

Bool isNull () const

Test if the object is null.

void throwIfNull () const

Throw an exception if the object is null.

void attach (const Table &tab, const String &columnName)

Attach a column to the object.

void attach (const Table &tab, const String &columnName, const Unit &)

void get (uInt rownr, Quantum< T > &q) const

Get the quantum stored in the specified row.

void get (uInt rownr, Quantum< T > &q, const Unit &) const

Get the quantum in the specified row, converted to the given unit.

void get (uInt rownr, Quantum< T > &q, const Quantum< T > &other) const

Get the quantum in the specified row, converted to the unit in other.

Quantum< T > operator() (uInt rownr) const

Return the quantum stored in the specified row.

Quantum< T > operator() (uInt rownr, const Unit &) const

Return the quantum stored in the specified row, converted to the given unit.

Quantum< T > operator() (uInt rownr, const Quantum< T > &other) const

Return the quantum in the specified row, converted to the unit in other.

Protected Member Functions

const ROScalarColumn< String > * unitsCol () const

Get access to itsUnitsCol.

Protected Attributes

Unit itsUnit

Private Member Functions

ROScalarQuantColumn & operator= (const ROScalarQuantColumn< T > &that)

Assignment makes no sense in a read only class.

Bool operator== (const ROScalarQuantColumn< T > &that)

Comparison is not defined, since its semantics are unclear.

void init (const Table &tab, const String &columnName)

Initialize the ROScalarQuantColumn from the specified table and column.

void cleanUp ()

Deletes allocated memory etc.

void getData (uInt rownr, Quantum< T > &q) const

Get the data without possible conversion.

Private Attributes

ROScalarColumn< T > * itsDataCol

ROScalarColumn< String > * itsUnitsCol

Unit itsUnitOut

Bool itsConvOut

Constructor & Destructor Documentation

template<class T>

casa::ROScalarQuantColumn< T >::ROScalarQuantColumn ( )

The default constructor creates a null object.

It is useful for creating arrays of ROScalarQuantColumn objects. Attempting to use a null object will produce a segmentation fault so care needs to be taken to initialise the objects by using the attach() member before any attempt is made to use the object. The isNull() member can be used to test if a ROScalarQuantColumn object is null.

template<class T>

casa::ROScalarQuantColumn< T >::ROScalarQuantColumn	(	const Table &	tab,
		const String &	columnName
	)

Create the ROScalarQuantColumn from the specified table and column name.

The default unit for data retrieved is the unit in which they were stored.

template<class T>

casa::ROScalarQuantColumn< T >::ROScalarQuantColumn	(	const Table &	tab,
		const String &	columnName,
		const Unit &
	)

Create the ROScalarQuantColumn from the specified table and column name.

The default unit for data retrieved is the given unit (the data is converted as needed).

template<class T>

casa::ROScalarQuantColumn< T >::ROScalarQuantColumn ( const ROScalarQuantColumn< T > & that )

Copy constructor (copy semantics).

template<class T>

casa::ROScalarQuantColumn< T >::~ROScalarQuantColumn ( )

Member Function Documentation

template<class T>

void casa::ROScalarQuantColumn< T >::reference ( const ROScalarQuantColumn< T > & that )

Change the reference to another column.

template<class T>

void casa::ROScalarQuantColumn< T >::attach	(	const Table &	tab,
		const String &	columnName
	)

Attach a column to the object.

Optionally supply a default unit which has the same meaning as the constructor unit argument.

template<class T>

void casa::ROScalarQuantColumn< T >::attach	(	const Table &	tab,
		const String &	columnName,
		const Unit &
	)

template<class T>

void casa::ROScalarQuantColumn< T >::get	(	uInt	rownr,
		Quantum< T > &	q
	)			const

Get the quantum stored in the specified row.

template<class T>

void casa::ROScalarQuantColumn< T >::get	(	uInt	rownr,
		Quantum< T > &	q,
		const Unit &
	)			const

Get the quantum in the specified row, converted to the given unit.

template<class T>

void casa::ROScalarQuantColumn< T >::get	(	uInt	rownr,
		Quantum< T > &	q,
		const Quantum< T > &	other
	)			const

Get the quantum in the specified row, converted to the unit in other.

template<class T>

Quantum<T> casa::ROScalarQuantColumn< T >::operator() ( uInt rownr ) const

Return the quantum stored in the specified row.

template<class T>

Quantum<T> casa::ROScalarQuantColumn< T >::operator()	(	uInt	rownr,
		const Unit &
	)			const

Return the quantum stored in the specified row, converted to the given unit.

template<class T>

Quantum<T> casa::ROScalarQuantColumn< T >::operator()	(	uInt	rownr,
		const Quantum< T > &	other
	)			const

Return the quantum in the specified row, converted to the unit in other.

template<class T>

Bool casa::ROScalarQuantColumn< T >::isUnitVariable ( ) const [inline]

Test whether the Quantum column has variable units.

Definition at line 178 of file ScalarQuantColumn.h.

template<class T>

const String& casa::ROScalarQuantColumn< T >::getUnits ( ) const [inline]

Returns the column's value for Units as a string.

An empty string is returned if the column has variable units.

Definition at line 183 of file ScalarQuantColumn.h.

template<class T>

Bool casa::ROScalarQuantColumn< T >::isNull ( ) const [inline]

Test if the object is null.

Definition at line 187 of file ScalarQuantColumn.h.

template<class T>

void casa::ROScalarQuantColumn< T >::throwIfNull ( ) const

Throw an exception if the object is null.

template<class T>

const ROScalarColumn<String>* casa::ROScalarQuantColumn< T >::unitsCol ( ) const [inline, protected]

Get access to itsUnitsCol.

Definition at line 198 of file ScalarQuantColumn.h.

template<class T>

ROScalarQuantColumn& casa::ROScalarQuantColumn< T >::operator= ( const ROScalarQuantColumn< T > & that ) [private]

Assignment makes no sense in a read only class.

Declaring this operator private makes it unusable.

template<class T>

Bool casa::ROScalarQuantColumn< T >::operator== ( const ROScalarQuantColumn< T > & that ) [private]

Comparison is not defined, since its semantics are unclear.

template<class T>

void casa::ROScalarQuantColumn< T >::init	(	const Table &	tab,
		const String &	columnName
	)			`[private]`

Initialize the ROScalarQuantColumn from the specified table and column.

template<class T>

void casa::ROScalarQuantColumn< T >::cleanUp ( ) [private]

Deletes allocated memory etc.

Called by destructor and any member which needs to reallocate data.

template<class T>

void casa::ROScalarQuantColumn< T >::getData	(	uInt	rownr,
		Quantum< T > &	q
	)			const `[private]`

Get the data without possible conversion.

Member Data Documentation

template<class T>

Unit casa::ROScalarQuantColumn< T >::itsUnit [protected]

Definition at line 195 of file ScalarQuantColumn.h.

Referenced by casa::ROScalarQuantColumn< float >::getUnits().

template<class T>

ROScalarColumn<T>* casa::ROScalarQuantColumn< T >::itsDataCol [private]

Definition at line 203 of file ScalarQuantColumn.h.

Referenced by casa::ROScalarQuantColumn< float >::isNull().

template<class T>

ROScalarColumn<String>* casa::ROScalarQuantColumn< T >::itsUnitsCol [private]

Definition at line 205 of file ScalarQuantColumn.h.

Referenced by casa::ROScalarQuantColumn< float >::isUnitVariable(), and casa::ROScalarQuantColumn< float >::unitsCol().

template<class T>

Unit casa::ROScalarQuantColumn< T >::itsUnitOut [private]

Definition at line 207 of file ScalarQuantColumn.h.

template<class T>

Bool casa::ROScalarQuantColumn< T >::itsConvOut [private]

Definition at line 209 of file ScalarQuantColumn.h.

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

measures/implement/TableMeasures/ScalarQuantColumn.h

Generated on Mon Sep 1 22:46:02 2008 for NRAOCASA by

1.5.1


Public Member Functions
	ROScalarQuantColumn ()
	The default constructor creates a null object.
	ROScalarQuantColumn (const Table &tab, const String &columnName)
	Create the ROScalarQuantColumn from the specified table and column name.
	ROScalarQuantColumn (const Table &tab, const String &columnName, const Unit &)
	Create the ROScalarQuantColumn from the specified table and column name.
	ROScalarQuantColumn (const ROScalarQuantColumn< T > &that)
	Copy constructor (copy semantics).
	~ROScalarQuantColumn ()
void	reference (const ROScalarQuantColumn< T > &that)
	Change the reference to another column.
Bool	isUnitVariable () const
	Test whether the Quantum column has variable units.
const String &	getUnits () const
	Returns the column's value for Units as a string.
Bool	isNull () const
	Test if the object is null.
void	throwIfNull () const
	Throw an exception if the object is null.

void	attach (const Table &tab, const String &columnName)
	Attach a column to the object.
void	attach (const Table &tab, const String &columnName, const Unit &)

void	get (uInt rownr, Quantum< T > &q) const
	Get the quantum stored in the specified row.
void	get (uInt rownr, Quantum< T > &q, const Unit &) const
	Get the quantum in the specified row, converted to the given unit.
void	get (uInt rownr, Quantum< T > &q, const Quantum< T > &other) const
	Get the quantum in the specified row, converted to the unit in other.

Quantum< T >	operator() (uInt rownr) const
	Return the quantum stored in the specified row.
Quantum< T >	operator() (uInt rownr, const Unit &) const
	Return the quantum stored in the specified row, converted to the given unit.
Quantum< T >	operator() (uInt rownr, const Quantum< T > &other) const
	Return the quantum in the specified row, converted to the unit in other.
Protected Member Functions
const ROScalarColumn< String > *	unitsCol () const
	Get access to itsUnitsCol.
Protected Attributes
Unit	itsUnit
Private Member Functions
ROScalarQuantColumn &	operator= (const ROScalarQuantColumn< T > &that)
	Assignment makes no sense in a read only class.
Bool	operator== (const ROScalarQuantColumn< T > &that)
	Comparison is not defined, since its semantics are unclear.
void	init (const Table &tab, const String &columnName)
	Initialize the ROScalarQuantColumn from the specified table and column.
void	cleanUp ()
	Deletes allocated memory etc.
void	getData (uInt rownr, Quantum< T > &q) const
	Get the data without possible conversion.
Private Attributes
ROScalarColumn< T > *	itsDataCol
ROScalarColumn< String > *	itsUnitsCol
Unit	itsUnitOut
Bool	itsConvOut

casa::ROScalarQuantColumn< T > Class Template Reference [TableMeasures]

Detailed Description

template<class T> class casa::ROScalarQuantColumn< T >

Intended use:

Review Status

Prerequisite

Synopsis

Quantum Units

Example

Motivation

Thrown Exceptions

To Do

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

casa::ROScalarQuantColumn< T > Class Template Reference
[TableMeasures]

template<class T>
class casa::ROScalarQuantColumn< T >