casa::MSFreqOffsetColumns Class Reference
[MeasurementSets]

#include <MSFreqOffColumns.h>

Inheritance diagram for casa::MSFreqOffsetColumns:

[legend]Collaboration diagram for casa::MSFreqOffsetColumns:

[legend]List of all members.

Detailed Description

A class to provide easy read-write access to MSFreqOffset columns.

Intended use:

Part of API

Review Status

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

Prerequisite

Etymology

MSFreqOffsetColumns stands for MeasurementSet FreqOffset Table columns.

Synopsis

This class provides access to the columns in the MSFreqOffset Table, it does the declaration of all the Scalar and ArrayColumns with the correct types, so the application programmer doesn't have to worry about getting those right. There is an access function for every predefined column. Access to non-predefined columns will still have to be done with explicit declarations. See MSColumns for an example.

Motivation

See MSColumns for the motivation.

Constructor & Destructor Documentation

casa::MSFreqOffsetColumns::MSFreqOffsetColumns ( MSFreqOffset & msFreqOffset )

Create a columns object that accesses the data in the specified Table.

casa::MSFreqOffsetColumns::~MSFreqOffsetColumns ( )

The destructor does nothing special.

casa::MSFreqOffsetColumns::MSFreqOffsetColumns ( ) [protected]

casa::MSFreqOffsetColumns::MSFreqOffsetColumns ( const MSFreqOffsetColumns & ) [private]

Member Function Documentation

ScalarColumn<Int>& casa::MSFreqOffsetColumns::antenna1 ( ) [inline]

Read-write access to required columns.

Definition at line 189 of file MSFreqOffColumns.h.

References antenna1_p.

ScalarColumn<Int>& casa::MSFreqOffsetColumns::antenna2 ( ) [inline]

Definition at line 190 of file MSFreqOffColumns.h.

References antenna2_p.

ScalarColumn<Int>& casa::MSFreqOffsetColumns::feedId ( ) [inline]

Definition at line 191 of file MSFreqOffColumns.h.

References feedId_p.

ScalarColumn<Double>& casa::MSFreqOffsetColumns::interval ( ) [inline]

Definition at line 192 of file MSFreqOffColumns.h.

References interval_p.

ScalarQuantColumn<Double>& casa::MSFreqOffsetColumns::intervalQuant ( ) [inline]

Definition at line 193 of file MSFreqOffColumns.h.

References intervalQuant_p.

ScalarColumn<Double>& casa::MSFreqOffsetColumns::offset ( ) [inline]

Definition at line 194 of file MSFreqOffColumns.h.

References offset_p.

ScalarQuantColumn<Double>& casa::MSFreqOffsetColumns::offsetQuant ( ) [inline]

Definition at line 195 of file MSFreqOffColumns.h.

References offsetQuant_p.

ScalarColumn<Int>& casa::MSFreqOffsetColumns::spectralWindowId ( ) [inline]

Definition at line 196 of file MSFreqOffColumns.h.

References spectralWindowId_p.

ScalarColumn<Double>& casa::MSFreqOffsetColumns::time ( ) [inline]

Definition at line 197 of file MSFreqOffColumns.h.

References time_p.

ScalarQuantColumn<Double>& casa::MSFreqOffsetColumns::timeQuant ( ) [inline]

Definition at line 198 of file MSFreqOffColumns.h.

References timeQuant_p.

ScalarMeasColumn<MEpoch>& casa::MSFreqOffsetColumns::timeMeas ( ) [inline]

Definition at line 199 of file MSFreqOffColumns.h.

References timeMeas_p.

const ROScalarColumn<Int>& casa::MSFreqOffsetColumns::antenna1 ( ) const [inline]

Read-only access to required columns.

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 204 of file MSFreqOffColumns.h.

References casa::ROMSFreqOffsetColumns::antenna1().

const ROScalarColumn<Int>& casa::MSFreqOffsetColumns::antenna2 ( ) const [inline]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 206 of file MSFreqOffColumns.h.

References casa::ROMSFreqOffsetColumns::antenna2().

const ROScalarColumn<Int>& casa::MSFreqOffsetColumns::feedId ( ) const [inline]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 208 of file MSFreqOffColumns.h.

References casa::ROMSFreqOffsetColumns::feedId().

const ROScalarColumn<Double>& casa::MSFreqOffsetColumns::interval ( ) const [inline]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 210 of file MSFreqOffColumns.h.

References casa::ROMSFreqOffsetColumns::interval().

const ROScalarQuantColumn<Double>& casa::MSFreqOffsetColumns::intervalQuant ( ) const [inline]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 212 of file MSFreqOffColumns.h.

References casa::ROMSFreqOffsetColumns::intervalQuant().

const ROScalarColumn<Double>& casa::MSFreqOffsetColumns::offset ( ) const [inline]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 214 of file MSFreqOffColumns.h.

References casa::ROMSFreqOffsetColumns::offset().

const ROScalarQuantColumn<Double>& casa::MSFreqOffsetColumns::offsetQuant ( ) const [inline]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 216 of file MSFreqOffColumns.h.

References casa::ROMSFreqOffsetColumns::offsetQuant().

const ROScalarColumn<Int>& casa::MSFreqOffsetColumns::spectralWindowId ( ) const [inline]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 218 of file MSFreqOffColumns.h.

References casa::ROMSFreqOffsetColumns::spectralWindowId().

const ROScalarColumn<Double>& casa::MSFreqOffsetColumns::time ( ) const [inline]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 220 of file MSFreqOffColumns.h.

References casa::time().

const ROScalarQuantColumn<Double>& casa::MSFreqOffsetColumns::timeQuant ( ) const [inline]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 222 of file MSFreqOffColumns.h.

References casa::ROMSFreqOffsetColumns::timeQuant().

