casa::MSFlagCmdColumns Class Reference
[MeasurementSets]

#include <MSFlagCmdColumns.h>

Inheritance diagram for casa::MSFlagCmdColumns:

Inheritance graph
[legend]
Collaboration diagram for casa::MSFlagCmdColumns:

Collaboration graph
[legend]
List of all members.

Detailed Description

A class to provide easy read-write access to MSFlagCmd columns.

Intended use:

Part of API

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.

Definition at line 166 of file MSFlagCmdColumns.h.

Public Member Functions

 MSFlagCmdColumns (MSFlagCmd &msFlagCmd)
 Create a columns object that accesses the data in the specified Table.
 ~MSFlagCmdColumns ()
 The destructor does nothing special.
void setEpochRef (MEpoch::Types ref, Bool tableMustBeEmpty=True)
 set the epoch type for the FLAG_CMD column.
ScalarColumn< Bool > & applied ()
 Read-write access to required columns.
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
 Read-only access to required columns.
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

Protected Member Functions

 MSFlagCmdColumns ()
void attach (MSFlagCmd &msFlagCmd)

Private Member Functions

 MSFlagCmdColumns (const MSFlagCmdColumns &)
MSFlagCmdColumnsoperator= (const MSFlagCmdColumns &)

Private Attributes

ScalarColumn< Boolapplied_p
ScalarColumn< Stringcommand_p
ScalarColumn< Doubleinterval_p
ScalarColumn< Intlevel_p
ScalarColumn< Stringreason_p
ScalarColumn< Intseverity_p
ScalarColumn< Doubletime_p
ScalarColumn< Stringtype_p
ScalarMeasColumn< MEpochtimeMeas_p
ScalarQuantColumn< DoubleintervalQuant_p
ScalarQuantColumn< DoubletimeQuant_p


Constructor & Destructor Documentation

casa::MSFlagCmdColumns::MSFlagCmdColumns ( MSFlagCmd msFlagCmd  ) 

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

casa::MSFlagCmdColumns::~MSFlagCmdColumns (  ) 

The destructor does nothing special.

casa::MSFlagCmdColumns::MSFlagCmdColumns (  )  [protected]

casa::MSFlagCmdColumns::MSFlagCmdColumns ( const MSFlagCmdColumns  )  [private]


Member Function Documentation

ScalarColumn<Bool>& casa::MSFlagCmdColumns::applied (  )  [inline]

Read-write access to required columns.

Definition at line 177 of file MSFlagCmdColumns.h.

References applied_p.

ScalarColumn<String>& casa::MSFlagCmdColumns::command (  )  [inline]

Definition at line 178 of file MSFlagCmdColumns.h.

References command_p.

ScalarColumn<Double>& casa::MSFlagCmdColumns::interval (  )  [inline]

Definition at line 179 of file MSFlagCmdColumns.h.

References interval_p.

ScalarQuantColumn<Double>& casa::MSFlagCmdColumns::intervalQuant (  )  [inline]

Definition at line 180 of file MSFlagCmdColumns.h.

References intervalQuant_p.

ScalarColumn<Int>& casa::MSFlagCmdColumns::level (  )  [inline]

Definition at line 181 of file MSFlagCmdColumns.h.

References level_p.

ScalarColumn<String>& casa::MSFlagCmdColumns::reason (  )  [inline]

Definition at line 182 of file MSFlagCmdColumns.h.

References reason_p.

ScalarColumn<Int>& casa::MSFlagCmdColumns::severity (  )  [inline]

Definition at line 183 of file MSFlagCmdColumns.h.

References severity_p.

ScalarColumn<Double>& casa::MSFlagCmdColumns::time (  )  [inline]

Definition at line 184 of file MSFlagCmdColumns.h.

References time_p.

ScalarQuantColumn<Double>& casa::MSFlagCmdColumns::timeQuant (  )  [inline]

Definition at line 185 of file MSFlagCmdColumns.h.

References timeQuant_p.

ScalarMeasColumn<MEpoch>& casa::MSFlagCmdColumns::timeMeas (  )  [inline]

Definition at line 186 of file MSFlagCmdColumns.h.

References timeMeas_p.

ScalarColumn<String>& casa::MSFlagCmdColumns::type (  )  [inline]

Definition at line 187 of file MSFlagCmdColumns.h.

References type_p.

const ROScalarColumn<Bool>& casa::MSFlagCmdColumns::applied (  )  const [inline]

Read-only access to required columns.

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 192 of file MSFlagCmdColumns.h.

