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

GBTMSPolarizationFiller fills the MSPolarization table for GBT fillers. More...

#include <GBTMSPolarizationFiller.h>

List of all members.

Public Member Functions

 GBTMSPolarizationFiller ()
 The default ctor.
 GBTMSPolarizationFiller (MSPolarization &msPolarization)
 A filler attached to an MSPolarization table.
 ~GBTMSPolarizationFiller ()
void attach (MSPolarization &msPolarization)
 attach it to an MSPolarization
void fill (Int ncorr, const Vector< Int > &corrType, const Matrix< Int > &corrProduct)
 fill - GBT MSPolarization table has one row.
Int polarizationId () const
 this is the row number of the most recently "filled" MSPolarization row it returns -1 if nothing has been filled yet
void flush ()
 flush the underlying MS subtable

Private Member Functions

void init (MSPolarization &msPolarization)
 initialize the above for the first time
 GBTMSPolarizationFiller (const GBTMSPolarizationFiller &other)
 undefined and unavailable
void operator= (const GBTMSPolarizationFiller &other)

Private Attributes

ColumnsIndex * index_p
RecordFieldPtr< Int > ncorrKey_p
MSPolarization * msPolarization_p
MSPolarizationColumns * msPolCols_p
Int polarizationId_p

Detailed Description

GBTMSPolarizationFiller fills the MSPolarization table for GBT fillers.

Intended use:

Internal

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

This class puts GBT data (fills) into the MSPolarization table.

Synopsis

This class puts the appropriate values for the GBT in an MSPolarization table (which has been previously created as part of a MeasurementSet). On each fill() any necessary additions to the MSPolarization are made. Currently this depends only on the shape of the data being filled as there is not yet any polarization information available from the GBT data associated paramters FITS files. Existing rows are re-used whenever possible.

The polarizationId is available to be used by the other GBTMS*Fillers as other subtables are filled in turn.

Example

Motivation

Writing a filler is a daunting task. There are various dependencies between the subtables. It helps to encapsulate the knowlege and task of filling a specific subtable to separate classes.

Definition at line 93 of file GBTMSPolarizationFiller.h.


Constructor & Destructor Documentation

The default ctor.

No MSPolarization table has been attached yet. Calling fill on such a filler will throw an exception. It is present so that this object can be instantiated before an MSPolarization has been created.

GBTMSPolarizationFiller::GBTMSPolarizationFiller ( MSPolarization &  msPolarization)

A filler attached to an MSPolarization table.

undefined and unavailable


Member Function Documentation

void GBTMSPolarizationFiller::attach ( MSPolarization &  msPolarization)

attach it to an MSPolarization

void GBTMSPolarizationFiller::fill ( Int  ncorr,
const Vector< Int > &  corrType,
const Matrix< Int > &  corrProduct 
)

fill - GBT MSPolarization table has one row.

void GBTMSPolarizationFiller::flush ( ) [inline]

flush the underlying MS subtable

Definition at line 119 of file GBTMSPolarizationFiller.h.

References msPolarization_p.

void GBTMSPolarizationFiller::init ( MSPolarization &  msPolarization) [private]

initialize the above for the first time

void GBTMSPolarizationFiller::operator= ( const GBTMSPolarizationFiller other) [private]

this is the row number of the most recently "filled" MSPolarization row it returns -1 if nothing has been filled yet

Definition at line 116 of file GBTMSPolarizationFiller.h.

References polarizationId_p.


Member Data Documentation

ColumnsIndex* GBTMSPolarizationFiller::index_p [private]

Definition at line 122 of file GBTMSPolarizationFiller.h.

MSPolarization* GBTMSPolarizationFiller::msPolarization_p [private]

Definition at line 124 of file GBTMSPolarizationFiller.h.

Referenced by flush().

MSPolarizationColumns* GBTMSPolarizationFiller::msPolCols_p [private]

Definition at line 125 of file GBTMSPolarizationFiller.h.

RecordFieldPtr<Int> GBTMSPolarizationFiller::ncorrKey_p [private]

Definition at line 123 of file GBTMSPolarizationFiller.h.

Definition at line 127 of file GBTMSPolarizationFiller.h.

Referenced by polarizationId().


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