const ROScalarMeasColumn<MEpoch>& casa::MSFreqOffsetColumns::timeMeas ( ) const [inline]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 224 of file MSFreqOffColumns.h.

References casa::ROMSFreqOffsetColumns::timeMeas().

void casa::MSFreqOffsetColumns::setEpochRef	(	MEpoch::Types	ref,
		Bool	tableMustBeEmpty = `True`
	)

set the epoch type for the TIME column.

Tip: In principle this function can only be used if the table is empty, otherwise already written values may thereafter have an incorrect reference, offset, or unit. However, it is possible that part of the table gets written before these values are known. In that case the reference, offset, or units can be set by using a False tableMustBeEmpty argument.

void casa::MSFreqOffsetColumns::attach ( MSFreqOffset & msFreqOffset ) [protected]

MSFreqOffsetColumns& casa::MSFreqOffsetColumns::operator= ( const MSFreqOffsetColumns & ) [private]

Member Data Documentation

ScalarColumn<Int> casa::MSFreqOffsetColumns::antenna1_p [private]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 254 of file MSFreqOffColumns.h.

Referenced by antenna1().

ScalarColumn<Int> casa::MSFreqOffsetColumns::antenna2_p [private]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 255 of file MSFreqOffColumns.h.

Referenced by antenna2().

ScalarColumn<Int> casa::MSFreqOffsetColumns::feedId_p [private]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 256 of file MSFreqOffColumns.h.

Referenced by feedId().

ScalarColumn<Double> casa::MSFreqOffsetColumns::interval_p [private]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 257 of file MSFreqOffColumns.h.

Referenced by interval().

ScalarColumn<Double> casa::MSFreqOffsetColumns::offset_p [private]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 258 of file MSFreqOffColumns.h.

Referenced by offset().

ScalarColumn<Int> casa::MSFreqOffsetColumns::spectralWindowId_p [private]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 259 of file MSFreqOffColumns.h.

Referenced by spectralWindowId().

ScalarColumn<Double> casa::MSFreqOffsetColumns::time_p [private]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 260 of file MSFreqOffColumns.h.

Referenced by time().

ScalarMeasColumn<MEpoch> casa::MSFreqOffsetColumns::timeMeas_p [private]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 263 of file MSFreqOffColumns.h.

Referenced by timeMeas().

ScalarQuantColumn<Double> casa::MSFreqOffsetColumns::intervalQuant_p [private]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 266 of file MSFreqOffColumns.h.

Referenced by intervalQuant().

ScalarQuantColumn<Double> casa::MSFreqOffsetColumns::offsetQuant_p [private]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 267 of file MSFreqOffColumns.h.

Referenced by offsetQuant().

ScalarQuantColumn<Double> casa::MSFreqOffsetColumns::timeQuant_p [private]

Reimplemented from casa::ROMSFreqOffsetColumns.

Definition at line 268 of file MSFreqOffColumns.h.

Referenced by timeQuant().

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

ms/implement/MeasurementSets/MSFreqOffColumns.h

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

1.5.1


Public Member Functions
	MSFreqOffsetColumns (MSFreqOffset &msFreqOffset)
	Create a columns object that accesses the data in the specified Table.
	~MSFreqOffsetColumns ()
	The destructor does nothing special.
void	setEpochRef (MEpoch::Types ref, Bool tableMustBeEmpty=True)
	set the epoch type for the TIME column.

ScalarColumn< Int > &	antenna1 ()
	Read-write access to required columns.
ScalarColumn< Int > &	antenna2 ()
ScalarColumn< Int > &	feedId ()
ScalarColumn< Double > &	interval ()
ScalarQuantColumn< Double > &	intervalQuant ()
ScalarColumn< Double > &	offset ()
ScalarQuantColumn< Double > &	offsetQuant ()
ScalarColumn< Int > &	spectralWindowId ()
ScalarColumn< Double > &	time ()
ScalarQuantColumn< Double > &	timeQuant ()
ScalarMeasColumn< MEpoch > &	timeMeas ()

const ROScalarColumn< Int > &	antenna1 () const
	Read-only access to required columns.
const ROScalarColumn< Int > &	antenna2 () const
const ROScalarColumn< Int > &	feedId () const
const ROScalarColumn< Double > &	interval () const
const ROScalarQuantColumn< Double > &	intervalQuant () const
const ROScalarColumn< Double > &	offset () const
const ROScalarQuantColumn< Double > &	offsetQuant () const
const ROScalarColumn< Int > &	spectralWindowId () const
const ROScalarColumn< Double > &	time () const
const ROScalarQuantColumn< Double > &	timeQuant () const
const ROScalarMeasColumn< MEpoch > &	timeMeas () const
Protected Member Functions
	MSFreqOffsetColumns ()
void	attach (MSFreqOffset &msFreqOffset)
Private Member Functions
	MSFreqOffsetColumns (const MSFreqOffsetColumns &)
MSFreqOffsetColumns &	operator= (const MSFreqOffsetColumns &)
Private Attributes
ScalarColumn< Int >	antenna1_p
ScalarColumn< Int >	antenna2_p
ScalarColumn< Int >	feedId_p
ScalarColumn< Double >	interval_p
ScalarColumn< Double >	offset_p
ScalarColumn< Int >	spectralWindowId_p
ScalarColumn< Double >	time_p
ScalarMeasColumn< MEpoch >	timeMeas_p
ScalarQuantColumn< Double >	intervalQuant_p
ScalarQuantColumn< Double >	offsetQuant_p
ScalarQuantColumn< Double >	timeQuant_p

casa::MSFreqOffsetColumns Class Reference [MeasurementSets]

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Motivation

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

casa::MSFreqOffsetColumns Class Reference
[MeasurementSets]