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::MSPointingColumns Class Reference

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

#include <MSPointingColumns.h>

Inheritance diagram for casa::MSPointingColumns:
casa::ROMSPointingColumns

List of all members.

Public Member Functions

 MSPointingColumns (MSPointing &msPointing)
 Construct from the supplied Table.
 ~MSPointingColumns ()
 The destructor does nothing special.
ScalarColumn< Int > & antennaId ()
 Read-write access to required columns.
ScalarColumn< Double > & time ()
ScalarMeasColumn< MEpoch > & timeMeas ()
ScalarQuantColumn< Double > & timeQuant ()
ScalarColumn< Double > & interval ()
ScalarQuantColumn< Double > & intervalQuant ()
ScalarColumn< String > & name ()
ScalarColumn< Int > & numPoly ()
ScalarColumn< Double > & timeOrigin ()
ScalarQuantColumn< Double > & timeOriginQuant ()
ScalarMeasColumn< MEpoch > & timeOriginMeas ()
ArrayColumn< Double > & direction ()
ArrayMeasColumn< MDirection > & directionMeasCol ()
ArrayColumn< Double > & target ()
ArrayMeasColumn< MDirection > & targetMeasCol ()
ScalarColumn< Bool > & tracking ()
ArrayColumn< Double > & pointingOffset ()
 Read-write access to optional columns.
ArrayMeasColumn< MDirection > & pointingOffsetMeasCol ()
ArrayColumn< Double > & sourceOffset ()
ArrayMeasColumn< MDirection > & sourceOffsetMeasCol ()
ArrayColumn< Double > & encoder ()
ScalarMeasColumn< MDirection > & encoderMeas ()
ScalarColumn< Int > & pointingModelId ()
ScalarColumn< Bool > & onSource ()
ScalarColumn< Bool > & overTheTop ()
const ROScalarColumn< Int > & antennaId () const
 Read-only access to required columns.
const ROScalarColumn< Double > & time () const
const ROScalarQuantColumn
< Double > & 
timeQuant () const
const ROScalarMeasColumn
< MEpoch > & 
timeMeas () const
const ROScalarColumn< Double > & interval () const
const ROScalarQuantColumn
< Double > & 
intervalQuant () const
const ROScalarColumn< String > & name () const
const ROScalarColumn< Int > & numPoly () const
const ROScalarColumn< Double > & timeOrigin () const
const ROScalarQuantColumn
< Double > & 
timeOriginQuant () const
const ROScalarMeasColumn
< MEpoch > & 
timeOriginMeas () const
const ROArrayColumn< Double > & direction () const
const ROArrayMeasColumn
< MDirection > & 
directionMeasCol () const
const ROArrayColumn< Double > & target () const
const ROArrayMeasColumn
< MDirection > & 
targetMeasCol () const
const ROScalarColumn< Bool > & tracking () const
const ROArrayColumn< Double > & pointingOffset () const
 Access to optional columns.
const ROArrayMeasColumn
< MDirection > & 
pointingOffsetMeasCol () const
const ROArrayColumn< Double > & sourceOffset () const
const ROArrayMeasColumn
< MDirection > & 
sourceOffsetMeasCol () const
const ROArrayColumn< Double > & encoder () const
const ROScalarMeasColumn
< MDirection > & 
encoderMeas () const
const ROScalarColumn< Int > & pointingModelId () const
const ROScalarColumn< Bool > & onSource () const
const ROScalarColumn< Bool > & overTheTop () const
void setEpochRef (MEpoch::Types ref, Bool tableMustBeEmpty=True)
 set the epoch reference type for the TIME & TIME_ORIGIN column.
void setDirectionRef (MDirection::Types ref)
 set the direction reference type for the DIRECTION, TARGET & and, if defined, the SOURCE_OFFSET & POINTING_OFFSET columns.
void setEncoderDirectionRef (MDirection::Types ref)
 set the direction reference type for the ENCODER column (if it is defined).

Protected Member Functions

 MSPointingColumns ()
void attach (MSPointing &msPointing)

Private Member Functions

 MSPointingColumns (const MSPointingColumns &)
MSPointingColumnsoperator= (const MSPointingColumns &)
void attachOptionalCols (MSPointing &msPointing)

Private Attributes