References casa::ROMSFlagCmdColumns::applied().

const ROScalarColumn<String>& casa::MSFlagCmdColumns::command (  )  const [inline]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 194 of file MSFlagCmdColumns.h.

References casa::ROMSFlagCmdColumns::command().

const ROScalarQuantColumn<Double>& casa::MSFlagCmdColumns::intervalQuant (  )  const [inline]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 196 of file MSFlagCmdColumns.h.

References casa::ROMSFlagCmdColumns::intervalQuant().

const ROScalarColumn<Double>& casa::MSFlagCmdColumns::interval (  )  const [inline]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 198 of file MSFlagCmdColumns.h.

References casa::ROMSFlagCmdColumns::interval().

const ROScalarColumn<Int>& casa::MSFlagCmdColumns::level (  )  const [inline]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 200 of file MSFlagCmdColumns.h.

References casa::ROMSFlagCmdColumns::level().

const ROScalarColumn<String>& casa::MSFlagCmdColumns::reason (  )  const [inline]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 202 of file MSFlagCmdColumns.h.

References casa::ROMSFlagCmdColumns::reason().

const ROScalarColumn<Int>& casa::MSFlagCmdColumns::severity (  )  const [inline]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 204 of file MSFlagCmdColumns.h.

References casa::ROMSFlagCmdColumns::severity().

const ROScalarColumn<Double>& casa::MSFlagCmdColumns::time (  )  const [inline]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 206 of file MSFlagCmdColumns.h.

References casa::time().

const ROScalarQuantColumn<Double>& casa::MSFlagCmdColumns::timeQuant (  )  const [inline]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 208 of file MSFlagCmdColumns.h.

References casa::ROMSFlagCmdColumns::timeQuant().

const ROScalarMeasColumn<MEpoch>& casa::MSFlagCmdColumns::timeMeas (  )  const [inline]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 210 of file MSFlagCmdColumns.h.

References casa::ROMSFlagCmdColumns::timeMeas().

const ROScalarColumn<String>& casa::MSFlagCmdColumns::type (  )  const [inline]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 212 of file MSFlagCmdColumns.h.

References casa::type().

void casa::MSFlagCmdColumns::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.

void casa::MSFlagCmdColumns::attach ( MSFlagCmd msFlagCmd  )  [protected]

MSFlagCmdColumns& casa::MSFlagCmdColumns::operator= ( const MSFlagCmdColumns  )  [private]


Member Data Documentation

ScalarColumn<Bool> casa::MSFlagCmdColumns::applied_p [private]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 242 of file MSFlagCmdColumns.h.

Referenced by applied().

ScalarColumn<String> casa::MSFlagCmdColumns::command_p [private]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 243 of file MSFlagCmdColumns.h.

Referenced by command().

ScalarColumn<Double> casa::MSFlagCmdColumns::interval_p [private]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 244 of file MSFlagCmdColumns.h.

Referenced by interval().

ScalarColumn<Int> casa::MSFlagCmdColumns::level_p [private]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 245 of file MSFlagCmdColumns.h.

Referenced by level().

ScalarColumn<String> casa::MSFlagCmdColumns::reason_p [private]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 246 of file MSFlagCmdColumns.h.

Referenced by reason().

ScalarColumn<Int> casa::MSFlagCmdColumns::severity_p [private]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 247 of file MSFlagCmdColumns.h.

Referenced by severity().

ScalarColumn<Double> casa::MSFlagCmdColumns::time_p [private]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 248 of file MSFlagCmdColumns.h.

Referenced by time().

ScalarColumn<String> casa::MSFlagCmdColumns::type_p [private]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 249 of file MSFlagCmdColumns.h.

Referenced by type().

ScalarMeasColumn<MEpoch> casa::MSFlagCmdColumns::timeMeas_p [private]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 252 of file MSFlagCmdColumns.h.

Referenced by timeMeas().

ScalarQuantColumn<Double> casa::MSFlagCmdColumns::intervalQuant_p [private]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 255 of file MSFlagCmdColumns.h.

Referenced by intervalQuant().

ScalarQuantColumn<Double> casa::MSFlagCmdColumns::timeQuant_p [private]

Reimplemented from casa::ROMSFlagCmdColumns.

Definition at line 256 of file MSFlagCmdColumns.h.

Referenced by timeQuant().


The documentation for this class was generated from the following file:
Generated on Mon Sep 1 22:46:52 2008 for NRAOCASA by  doxygen 1.5.1