casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
casa::MSSourceColumns Class Reference

A class to provide easy read-write access to MSSource columns. More...

#include <MSSourceColumns.h>

Inheritance diagram for casa::MSSourceColumns:
casa::ROMSSourceColumns

List of all members.

Public Member Functions

 MSSourceColumns (MSSource &msSource)
 Construct from the supplied Table.
 ~MSSourceColumns ()
 The destructor does nothing special.
ScalarColumn< Int > & calibrationGroup ()
 Read-write access to required columns.
ScalarColumn< String > & code ()
ArrayColumn< Double > & direction ()
ArrayQuantColumn< Double > & directionQuant ()
ScalarMeasColumn< MDirection > & directionMeas ()
ScalarColumn< Double > & interval ()
ScalarQuantColumn< Double > & intervalQuant ()
ScalarColumn< String > & name ()
ScalarColumn< Int > & numLines ()
ArrayColumn< Double > & properMotion ()
ArrayQuantColumn< Double > & properMotionQuant ()
ScalarColumn< Int > & sourceId ()
ScalarColumn< Int > & spectralWindowId ()
ScalarColumn< Double > & time ()
ScalarQuantColumn< Double > & timeQuant ()
ScalarMeasColumn< MEpoch > & timeMeas ()
ArrayColumn< Double > & position ()
 Read-write access to optional columns.
ArrayQuantColumn< Double > & positionQuant ()
ScalarMeasColumn< MPosition > & positionMeas ()
ScalarColumn< Int > & pulsarId ()
ArrayColumn< Double > & restFrequency ()
ArrayQuantColumn< Double > & restFrequencyQuant ()
ArrayMeasColumn< MFrequency > & restFrequencyMeas ()
ScalarColumn< TableRecord > & sourceModel ()
ArrayColumn< Double > & sysvel ()
ArrayQuantColumn< Double > & sysvelQuant ()
ArrayMeasColumn
< MRadialVelocity > & 
sysvelMeas ()
ArrayColumn< String > & transition ()
const ROScalarColumn< Int > & calibrationGroup () const
 Read-only access to required columns.
const ROScalarColumn< String > & code () const
const ROArrayColumn< Double > & direction () const
const ROArrayQuantColumn
< Double > & 
directionQuant () const
const ROScalarMeasColumn
< MDirection > & 
directionMeas () const
const ROScalarColumn< Double > & interval () const
const ROScalarQuantColumn
< Double > & 
intervalQuant () const
const ROScalarColumn< String > & name () const
const ROScalarColumn< Int > & numLines () const
const ROArrayColumn< Double > & properMotion () const
const ROArrayQuantColumn
< Double > & 
properMotionQuant () const
const ROScalarColumn< Int > & sourceId () const
const ROScalarColumn< Int > & spectralWindowId () const
const ROScalarColumn< Double > & time () const
const ROScalarQuantColumn
< Double > & 
timeQuant () const
const ROScalarMeasColumn
< MEpoch > & 
timeMeas () const
const ROArrayColumn< Double > & position () const
 Read-only access to optional columns.
const ROArrayQuantColumn
< Double > & 
positionQuant () const
const ROScalarMeasColumn
< MPosition > & 
positionMeas () const
const ROScalarColumn< Int > & pulsarId () const
const ROArrayColumn< Double > & restFrequency () const
const ROArrayQuantColumn
< Double > & 
restFrequencyQuant () const
const ROArrayMeasColumn
< MFrequency > & 
restFrequencyMeas () const
const ROScalarColumn
< TableRecord > & 
sourceModel () const
const ROArrayColumn< Double > & sysvel () const
const ROArrayQuantColumn
< Double > & 
sysvelQuant () const
const ROArrayMeasColumn
< MRadialVelocity > & 
sysvelMeas () const
const ROArrayColumn< String > & transition () const
void setEpochRef (MEpoch::Types ref, Bool tableMustBeEmpty=True)
 set the epoch type for the TIME column.
void setDirectionRef (MDirection::Types ref)
 set the direction type for the DIRECTION column.
void setPositionRef (MPosition::Types ref)
 set the position type for the POSITION column.
void setFrequencyRef (MFrequency::Types ref)
 set the frequency type for the REST_FREQUENCY column.
void setRadialVelocityRef (MRadialVelocity::Types ref)
 set the radial velocity type for the SYSVEL column.

Protected Member Functions

 MSSourceColumns ()
void attach (MSSource &msSource)

Private Member Functions

 MSSourceColumns (const MSSourceColumns &)
MSSourceColumnsoperator= (const MSSourceColumns &)
void attachOptionalCols (MSSource &msSource)

Private Attributes

