MSDopplerColumns.h

Classes

ROMSDopplerColumns -- A class to provide easy read-only access to MSDoppler columns (full description)
MSDopplerColumns -- A class to provide easy read-write access to MSDoppler columns (full description)

class ROMSDopplerColumns

Interface

Public Members
ROMSDopplerColumns(const MSDoppler& msDoppler)
~ROMSDopplerColumns()
Bool isNull() const
const ROScalarColumn<Int>& dopplerId() const
const ROScalarColumn<Int>& sourceId() const
const ROScalarColumn<Int>& transitionId() const
const ROScalarColumn<Double>& velDef() const
const ROScalarQuantColumn<Double>& velDefQuant() const
const ROScalarMeasColumn<MDoppler>& velDefMeas() const
uInt nrow() const
Protected Members
ROMSDopplerColumns()
void attach(const MSDoppler& msDoppler)
Private Members
ROMSDopplerColumns(const ROMSDopplerColumns&)
ROMSDopplerColumns& operator=(const ROMSDopplerColumns&)

Description

Review Status

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

Prerequisite

Etymology

ROMSDopplerColumns stands for Read-Only MeasurementSet Doppler Table columns.

Synopsis

This class provides read-only access to the columns in the MSDoppler 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

ROMSDopplerColumns(const MSDoppler& msDoppler)

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

~ROMSDopplerColumns()

The destructor does nothing special

Bool isNull() const

Is this object defined? (MSDoppler table is optional)

const ROScalarColumn<Int>& dopplerId() const
const ROScalarColumn<Int>& sourceId() const
const ROScalarColumn<Int>& transitionId() const
const ROScalarColumn<Double>& velDef() const
const ROScalarQuantColumn<Double>& velDefQuant() const
const ROScalarMeasColumn<MDoppler>& velDefMeas() 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.

ROMSDopplerColumns()

void attach(const MSDoppler& msDoppler)

ROMSDopplerColumns(const ROMSDopplerColumns&)

ROMSDopplerColumns& operator=(const ROMSDopplerColumns&)


class MSDopplerColumns: public ROMSDopplerColumns

Interface

Public Members
MSDopplerColumns(MSDoppler& msDoppler)
~MSDopplerColumns()
ScalarColumn<Int>& dopplerId()
ScalarColumn<Int>& sourceId()
ScalarColumn<Int>& transitionId()
ScalarColumn<Double>& velDef()
ScalarQuantColumn<Double>& velDefQuant()
ScalarMeasColumn<MDoppler>& velDefMeas()
const ROScalarColumn<Int>& dopplerId() const
const ROScalarColumn<Int>& sourceId() const
const ROScalarColumn<Int>& transitionId() const
const ROScalarColumn<Double>& velDef() const
const ROScalarQuantColumn<Double>& velDefQuant() const
const ROScalarMeasColumn<MDoppler>& velDefMeas() const
void setVelDefRef(MDoppler::Types ref)
Protected Members
MSDopplerColumns()
void attach(MSDoppler& msDoppler)
Private Members
MSDopplerColumns(const MSDopplerColumns&)
MSDopplerColumns& operator=(const MSDopplerColumns&)

Description

Review Status

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

Prerequisite

Etymology

MSDopplerColumns stands for MeasurementSet Doppler Table columns.

Synopsis

This class provides access to the columns in the MSDoppler 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

MSDopplerColumns(MSDoppler& msDoppler)

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

~MSDopplerColumns()

The destructor does nothing special

ScalarColumn<Int>& dopplerId()
ScalarColumn<Int>& sourceId()
ScalarColumn<Int>& transitionId()
ScalarColumn<Double>& velDef()
ScalarQuantColumn<Double>& velDefQuant()
ScalarMeasColumn<MDoppler>& velDefMeas()

Read-write access to required columns

const ROScalarColumn<Int>& dopplerId() const
const ROScalarColumn<Int>& sourceId() const
const ROScalarColumn<Int>& transitionId() const
const ROScalarColumn<Double>& velDef() const
const ROScalarQuantColumn<Double>& velDefQuant() const
const ROScalarMeasColumn<MDoppler>& velDefMeas() const

Read-only access to required columns

void setVelDefRef(MDoppler::Types ref)

set the DOPPLER type for the VELDEF column.

MSDopplerColumns()

void attach(MSDoppler& msDoppler)

MSDopplerColumns(const MSDopplerColumns&)

MSDopplerColumns& operator=(const MSDopplerColumns&)