MSHistoryColumns.h

Classes

ROMSHistoryColumns -- A class to provide easy read-only access to MSHistory columns (full description)
MSHistoryColumns -- A class to provide easy read-write access to MSHistory columns (full description)

class ROMSHistoryColumns

Interface

Public Members
ROMSHistoryColumns(const MSHistory& msHistory)
~ROMSHistoryColumns()
const ROScalarColumn<String>& application() const
const ROArrayColumn<String>& appParams() const
const ROArrayColumn<String>& cliCommand() const
const ROScalarColumn<String>& message() const
const ROScalarColumn<Int>& objectId() const
const ROScalarColumn<Int>& observationId() const
const ROScalarColumn<String>& origin() const
const ROScalarColumn<String>& priority() const
const ROScalarColumn<Double>& time() const
const ROScalarQuantColumn<Double>& timeQuant() const
const ROScalarMeasColumn<MEpoch>& timeMeas() const
uInt nrow() const
Protected Members
ROMSHistoryColumns()
void attach(const MSHistory& msHistory)
Private Members
ROMSHistoryColumns(const ROMSHistoryColumns&)
ROMSHistoryColumns& operator=(const ROMSHistoryColumns&)

Description

Review Status

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

Prerequisite

Etymology

ROMSHistoryColumns stands for Read-Only MeasurementSet History Table columns.

Synopsis

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

ROMSHistoryColumns(const MSHistory& msHistory)

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

~ROMSHistoryColumns()

The destructor does nothing special

const ROScalarColumn<String>& application() const
const ROArrayColumn<String>& appParams() const
const ROArrayColumn<String>& cliCommand() const
const ROScalarColumn<String>& message() const
const ROScalarColumn<Int>& objectId() const
const ROScalarColumn<Int>& observationId() const
const ROScalarColumn<String>& origin() const
const ROScalarColumn<String>& priority() const
const ROScalarColumn<Double>& time() const
const ROScalarQuantColumn<Double>& timeQuant() const
const ROScalarMeasColumn<MEpoch>& timeMeas() const

Access to required columns

uInt nrow() const

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

ROMSHistoryColumns()

void attach(const MSHistory& msHistory)

ROMSHistoryColumns(const ROMSHistoryColumns&)

ROMSHistoryColumns& operator=(const ROMSHistoryColumns&)


class MSHistoryColumns: public ROMSHistoryColumns

Interface

Public Members
MSHistoryColumns(MSHistory& msHistory)
~MSHistoryColumns()
ScalarColumn<String>& application()
ArrayColumn<String>& appParams()
ArrayColumn<String>& cliCommand()
ScalarColumn<String>& message()
ScalarColumn<Int>& objectId()
ScalarColumn<Int>& observationId()
ScalarColumn<String>& origin()
ScalarColumn<String>& priority()
ScalarColumn<Double>& time()
ScalarQuantColumn<Double>& timeQuant()
ScalarMeasColumn<MEpoch>& timeMeas()
const ROScalarColumn<String>& application() const
const ROArrayColumn<String>& appParams() const
const ROArrayColumn<String>& cliCommand() const
const ROScalarColumn<String>& message() const
const ROScalarColumn<Int>& objectId() const
const ROScalarColumn<Int>& observationId() const
const ROScalarColumn<String>& origin() const
const ROScalarColumn<String>& priority() 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
MSHistoryColumns()
void attach(MSHistory& msHistory)
Private Members
MSHistoryColumns(const MSHistoryColumns&)
MSHistoryColumns& operator=(const MSHistoryColumns&)

Description

Review Status

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

Prerequisite

Etymology

MSHistoryColumns stands for MeasurementSet History Table columns.

Synopsis

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

MSHistoryColumns(MSHistory& msHistory)

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

~MSHistoryColumns()

The destructor does nothing special

ScalarColumn<String>& application()
ArrayColumn<String>& appParams()
ArrayColumn<String>& cliCommand()
ScalarColumn<String>& message()
ScalarColumn<Int>& objectId()
ScalarColumn<Int>& observationId()
ScalarColumn<String>& origin()
ScalarColumn<String>& priority()
ScalarColumn<Double>& time()
ScalarQuantColumn<Double>& timeQuant()
ScalarMeasColumn<MEpoch>& timeMeas()

Read-write access to required columns

const ROScalarColumn<String>& application() const
const ROArrayColumn<String>& appParams() const
const ROArrayColumn<String>& cliCommand() const
const ROScalarColumn<String>& message() const
const ROScalarColumn<Int>& objectId() const
const ROScalarColumn<Int>& observationId() const
const ROScalarColumn<String>& origin() const
const ROScalarColumn<String>& priority() 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.

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.

MSHistoryColumns()

void attach(MSHistory& msHistory)

MSHistoryColumns(const MSHistoryColumns&)

MSHistoryColumns& operator=(const MSHistoryColumns&)