MSFreqOffColumns.h

This class provides read-only 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 ROMSColumns for an example.

Motivation

See MSColumns for the motivation.

Member Description

ROMSFreqOffsetColumns(const MSFreqOffset& msFreqOffset)

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

~ROMSFreqOffsetColumns()

The destructor does nothing special

Bool isNull() const

Is this object defined? (MSFreqOffset table is optional)

const ROScalarColumn<Int>& antenna1() const
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

Access to columns

uInt nrow() const

Convenience function that returns the number of rows in any of the columns. Returns zero if the object is null.

ROMSFreqOffsetColumns()

void attach(const MSFreqOffset& msFreqOffset)

ROMSFreqOffsetColumns(const ROMSFreqOffsetColumns&)

ROMSFreqOffsetColumns& operator=(const ROMSFreqOffsetColumns&)

class MSFreqOffsetColumns: public ROMSFreqOffsetColumns

Interface

Public Members

MSFreqOffsetColumns(MSFreqOffset& msFreqOffset)

~MSFreqOffsetColumns()

ScalarColumn<Int>& antenna1()

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

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

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

Protected Members

MSFreqOffsetColumns()

void attach(MSFreqOffset& msFreqOffset)

Private Members

MSFreqOffsetColumns(const MSFreqOffsetColumns&)

MSFreqOffsetColumns& operator=(const MSFreqOffsetColumns&)

Description

Review Status

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

Prerequisite

MSFreqOffset
ScalarColumn

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.

Member Description

MSFreqOffsetColumns(MSFreqOffset& msFreqOffset)

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

~MSFreqOffsetColumns()

The destructor does nothing special

ScalarColumn<Int>& antenna1()
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()

Read-write access to required columns

const ROScalarColumn<Int>& antenna1() const
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

Read-only access to required columns

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

set the epoch type for the TIME column.

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.