ScalarColumn< IntcalibrationGroup_p
ScalarColumn< Stringcode_p
ArrayColumn< Doubledirection_p
ScalarColumn< Doubleinterval_p
ScalarColumn< Stringname_p
ScalarColumn< IntnumLines_p
ArrayColumn< DoubleproperMotion_p
ScalarColumn< IntsourceId_p
ScalarColumn< IntspectralWindowId_p
ScalarColumn< Doubletime_p
ArrayColumn< Doubleposition_p
ScalarColumn< IntpulsarId_p
ArrayColumn< DoublerestFrequency_p
ScalarColumn< TableRecordsourceModel_p
ArrayColumn< Doublesysvel_p
ArrayColumn< Stringtransition_p
ScalarMeasColumn< MDirectiondirectionMeas_p
ScalarMeasColumn< MEpochtimeMeas_p
ScalarMeasColumn< MPositionpositionMeas_p
ArrayMeasColumn< MFrequencyrestFrequencyMeas_p
ArrayMeasColumn< MRadialVelocitysysvelMeas_p
ArrayQuantColumn< DoubledirectionQuant_p
ScalarQuantColumn< DoubleintervalQuant_p
ArrayQuantColumn< DoubleproperMotionQuant_p
ScalarQuantColumn< DoubletimeQuant_p
ArrayQuantColumn< DoublepositionQuant_p
ArrayQuantColumn< DoublerestFrequencyQuant_p
ArrayQuantColumn< DoublesysvelQuant_p

Detailed Description

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

Intended use:

Public interface

Review Status

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

Prerequisite

Etymology

MSSourceColumns stands for MeasurementSet Source Table columns.

Synopsis

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

Definition at line 243 of file MSSourceColumns.h.


Constructor & Destructor Documentation

Construct from the supplied Table.

The destructor does nothing special.


Member Function Documentation

void casa::MSSourceColumns::attach ( MSSource msSource) [protected]
void casa::MSSourceColumns::attachOptionalCols ( MSSource msSource) [private]

Read-write access to required columns.

Definition at line 254 of file MSSourceColumns.h.

References calibrationGroup_p.

Referenced by calibrationGroup().

Read-only access to required columns.

Reimplemented from casa::ROMSSourceColumns.

Definition at line 291 of file MSSourceColumns.h.

References calibrationGroup().

Definition at line 255 of file MSSourceColumns.h.

References code_p.

Referenced by code().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 293 of file MSSourceColumns.h.

References code().

Definition at line 256 of file MSSourceColumns.h.

References direction_p.

Referenced by direction().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 295 of file MSSourceColumns.h.

References direction().

Definition at line 258 of file MSSourceColumns.h.

References directionMeas_p.

Referenced by directionMeas().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 299 of file MSSourceColumns.h.

References directionMeas().

Definition at line 257 of file MSSourceColumns.h.

References directionQuant_p.

Referenced by directionQuant().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 297 of file MSSourceColumns.h.

References directionQuant().

Definition at line 259 of file MSSourceColumns.h.

References interval_p.

Referenced by interval().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 301 of file MSSourceColumns.h.

References interval().

Definition at line 260 of file MSSourceColumns.h.

References intervalQuant_p.

Referenced by intervalQuant().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 303 of file MSSourceColumns.h.

References intervalQuant().

Definition at line 261 of file MSSourceColumns.h.

References name_p.

Referenced by name().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 305 of file MSSourceColumns.h.

References name().

Definition at line 262 of file MSSourceColumns.h.

References numLines_p.

Referenced by numLines().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 307 of file MSSourceColumns.h.

References numLines().

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

Read-write access to optional columns.

Definition at line 274 of file MSSourceColumns.h.

References position_p.

Referenced by position().

Read-only access to optional columns.

Reimplemented from casa::ROMSSourceColumns.

Definition at line 327 of file MSSourceColumns.h.

References position().

Definition at line 276 of file MSSourceColumns.h.

References positionMeas_p.

Referenced by positionMeas().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 331 of file MSSourceColumns.h.

References positionMeas().

Definition at line 275 of file MSSourceColumns.h.

References positionQuant_p.

Referenced by positionQuant().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 329 of file MSSourceColumns.h.

References positionQuant().

Definition at line 263 of file MSSourceColumns.h.

References properMotion_p.

Referenced by properMotion().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 309 of file MSSourceColumns.h.

References properMotion().

Definition at line 264 of file MSSourceColumns.h.

References properMotionQuant_p.

Referenced by properMotionQuant().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 311 of file MSSourceColumns.h.

References properMotionQuant().

Definition at line 277 of file MSSourceColumns.h.

References pulsarId_p.

Referenced by pulsarId().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 333 of file MSSourceColumns.h.

References pulsarId().

Definition at line 278 of file MSSourceColumns.h.

References restFrequency_p.

Referenced by restFrequency().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 335 of file MSSourceColumns.h.

References restFrequency().

Definition at line 280 of file MSSourceColumns.h.

