GBTBackendTable.h

Classes

GBTBackendTable -- Attach a FITSTabular to a GBT backend FITS file (full description)

class GBTBackendTable : public FITSTabular

Interface

Public Members
GBTBackendTable()
GBTBackendTable(const String &fileName)
~GBTBackendTable()
virtual Bool reopen(const String &fileName, Bool resync)
virtual Bool reopen(const String &fileName)
GBTScanLogReader::BACKENDS type() const
virtual const String &name() const
virtual Bool isValid() const
virtual uInt nstate() const
virtual uInt nchan(uInt whichSampler) const
virtual uInt nsamp() const
virtual Double bw(uInt whichSampler) const
virtual Double centerIF(uInt whichSampler) const
virtual Bool increases(uInt whichSampler) const
virtual const TableRecord &keywords() const
virtual const RecordDesc &description() const
virtual const Record &units() const
virtual const Record &displayFormats() const
virtual const Record &nulls() const
virtual Bool pastEnd() const
virtual void next()
virtual const Record &currentRow() const
virtual const Record &unhandledKeywords()
virtual void handleKeyword(const String &kwname)
virtual const Record &unhandledFields()
virtual void handleField(const String &fieldname)
virtual const Table &sampler() const
virtual const GBTStateTable &state() const
virtual const Table &actState() const
virtual const Table &port() const
virtual uInt nrow() const
virtual uInt rownr() const
virtual const String &fitsVers() const
virtual Int baseVersion() const
virtual Int deviceVersion() const
Private Members
void clear_self(Bool resync=False)
Table *tableFromFITS(FITSTable &fits)
void initUnhandledKeys()
void initUnhandledFields()
GBTBackendTable(const GBTBackendTable &)
GBTBackendTable &operator=(const GBTBackendTable &)

Description

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

Synopsis

GBTBackendTable is a FITSTabular which is attached to a GBT FITS backend file. GBT FITS backend files contain a DATA table and several anciliary tables that correspond to the axes of the data column in the DATA table.

Example

Motivation

To Do

Member Description

GBTBackendTable()

Default constructor, not attached to any specific file

GBTBackendTable(const String &fileName)

Construct it from a file name

~GBTBackendTable()

virtual Bool reopen(const String &fileName, Bool resync)

Attach this GBTBackendTable to a new file name. when resync is True, if fileName is the same as the currently opened file, if there is one, then this just closes and reopens the FITS file setting things right back to the next row in the table, if there is one

virtual Bool reopen(const String &fileName)

the reopen from FITSTabular, uses reopen here with resync=True

GBTScanLogReader::BACKENDS type() const

Return the type of this backend

virtual const String &name() const

return the name of the underlying table used at construction

virtual Bool isValid() const

is this a valid GBTBackendTable?

virtual uInt nstate() const

The number of elements along the STATE axis

virtual uInt nchan(uInt whichSampler) const

The number of elements along the frequency axis (defaults to 1 for non-spectral line data) for a specific sampler. For most backends, this is a constant. For the ACS backend, if there are more than one banks involved, it may vary with sampler. The default implementation is to return a constant.

virtual uInt nsamp() const

The number of elements along the sampler axis.

virtual Double bw(uInt whichSampler) const

The bandwidth for the indicated sampler. If this is < 0 then that signals that it is not known here and it should be fetched from the IF BANDWDTH column.

virtual Double centerIF(uInt whichSampler) const

The center IF for the indicated sampler. If this is < 0 then that signals that it is not known here and it should be fetched from the IF CENTER_IF column.

virtual Bool increases(uInt whichSampler) const

Indicates whether frequency increases with channel number for the given sampler.

virtual const TableRecord &keywords() const

these keywords associated with the FITS data table.

virtual const RecordDesc &description() const

virtual const Record &units() const

virtual const Record &displayFormats() const

virtual const Record &nulls() const

virtual Bool pastEnd() const

is this now past the end of the FITS table?

virtual void next()

advance to the next row

virtual const Record &currentRow() const

return the current row

virtual const Record &unhandledKeywords()

the unhandled keywords

virtual void handleKeyword(const String &kwname)

mark a keyword as handled

virtual const Record &unhandledFields()

the unhandled fields in currentRow

virtual void handleField(const String &fieldname)

mark a field in currentRow as being handled

virtual const Table &sampler() const

the ancilliary tables - empty tables when not present

virtual const GBTStateTable &state() const

virtual const Table &actState() const

virtual const Table &port() const

virtual uInt nrow() const

virtual uInt rownr() const

virtual const String &fitsVers() const

FITSVER - FITS definition version for this device. Default value: "0.0"

virtual Int baseVersion() const

Leading integer (before decimal) in FITSVER - version of base class.

virtual Int deviceVersion() const

Trailing integer (after decimal) in FITS - version of device.

void clear_self(Bool resync=False)

Table *tableFromFITS(FITSTable &fits)

construct a Table from a FITSTable, it is the responsiblity of the calling entity to delete the returned pointer the constructed table is a Scratch table using the AipsIO storage manager

void initUnhandledKeys()

void initUnhandledFields()

GBTBackendTable(const GBTBackendTable &)

Undefined and inaccessible.

GBTBackendTable &operator=(const GBTBackendTable &)