GBTMSSourceFiller.h
Classes
- GBTMSSourceFiller -- GBTMSSourceFiller fills the MSSource table for GBT fillers (full description)
Interface
- Public Members
- GBTMSSourceFiller()
- GBTMSSourceFiller(MSSource &msSource)
- ~GBTMSSourceFiller()
- void attach(MSSource &msSource)
- void fill(const Vector<Int> &spectralWindowIds, const String &name, Double restFrequency = 0.0, Double sysvel = 0.0, const String &code="", Double time = 0.0, Double interval=-1, Int calibrationGroup=-1, const Vector<Double> &direction=Vector<Double>(2,0.0), const Vector<Double> &position=Vector<Double>(3,0.0))
- Int sourceId() const
- void flush()
- Private Members
- void init(MSSource &msSource)
- void cleanup()
- GBTMSSourceFiller(const GBTMSSourceFiller &other)
- void operator=(const GBTMSSourceFiller &other)
Review Status
- Date Reviewed:
- yyyy/mm/dd
Prerequisite
- MeasurementSets
- GBT FITS files
Etymology
This class puts GBT data (fills) into the MSSource table.
Synopsis
This class puts the appropriate values for the GBT in an MSSource
table (which has been previously created as part of a MeasurementSet).
On each fill() any necessary additions to the MSSource are made.
This filler keeps returns a unique ID for each set of source information.
Existing information is kept for later indexing. The spectral window ID
is used in addition to the source ID to set this information into the
appropriate row of the MSSource table.
The sourceId 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.
Member Description
The default ctor. No MSSource 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 MSSource has been created.
A filler attached to an MSSource table
attach it to an MSSource
void fill(const Vector<Int> &spectralWindowIds, const String &name, Double restFrequency = 0.0, Double sysvel = 0.0, const String &code="", Double time = 0.0, Double interval=-1, Int calibrationGroup=-1, const Vector<Double> &direction=Vector<Double>(2,0.0), const Vector<Double> &position=Vector<Double>(3,0.0))
fill given the indicated source information and spectral window ID
What is the most recently filled source ID. Returns -1 if none have been filled.
flush the underlying MS subtable
initialize the above for the first time
clean things up
undefined and unavailable
void operator=(const GBTMSSourceFiller &other)