References restFrequencyMeas_p.

Referenced by restFrequencyMeas().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 339 of file MSSourceColumns.h.

References restFrequencyMeas().

Definition at line 279 of file MSSourceColumns.h.

References restFrequencyQuant_p.

Referenced by restFrequencyQuant().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 337 of file MSSourceColumns.h.

References restFrequencyQuant().

set the direction type for the DIRECTION column.

This can only be done when the table has no rows. Trying to do so at other times will throw an exception.

void casa::MSSourceColumns::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;

set the frequency type for the REST_FREQUENCY column.

Does nothing if this column is not defined. This can only be done when the table has no rows. Trying to do so at other times will throw an exception.

set the position type for the POSITION column.

This can only be done when the table has no rows. Trying to do so at other times will throw an exception.

set the radial velocity type for the SYSVEL column.

Does nothing if this column is not defined. This can only be done when the table has no rows. Trying to do so at other times will throw an exception.

Definition at line 265 of file MSSourceColumns.h.

References sourceId_p.

Referenced by sourceId().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 313 of file MSSourceColumns.h.

References sourceId().

Definition at line 282 of file MSSourceColumns.h.

References sourceModel_p.

Referenced by sourceModel().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 341 of file MSSourceColumns.h.

References sourceModel().

Definition at line 266 of file MSSourceColumns.h.

References spectralWindowId_p.

Referenced by spectralWindowId().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 315 of file MSSourceColumns.h.

References spectralWindowId().

Definition at line 283 of file MSSourceColumns.h.

References sysvel_p.

Referenced by sysvel().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 343 of file MSSourceColumns.h.

References sysvel().

Definition at line 285 of file MSSourceColumns.h.

References sysvelMeas_p.

Referenced by sysvelMeas().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 347 of file MSSourceColumns.h.

References sysvelMeas().

Definition at line 284 of file MSSourceColumns.h.

References sysvelQuant_p.

Referenced by sysvelQuant().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 345 of file MSSourceColumns.h.

References sysvelQuant().

Definition at line 267 of file MSSourceColumns.h.

References time_p.

Referenced by time().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 317 of file MSSourceColumns.h.

References time().

Definition at line 269 of file MSSourceColumns.h.

References timeMeas_p.

Referenced by timeMeas().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 321 of file MSSourceColumns.h.

References timeMeas().

Definition at line 268 of file MSSourceColumns.h.

References timeQuant_p.

Referenced by timeQuant().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 319 of file MSSourceColumns.h.

References timeQuant().

Definition at line 286 of file MSSourceColumns.h.

References transition_p.

Referenced by transition().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 349 of file MSSourceColumns.h.

References transition().


Member Data Documentation

Reimplemented from casa::ROMSSourceColumns.

Definition at line 402 of file MSSourceColumns.h.

Referenced by calibrationGroup().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 403 of file MSSourceColumns.h.

Referenced by code().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 404 of file MSSourceColumns.h.

Referenced by direction().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 421 of file MSSourceColumns.h.

Referenced by directionMeas().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 429 of file MSSourceColumns.h.

Referenced by directionQuant().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 405 of file MSSourceColumns.h.

Referenced by interval().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 430 of file MSSourceColumns.h.

Referenced by intervalQuant().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 406 of file MSSourceColumns.h.

Referenced by name().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 407 of file MSSourceColumns.h.

Referenced by numLines().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 413 of file MSSourceColumns.h.

Referenced by position().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 424 of file MSSourceColumns.h.

Referenced by positionMeas().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 434 of file MSSourceColumns.h.

Referenced by positionQuant().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 408 of file MSSourceColumns.h.

Referenced by properMotion().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 431 of file MSSourceColumns.h.

Referenced by properMotionQuant().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 414 of file MSSourceColumns.h.

Referenced by pulsarId().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 415 of file MSSourceColumns.h.

Referenced by restFrequency().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 425 of file MSSourceColumns.h.

Referenced by restFrequencyMeas().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 435 of file MSSourceColumns.h.

Referenced by restFrequencyQuant().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 409 of file MSSourceColumns.h.

Referenced by sourceId().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 416 of file MSSourceColumns.h.

Referenced by sourceModel().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 410 of file MSSourceColumns.h.

Referenced by spectralWindowId().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 417 of file MSSourceColumns.h.

Referenced by sysvel().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 426 of file MSSourceColumns.h.

Referenced by sysvelMeas().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 436 of file MSSourceColumns.h.

Referenced by sysvelQuant().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 411 of file MSSourceColumns.h.

Referenced by time().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 422 of file MSSourceColumns.h.

Referenced by timeMeas().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 432 of file MSSourceColumns.h.

Referenced by timeQuant().

Reimplemented from casa::ROMSSourceColumns.

Definition at line 418 of file MSSourceColumns.h.

Referenced by transition().


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