Attach a FITSTabular to a GBT backend FITS file. More...

#include <GBTBackendTable.h>

Inheritance diagram for GBTBackendTable:

Public Member Functions
	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.
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.
virtual uInt	nsamp () const
	The number of elements along the sampler axis.
virtual Double	bw (uInt whichSampler) const
	The bandwidth for the indicated sampler.
virtual Double	centerIF (uInt whichSampler) const
	The center IF for the indicated sampler.
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.
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.
Private Member Functions
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 &)
Private Attributes
GBTScanLogReader::BACKENDS	itsType
FITSTable *	dataTable_p
Table *	sampler_p
Table *	actState_p
Table *	port_p
GBTStateTable	state_p
TableRecord	keywords_p
Record *	unhandledKeys_p
Record *	unhandledFields_p
CopyRecordToRecord *	fieldCopier_p
Vector< Int >	keyMap_p
Vector< Int >	fieldMap_p
Vector< Double >	itsBW
Vector< Double >	itsCenterIF
Vector< Bool >	itsIncreases
Bool	isValid_p
uInt	itsNstate
uInt	itsNchan
uInt	itsNsamp
String	itsFitsVer
Int	itsBaseVer
Int	itsDeviceVer

Detailed Description

Attach a FITSTabular to a GBT backend FITS file.

Intended use:

Public interface

Review Status

Date Reviewed:: yyyy/mm/dd

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

Definition at line 78 of file GBTBackendTable.h.

Constructor & Destructor Documentation

GBTBackendTable::GBTBackendTable ( )

Default constructor, not attached to any specific file.

GBTBackendTable::GBTBackendTable ( const String & fileName )

Construct it from a file name.

GBTBackendTable::~GBTBackendTable ( )

GBTBackendTable::GBTBackendTable ( const GBTBackendTable & ) [private]

Undefined and inaccessible.

Member Function Documentation

virtual const Table& GBTBackendTable::actState ( ) const [inline, virtual]

Reimplemented in GBTMultiACSTable.

Definition at line 175 of file GBTBackendTable.h.

References actState_p.

Referenced by GBTMultiACSTable::actState().

virtual Int GBTBackendTable::baseVersion ( ) const [inline, virtual]

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

Reimplemented in GBTMultiACSTable.

Definition at line 186 of file GBTBackendTable.h.

References itsBaseVer.

Referenced by GBTMultiACSTable::baseVersion(), and GBTACSTable::switchOK().

virtual Double GBTBackendTable::bw ( uInt whichSampler ) const [inline, virtual]

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.

Reimplemented in GBTMultiACSTable.

Definition at line 124 of file GBTBackendTable.h.

References itsBW.

virtual Double GBTBackendTable::centerIF ( uInt whichSampler ) const [inline, virtual]

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.

Reimplemented in GBTMultiACSTable.

Definition at line 129 of file GBTBackendTable.h.

References itsCenterIF.

void GBTBackendTable::clear_self ( Bool resync = False ) [private]

virtual const Record& GBTBackendTable::currentRow ( ) const [inline, virtual]

return the current row

Reimplemented in GBTMultiACSTable.

Definition at line 152 of file GBTBackendTable.h.

References dataTable_p.

Referenced by GBTMultiACSTable::currentRow().

virtual const RecordDesc& GBTBackendTable::description ( ) const [inline, virtual]

Reimplemented in GBTMultiACSTable.

Definition at line 138 of file GBTBackendTable.h.

References dataTable_p.

Referenced by GBTMultiACSTable::description().

virtual Int GBTBackendTable::deviceVersion ( ) const [inline, virtual]

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

Reimplemented in GBTMultiACSTable.

Definition at line 189 of file GBTBackendTable.h.

References itsDeviceVer.

Referenced by GBTMultiACSTable::deviceVersion(), and GBTACSTable::switchOK().

virtual const Record& GBTBackendTable::displayFormats ( ) const [inline, virtual]

Reimplemented in GBTMultiACSTable.

Definition at line 140 of file GBTBackendTable.h.

References dataTable_p.

Referenced by GBTMultiACSTable::displayFormats().

virtual const String& GBTBackendTable::fitsVers ( ) const [inline, virtual]

FITSVER - FITS definition version for this device.

Default value: "0.0"

Reimplemented in GBTMultiACSTable.

Definition at line 183 of file GBTBackendTable.h.

References itsFitsVer.

Referenced by GBTMultiACSTable::fitsVers().

virtual void GBTBackendTable::handleField ( const String & fieldname ) [virtual]

mark a field in currentRow as being handled

Reimplemented in GBTMultiACSTable.

Referenced by GBTMultiACSTable::handleField().

virtual void GBTBackendTable::handleKeyword ( const String & kwname ) [virtual]

mark a keyword as handled

Reimplemented in GBTMultiACSTable.

Referenced by GBTMultiACSTable::handleKeyword().

virtual Bool GBTBackendTable::increases ( uInt whichSampler ) const [inline, virtual]

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

Reimplemented in GBTMultiACSTable.

Definition at line 133 of file GBTBackendTable.h.