ScalarColumn< IntantennaId_p
ArrayColumn< Doubledirection_p
ScalarColumn< Doubleinterval_p
ScalarColumn< Stringname_p
ScalarColumn< IntnumPoly_p
ArrayColumn< Doubletarget_p
ScalarColumn< Doubletime_p
ScalarColumn< DoubletimeOrigin_p
ScalarColumn< Booltracking_p
ArrayColumn< Doubleencoder_p
ScalarColumn< BoolonSource_p
ScalarColumn< IntpointingModelId_p
ArrayColumn< DoublepointingOffset_p
ArrayColumn< DoublesourceOffset_p
ScalarColumn< BooloverTheTop_p
ArrayMeasColumn< MDirectiondirectionMeas_p
ArrayMeasColumn< MDirectiontargetMeas_p
ScalarMeasColumn< MEpochtimeMeas_p
ScalarMeasColumn< MEpochtimeOriginMeas_p
ScalarMeasColumn< MDirectionencoderMeas_p
ArrayMeasColumn< MDirectionpointingOffsetMeas_p
ArrayMeasColumn< MDirectionsourceOffsetMeas_p
ScalarQuantColumn< DoubleintervalQuant_p
ScalarQuantColumn< DoubletimeQuant_p
ScalarQuantColumn< DoubletimeOriginQuant_p

Detailed Description

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

Intended use:

Public interface

Review Status

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

Prerequisite

Etymology

MSPointingColumns stands for MeasurementSet Pointing Table columns.

Synopsis

This class provides access to the columns in the MSPointing 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 233 of file MSPointingColumns.h.


Constructor & Destructor Documentation

Construct from the supplied Table.

The destructor does nothing special.


Member Function Documentation

Read-write access to required columns.

Note that the direction measures with a stored polynomial have Col() added to their name. They are better accessed via the functions that have the same name, without the Col suffix, that will do the interpolation for you. These functions are in the ROMSPointingColumns class.

Definition at line 249 of file MSPointingColumns.h.

References antennaId_p.

Referenced by antennaId().

Read-only access to required columns.

Reimplemented from casa::ROMSPointingColumns.

Definition at line 289 of file MSPointingColumns.h.

References antennaId().

void casa::MSPointingColumns::attach ( MSPointing msPointing) [protected]
void casa::MSPointingColumns::attachOptionalCols ( MSPointing msPointing) [private]

Definition at line 260 of file MSPointingColumns.h.

References direction_p.

Referenced by direction().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 311 of file MSPointingColumns.h.

References direction().

Definition at line 261 of file MSPointingColumns.h.

References directionMeas_p.

Referenced by directionMeasCol().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 313 of file MSPointingColumns.h.

References directionMeasCol().

Definition at line 280 of file MSPointingColumns.h.

References encoder_p.

Referenced by encoder().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 333 of file MSPointingColumns.h.

References encoder().

Definition at line 281 of file MSPointingColumns.h.

References encoderMeas_p.

Referenced by encoderMeas().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 335 of file MSPointingColumns.h.

References encoderMeas().

Definition at line 253 of file MSPointingColumns.h.

References interval_p.

Referenced by interval().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 297 of file MSPointingColumns.h.

References interval().

Definition at line 254 of file MSPointingColumns.h.

References intervalQuant_p.

Referenced by intervalQuant().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 299 of file MSPointingColumns.h.

References intervalQuant().

Definition at line 255 of file MSPointingColumns.h.

References name_p.

Referenced by name().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 301 of file MSPointingColumns.h.

References name().

Definition at line 256 of file MSPointingColumns.h.

References numPoly_p.

Referenced by numPoly().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 303 of file MSPointingColumns.h.

References numPoly().

Definition at line 283 of file MSPointingColumns.h.

References onSource_p.

Referenced by onSource().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 339 of file MSPointingColumns.h.

References onSource().

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

Definition at line 284 of file MSPointingColumns.h.

References overTheTop_p.

Referenced by overTheTop().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 341 of file MSPointingColumns.h.

References overTheTop().

Definition at line 282 of file MSPointingColumns.h.

References pointingModelId_p.

Referenced by pointingModelId().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 337 of file MSPointingColumns.h.

References pointingModelId().

Read-write access to optional columns.

Note that the direction measures with a stored polynomial have Col() added to their name. They are better accessed via the functions that have the same name, without the Col suffix, that will do the interpolation for you. These functions are in the ROMSPointingColumns class.

Definition at line 274 of file MSPointingColumns.h.

References pointingOffset_p.

Referenced by pointingOffset().

Access to optional columns.

Reimplemented from casa::ROMSPointingColumns.

Definition at line 325 of file MSPointingColumns.h.

References pointingOffset().

Definition at line 275 of file MSPointingColumns.h.

References pointingOffsetMeas_p.

