casacore
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::ROMSFreqOffsetColumns Class Reference

A class to provide easy read-only access to MSFreqOffset columns. More...

#include <MSFreqOffColumns.h>

Public Member Functions

 ROMSFreqOffsetColumns (const MSFreqOffset &msFreqOffset)
 Create a columns object that accesses the data in the specified Table. More...
 
 ~ROMSFreqOffsetColumns ()
 The destructor does nothing special. More...
 
Bool isNull () const
 Is this object defined? (MSFreqOffset table is optional) More...
 
const ROScalarColumn< Int > & antenna1 () const
 Access to columns. More...
 
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
 
uInt nrow () const
 Convenience function that returns the number of rows in any of the columns. More...
 

Protected Member Functions

 ROMSFreqOffsetColumns ()
 
void attach (const MSFreqOffset &msFreqOffset)
 

Private Member Functions

 ROMSFreqOffsetColumns (const ROMSFreqOffsetColumns &)
 
ROMSFreqOffsetColumnsoperator= (const ROMSFreqOffsetColumns &)
 

Private Attributes

Bool isNull_p
 
ROScalarColumn< Intantenna1_p
 
ROScalarColumn< Intantenna2_p
 
ROScalarColumn< IntfeedId_p
 
ROScalarColumn< Doubleinterval_p
 
ROScalarColumn< Doubleoffset_p
 
ROScalarColumn< IntspectralWindowId_p
 
ROScalarColumn< Doubletime_p
 
ROScalarMeasColumn< MEpochtimeMeas_p
 
ROScalarQuantColumn< DoubleintervalQuant_p
 
ROScalarQuantColumn< DoubleoffsetQuant_p
 
ROScalarQuantColumn< DoubletimeQuant_p
 

Detailed Description

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

Intended use:

Public interface

Review Status

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

Prerequisite

Etymology

ROMSFreqOffsetColumns stands for Read-Only MeasurementSet FreqOffset Table columns.

Synopsis

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.

Definition at line 77 of file MSFreqOffColumns.h.

Constructor & Destructor Documentation

casacore::ROMSFreqOffsetColumns::ROMSFreqOffsetColumns ( const MSFreqOffset msFreqOffset)

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

casacore::ROMSFreqOffsetColumns::~ROMSFreqOffsetColumns ( )

The destructor does nothing special.

casacore::ROMSFreqOffsetColumns::ROMSFreqOffsetColumns ( )
protected

Referenced by nrow().

casacore::ROMSFreqOffsetColumns::ROMSFreqOffsetColumns ( const ROMSFreqOffsetColumns )
private

Member Function Documentation

const ROScalarColumn<Int>& casacore::ROMSFreqOffsetColumns::antenna1 ( ) const
inline

Access to columns.

Definition at line 91 of file MSFreqOffColumns.h.

References antenna1_p.

Referenced by casacore::MSFreqOffsetColumns::antenna1().

const ROScalarColumn<Int>& casacore::ROMSFreqOffsetColumns::antenna2 ( ) const
inline

Definition at line 92 of file MSFreqOffColumns.h.

References antenna2_p.

Referenced by casacore::MSFreqOffsetColumns::antenna2().

void casacore::ROMSFreqOffsetColumns::attach ( const MSFreqOffset msFreqOffset)
protected
const ROScalarColumn<Int>& casacore::ROMSFreqOffsetColumns::feedId ( ) const
inline

Definition at line 93 of file MSFreqOffColumns.h.

References feedId_p.

Referenced by casacore::MSFreqOffsetColumns::feedId().

const ROScalarColumn<Double>& casacore::ROMSFreqOffsetColumns::interval ( ) const
inline

Definition at line 94 of file MSFreqOffColumns.h.

References interval_p.

Referenced by casacore::MSFreqOffsetColumns::interval().

const ROScalarQuantColumn<Double>& casacore::ROMSFreqOffsetColumns::intervalQuant ( ) const
inline

Definition at line 95 of file MSFreqOffColumns.h.

References intervalQuant_p.

Referenced by casacore::MSFreqOffsetColumns::intervalQuant().

Bool casacore::ROMSFreqOffsetColumns::isNull ( ) const
inline

Is this object defined? (MSFreqOffset table is optional)

Definition at line 87 of file MSFreqOffColumns.h.

References isNull_p.

Referenced by nrow().

uInt casacore::ROMSFreqOffsetColumns::nrow ( ) const
inline

Convenience function that returns the number of rows in any of the columns.

Returns zero if the object is null.

Definition at line 109 of file MSFreqOffColumns.h.