References itsIncreases.

void GBTBackendTable::initUnhandledFields ( ) [private]

Referenced by unhandledFields().

void GBTBackendTable::initUnhandledKeys ( ) [private]

Referenced by unhandledKeywords().

virtual Bool GBTBackendTable::isValid ( ) const [inline, virtual]

is this a valid GBTBackendTable?

Reimplemented in GBTACSTable, and GBTMultiACSTable.

Definition at line 105 of file GBTBackendTable.h.

References isValid_p.

virtual const TableRecord& GBTBackendTable::keywords ( ) const [inline, virtual]

these keywords associated with the FITS data table.

Reimplemented in GBTMultiACSTable.

Definition at line 136 of file GBTBackendTable.h.

References keywords_p.

Referenced by GBTMultiACSTable::keywords().

virtual const String& GBTBackendTable::name ( ) const [inline, virtual]

return the name of the underlying table used at construction

Reimplemented in GBTMultiACSTable.

Definition at line 102 of file GBTBackendTable.h.

References dataTable_p.

Referenced by GBTMultiACSTable::name().

virtual uInt GBTBackendTable::nchan ( uInt whichSampler ) const [inline, virtual]

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.

Reimplemented in GBTMultiACSTable.

Definition at line 116 of file GBTBackendTable.h.

References itsNchan.

virtual void GBTBackendTable::next ( ) [inline, virtual]

advance to the next row

Reimplemented in GBTMultiACSTable.

Definition at line 147 of file GBTBackendTable.h.

References dataTable_p, and fieldCopier_p.

virtual uInt GBTBackendTable::nrow ( ) const [inline, virtual]

Reimplemented in GBTMultiACSTable.

Definition at line 178 of file GBTBackendTable.h.

References dataTable_p.

Referenced by GBTMultiACSTable::nrow().

virtual uInt GBTBackendTable::nsamp ( ) const [inline, virtual]

The number of elements along the sampler axis.

Definition at line 119 of file GBTBackendTable.h.

References itsNsamp.

virtual uInt GBTBackendTable::nstate ( ) const [inline, virtual]

The number of elements along the STATE axis.

Reimplemented in GBTMultiACSTable.

Definition at line 108 of file GBTBackendTable.h.

References itsNstate.

Referenced by GBTMultiACSTable::nstate().

virtual const Record& GBTBackendTable::nulls ( ) const [inline, virtual]

Reimplemented in GBTMultiACSTable.

Definition at line 141 of file GBTBackendTable.h.

References dataTable_p.

Referenced by GBTMultiACSTable::nulls().

GBTBackendTable& GBTBackendTable::operator= ( const GBTBackendTable & ) [private]

virtual Bool GBTBackendTable::pastEnd ( ) const [inline, virtual]

is this now past the end of the FITS table?

Definition at line 144 of file GBTBackendTable.h.

References dataTable_p.

virtual const Table& GBTBackendTable::port ( ) const [inline, virtual]

Reimplemented in GBTMultiACSTable.

Definition at line 176 of file GBTBackendTable.h.

References port_p.

virtual Bool GBTBackendTable::reopen	(	const String &	fileName,
		Bool	resync
	)		`[virtual]`

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

Reimplemented in GBTACSTable, and GBTMultiACSTable.

virtual Bool GBTBackendTable::reopen ( const String & fileName ) [inline, virtual]

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

Reimplemented in GBTACSTable, and GBTMultiACSTable.

Definition at line 96 of file GBTBackendTable.h.

References reopen(), and casa::True.

Referenced by reopen().

virtual uInt GBTBackendTable::rownr ( ) const [inline, virtual]

Reimplemented in GBTMultiACSTable.

Definition at line 179 of file GBTBackendTable.h.

References dataTable_p.

Referenced by GBTMultiACSTable::rownr().

virtual const Table& GBTBackendTable::sampler ( ) const [inline, virtual]

the ancilliary tables - empty tables when not present

Reimplemented in GBTMultiACSTable.

Definition at line 173 of file GBTBackendTable.h.

References sampler_p.

virtual const GBTStateTable& GBTBackendTable::state ( ) const [inline, virtual]

Reimplemented in GBTMultiACSTable.

Definition at line 174 of file GBTBackendTable.h.

References state_p.

Referenced by GBTMultiACSTable::state().

Table* GBTBackendTable::tableFromFITS ( FITSTable & fits ) [private]

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

GBTScanLogReader::BACKENDS GBTBackendTable::type ( ) const [inline]

Return the type of this backend.

Reimplemented in GBTMultiACSTable.

Definition at line 99 of file GBTBackendTable.h.

References itsType.

virtual const Record& GBTBackendTable::unhandledFields ( ) [inline, virtual]

the unhandled fields in currentRow

Reimplemented in GBTMultiACSTable.

Definition at line 164 of file GBTBackendTable.h.

References initUnhandledFields(), and unhandledFields_p.

Referenced by GBTMultiACSTable::unhandledFields().

virtual const Record& GBTBackendTable::unhandledKeywords ( ) [inline, virtual]