Referenced by pointingOffsetMeasCol().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 327 of file MSPointingColumns.h.

References pointingOffsetMeasCol().

set the direction reference type for the DIRECTION, TARGET & and, if defined, the SOURCE_OFFSET & POINTING_OFFSET columns.

This can only be done when the table has no rows. Trying to do so at other times will throw an exception. Note that the optional ENCODER column must be done separately as the MSv2 definition requires this column to use the frame(s) of the antenna mounts.

set the direction reference type for the ENCODER column (if it is defined).

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

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

set the epoch reference type for the TIME & TIME_ORIGIN 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;

Definition at line 277 of file MSPointingColumns.h.

References sourceOffset_p.

Referenced by sourceOffset().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 329 of file MSPointingColumns.h.

References sourceOffset().

Definition at line 278 of file MSPointingColumns.h.

References sourceOffsetMeas_p.

Referenced by sourceOffsetMeasCol().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 331 of file MSPointingColumns.h.

References sourceOffsetMeasCol().

Definition at line 262 of file MSPointingColumns.h.

References target_p.

Referenced by target().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 315 of file MSPointingColumns.h.

References target().

Definition at line 263 of file MSPointingColumns.h.

References targetMeas_p.

Referenced by targetMeasCol().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 317 of file MSPointingColumns.h.

References targetMeasCol().

Definition at line 250 of file MSPointingColumns.h.

References time_p.

Referenced by time().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 291 of file MSPointingColumns.h.

References time().

Definition at line 251 of file MSPointingColumns.h.

References timeMeas_p.

Referenced by timeMeas().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 295 of file MSPointingColumns.h.

References timeMeas().

Definition at line 257 of file MSPointingColumns.h.

References timeOrigin_p.

Referenced by timeOrigin().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 305 of file MSPointingColumns.h.

References timeOrigin().

Definition at line 259 of file MSPointingColumns.h.

References timeOriginMeas_p.

Referenced by timeOriginMeas().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 309 of file MSPointingColumns.h.

References timeOriginMeas().

Definition at line 258 of file MSPointingColumns.h.

References timeOriginQuant_p.

Referenced by timeOriginQuant().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 307 of file MSPointingColumns.h.

References timeOriginQuant().

Definition at line 252 of file MSPointingColumns.h.

References timeQuant_p.

Referenced by timeQuant().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 293 of file MSPointingColumns.h.

References timeQuant().

Definition at line 264 of file MSPointingColumns.h.

References tracking_p.

Referenced by tracking().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 319 of file MSPointingColumns.h.

References tracking().


Member Data Documentation

Reimplemented from casa::ROMSPointingColumns.

Definition at line 387 of file MSPointingColumns.h.

Referenced by antennaId().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 388 of file MSPointingColumns.h.

Referenced by direction().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 405 of file MSPointingColumns.h.

Referenced by directionMeasCol().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 397 of file MSPointingColumns.h.

Referenced by encoder().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 410 of file MSPointingColumns.h.

Referenced by encoderMeas().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 389 of file MSPointingColumns.h.

Referenced by interval().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 415 of file MSPointingColumns.h.

Referenced by intervalQuant().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 390 of file MSPointingColumns.h.

Referenced by name().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 391 of file MSPointingColumns.h.

Referenced by numPoly().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 398 of file MSPointingColumns.h.

Referenced by onSource().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 402 of file MSPointingColumns.h.

Referenced by overTheTop().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 399 of file MSPointingColumns.h.

Referenced by pointingModelId().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 400 of file MSPointingColumns.h.

Referenced by pointingOffset().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 411 of file MSPointingColumns.h.

Referenced by pointingOffsetMeasCol().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 401 of file MSPointingColumns.h.

Referenced by sourceOffset().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 412 of file MSPointingColumns.h.

Referenced by sourceOffsetMeasCol().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 392 of file MSPointingColumns.h.

Referenced by target().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 406 of file MSPointingColumns.h.

Referenced by targetMeasCol().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 393 of file MSPointingColumns.h.

Referenced by time().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 407 of file MSPointingColumns.h.

Referenced by timeMeas().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 394 of file MSPointingColumns.h.

Referenced by timeOrigin().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 408 of file MSPointingColumns.h.

Referenced by timeOriginMeas().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 417 of file MSPointingColumns.h.

Referenced by timeOriginQuant().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 416 of file MSPointingColumns.h.

Referenced by timeQuant().

Reimplemented from casa::ROMSPointingColumns.

Definition at line 395 of file MSPointingColumns.h.

Referenced by tracking().


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