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

GBTMSProcessorFiller fills the MSProcessor table for GBT fillers. More...

#include <GBTMSProcessorFiller.h>

List of all members.

Public Member Functions

 GBTMSProcessorFiller ()
 The default ctor.
 GBTMSProcessorFiller (MSProcessor &msProcessor)
 A filler attached to an MSProcessor table.
 ~GBTMSProcessorFiller ()
void attach (MSProcessor &msProcessor)
 attach it to an MSProcessor
void fill (const String &type, Int typeId)
 fill - sub_type is always GBT, mode_id is not yet used
Int processorId ()
 this is the row number of the most recently "filled" MSProcessor row
void flush ()
 flush the underlying MS subtable

Private Member Functions

void init (MSProcessor &msProcessor)
 initialize the above for the first time
 GBTMSProcessorFiller (const GBTMSProcessorFiller &other)
 undefined and unavailable
void operator= (const GBTMSProcessorFiller &other)

Private Attributes

MSProcessor * msProcessor_p
MSProcessorColumns * msProcCols_p
ColumnsIndex * index_p
RecordFieldPtr< StringtypeKey_p
RecordFieldPtr< Int > typeIdKey_p
Int procId_p

Detailed Description

GBTMSProcessorFiller fills the MSProcessor table for GBT fillers.

Intended use:

Internal

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

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

Synopsis

This class puts the appropriate values for the GBT in an MSProcessor table (which has been previously created as part of a MeasurementSet). On each fill() any necessary additions to the MSProcessor are made.

The processorId is available to be used by 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 87 of file GBTMSProcessorFiller.h.


Constructor & Destructor Documentation

The default ctor.

No MSProcessor 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 MSProcessor has been created.

GBTMSProcessorFiller::GBTMSProcessorFiller ( MSProcessor &  msProcessor)

A filler attached to an MSProcessor table.

undefined and unavailable


Member Function Documentation

void GBTMSProcessorFiller::attach ( MSProcessor &  msProcessor)

attach it to an MSProcessor

void GBTMSProcessorFiller::fill ( const String type,
Int  typeId 
)

fill - sub_type is always GBT, mode_id is not yet used

void GBTMSProcessorFiller::flush ( ) [inline]

flush the underlying MS subtable

Definition at line 112 of file GBTMSProcessorFiller.h.

References msProcessor_p.

void GBTMSProcessorFiller::init ( MSProcessor &  msProcessor) [private]

initialize the above for the first time

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

this is the row number of the most recently "filled" MSProcessor row

Definition at line 109 of file GBTMSProcessorFiller.h.

References procId_p.


Member Data Documentation

ColumnsIndex* GBTMSProcessorFiller::index_p [private]

Definition at line 117 of file GBTMSProcessorFiller.h.

MSProcessorColumns* GBTMSProcessorFiller::msProcCols_p [private]

Definition at line 115 of file GBTMSProcessorFiller.h.

MSProcessor* GBTMSProcessorFiller::msProcessor_p [private]

Definition at line 114 of file GBTMSProcessorFiller.h.

Referenced by flush().

Definition at line 122 of file GBTMSProcessorFiller.h.

Referenced by processorId().

RecordFieldPtr<Int> GBTMSProcessorFiller::typeIdKey_p [private]

Definition at line 120 of file GBTMSProcessorFiller.h.

RecordFieldPtr<String> GBTMSProcessorFiller::typeKey_p [private]

Definition at line 119 of file GBTMSProcessorFiller.h.


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