MSFlagCmdColumns.h

Classes

ROMSFlagCmdColumns -- A class to provide easy read-only access to MSFlagCmd columns (full description)
MSFlagCmdColumns -- A class to provide easy read-write access to MSFlagCmd columns (full description)

class ROMSFlagCmdColumns

Interface

Public Members
ROMSFlagCmdColumns(const MSFlagCmd& msFlagCmd)
~ROMSFlagCmdColumns()
const ROScalarColumn<Bool>& applied() const
const ROScalarColumn<String>& command() const
const ROScalarQuantColumn<Double>& intervalQuant() const
const ROScalarColumn<Double>& interval() const
const ROScalarColumn<Int>& level() const
const ROScalarColumn<String>& reason() const
const ROScalarColumn<Int>& severity() const
const ROScalarColumn<Double>& time() const
const ROScalarQuantColumn<Double>& timeQuant() const
const ROScalarMeasColumn<MEpoch>& timeMeas() const
const ROScalarColumn<String>& type() const
uInt nrow() const
Protected Members
ROMSFlagCmdColumns()
void attach(const MSFlagCmd& msFlagCmd)
Private Members
ROMSFlagCmdColumns(const ROMSFlagCmdColumns&)
ROMSFlagCmdColumns& operator=(const ROMSFlagCmdColumns&)

Description

Review Status

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

Prerequisite

Etymology

ROMSFlagCmdColumns stands for Read-Only MeasurementSet FlagCmd Table columns.

Synopsis

This class provides read-only access to the columns in the MSFlagCmd Table. It does the declaration of all the ScalarColumns 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

ROMSFlagCmdColumns(const MSFlagCmd& msFlagCmd)

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

~ROMSFlagCmdColumns()

The destructor does nothing special

const ROScalarColumn<Bool>& applied() const
const ROScalarColumn<String>& command() const
const ROScalarQuantColumn<Double>& intervalQuant() const
const ROScalarColumn<Double>& interval() const
const ROScalarColumn<Int>& level() const
const ROScalarColumn<String>& reason() const
const ROScalarColumn<Int>& severity() const
const ROScalarColumn<Double>& time() const
const ROScalarQuantColumn<Double>& timeQuant() const
const ROScalarMeasColumn<MEpoch>& timeMeas() const
const ROScalarColumn<String>& type() const

Access to required columns

uInt nrow() const

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

ROMSFlagCmdColumns()

void attach(const MSFlagCmd& msFlagCmd)

ROMSFlagCmdColumns(const ROMSFlagCmdColumns&)

ROMSFlagCmdColumns& operator=(const ROMSFlagCmdColumns&)


class MSFlagCmdColumns: public ROMSFlagCmdColumns

Interface

Public Members
MSFlagCmdColumns(MSFlagCmd& msFlagCmd)
~MSFlagCmdColumns()
ScalarColumn<Bool>& applied()
ScalarColumn<String>& command()
ScalarColumn<Double>& interval()
ScalarQuantColumn<Double>& intervalQuant()
ScalarColumn<Int>& level()
ScalarColumn<String>& reason()
ScalarColumn<Int>& severity()
ScalarColumn<Double>& time()
ScalarQuantColumn<Double>& timeQuant()
ScalarMeasColumn<MEpoch>& timeMeas()
ScalarColumn<String>& type()
const ROScalarColumn<Bool>& applied() const
const ROScalarColumn<String>& command() const
const ROScalarQuantColumn<Double>& intervalQuant() const
const ROScalarColumn<Double>& interval() const
const ROScalarColumn<Int>& level() const
const ROScalarColumn<String>& reason() const
const ROScalarColumn<Int>& severity() const
const ROScalarColumn<Double>& time() const
const ROScalarQuantColumn<Double>& timeQuant() const
const ROScalarMeasColumn<MEpoch>& timeMeas() const
const ROScalarColumn<String>& type() const
void setEpochRef(MEpoch::Types ref, Bool tableMustBeEmpty=True)
Protected Members
MSFlagCmdColumns()
void attach(MSFlagCmd& msFlagCmd)
Private Members
MSFlagCmdColumns(const MSFlagCmdColumns&)
MSFlagCmdColumns& operator=(const MSFlagCmdColumns&)

Description

Review Status

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

Prerequisite

Etymology

MSFlagCmdColumns stands for MeasurementSet FlagCmd Table columns.

Synopsis

This class provides access to the columns in the MSFlagCmd Table, it does the declaration of all the ScalarColumns 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

MSFlagCmdColumns(MSFlagCmd& msFlagCmd)

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

~MSFlagCmdColumns()

The destructor does nothing special

ScalarColumn<Bool>& applied()
ScalarColumn<String>& command()
ScalarColumn<Double>& interval()
ScalarQuantColumn<Double>& intervalQuant()
ScalarColumn<Int>& level()
ScalarColumn<String>& reason()
ScalarColumn<Int>& severity()
ScalarColumn<Double>& time()
ScalarQuantColumn<Double>& timeQuant()
ScalarMeasColumn<MEpoch>& timeMeas()
ScalarColumn<String>& type()

Read-write access to required columns

const ROScalarColumn<Bool>& applied() const
const ROScalarColumn<String>& command() const
const ROScalarQuantColumn<Double>& intervalQuant() const
const ROScalarColumn<Double>& interval() const
const ROScalarColumn<Int>& level() const
const ROScalarColumn<String>& reason() const
const ROScalarColumn<Int>& severity() const
const ROScalarColumn<Double>& time() const
const ROScalarQuantColumn<Double>& timeQuant() const
const ROScalarMeasColumn<MEpoch>& timeMeas() const
const ROScalarColumn<String>& type() const

Read-only access to required columns

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

set the epoch type for the FLAG_CMD 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.

MSFlagCmdColumns()

void attach(MSFlagCmd& msFlagCmd)

MSFlagCmdColumns(const MSFlagCmdColumns&)

MSFlagCmdColumns& operator=(const MSFlagCmdColumns&)