References antenna1_p, attach(), isNull(), operator=(), and ROMSFreqOffsetColumns().

const ROScalarColumn<Double>& casacore::ROMSFreqOffsetColumns::offset ( ) const
inline

Definition at line 97 of file MSFreqOffColumns.h.

References offset_p.

Referenced by casacore::MSFreqOffsetColumns::offset().

const ROScalarQuantColumn<Double>& casacore::ROMSFreqOffsetColumns::offsetQuant ( ) const
inline

Definition at line 98 of file MSFreqOffColumns.h.

References offsetQuant_p.

Referenced by casacore::MSFreqOffsetColumns::offsetQuant().

ROMSFreqOffsetColumns& casacore::ROMSFreqOffsetColumns::operator= ( const ROMSFreqOffsetColumns )
private
const ROScalarColumn<Int>& casacore::ROMSFreqOffsetColumns::spectralWindowId ( ) const
inline

Definition at line 100 of file MSFreqOffColumns.h.

References spectralWindowId_p.

Referenced by casacore::MSFreqOffsetColumns::spectralWindowId().

const ROScalarColumn<Double>& casacore::ROMSFreqOffsetColumns::time ( ) const
inline

Definition at line 102 of file MSFreqOffColumns.h.

References time_p.

Referenced by casacore::MSFreqOffsetColumns::time().

const ROScalarMeasColumn<MEpoch>& casacore::ROMSFreqOffsetColumns::timeMeas ( ) const
inline

Definition at line 104 of file MSFreqOffColumns.h.

References timeMeas_p.

Referenced by casacore::MSFreqOffsetColumns::timeMeas().

const ROScalarQuantColumn<Double>& casacore::ROMSFreqOffsetColumns::timeQuant ( ) const
inline

Definition at line 103 of file MSFreqOffColumns.h.

References timeQuant_p.

Referenced by casacore::MSFreqOffsetColumns::timeQuant().

Member Data Documentation

ROScalarColumn<Int> casacore::ROMSFreqOffsetColumns::antenna1_p
private

Definition at line 129 of file MSFreqOffColumns.h.

Referenced by antenna1(), casacore::MSFreqOffsetColumns::antenna1(), and nrow().

ROScalarColumn<Int> casacore::ROMSFreqOffsetColumns::antenna2_p
private

Definition at line 130 of file MSFreqOffColumns.h.

Referenced by antenna2(), and casacore::MSFreqOffsetColumns::antenna2().

ROScalarColumn<Int> casacore::ROMSFreqOffsetColumns::feedId_p
private

Definition at line 131 of file MSFreqOffColumns.h.

Referenced by feedId(), and casacore::MSFreqOffsetColumns::feedId().

ROScalarColumn<Double> casacore::ROMSFreqOffsetColumns::interval_p
private

Definition at line 132 of file MSFreqOffColumns.h.

Referenced by interval(), and casacore::MSFreqOffsetColumns::interval().

ROScalarQuantColumn<Double> casacore::ROMSFreqOffsetColumns::intervalQuant_p
private
Bool casacore::ROMSFreqOffsetColumns::isNull_p
private

Definition at line 126 of file MSFreqOffColumns.h.

Referenced by isNull().

ROScalarColumn<Double> casacore::ROMSFreqOffsetColumns::offset_p
private

Definition at line 133 of file MSFreqOffColumns.h.

Referenced by offset(), and casacore::MSFreqOffsetColumns::offset().

ROScalarQuantColumn<Double> casacore::ROMSFreqOffsetColumns::offsetQuant_p
private

Definition at line 142 of file MSFreqOffColumns.h.

Referenced by offsetQuant(), and casacore::MSFreqOffsetColumns::offsetQuant().

ROScalarColumn<Int> casacore::ROMSFreqOffsetColumns::spectralWindowId_p
private
ROScalarColumn<Double> casacore::ROMSFreqOffsetColumns::time_p
private

Definition at line 135 of file MSFreqOffColumns.h.

Referenced by time(), and casacore::MSFreqOffsetColumns::time().

ROScalarMeasColumn<MEpoch> casacore::ROMSFreqOffsetColumns::timeMeas_p
private

Definition at line 138 of file MSFreqOffColumns.h.

Referenced by timeMeas(), and casacore::MSFreqOffsetColumns::timeMeas().

ROScalarQuantColumn<Double> casacore::ROMSFreqOffsetColumns::timeQuant_p
private

Definition at line 143 of file MSFreqOffColumns.h.

Referenced by timeQuant(), and casacore::MSFreqOffsetColumns::timeQuant().


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