GBTGOFile Class Reference

GBTGOFile serves up the information from a GBT GO FITS file. More...

#include <GBTGOFile.h>

Inheritance diagram for GBTGOFile:

List of all members.

Public Member Functions
	GBTGOFile ()
	initialize with default values, no primary keywords
	GBTGOFile (const String &gofile)
	initialize with the indicated GO file.
	~GBTGOFile ()
Bool	attach (const String &gofile)
	attach this object to a new FITS file.
const String &	file () const
	the file name used at construction or most recent reopen
Bool	isValid () const
	is this a valid GO file (only consists of a null array PDA with no extensions).
Bool	isAttached () const
	is this attached to a FITS file
const String &	observer () const
	standard fields - these are NOT marked as handled.
const String &	procname () const
const String &	proctype () const
Int	procseqn () const
Int	procsize () const
const String	obstype () const
const String &	swtchsig () const
const String &	swstate () const
Int	laston () const
Int	lastoff () const
const MDirection &	refdir () const
	reference direction - this includes the RADESYS, RA, DEC and COORDSYS keywords.
const Double &	equinox () const
const MVFrequency &	restfrq () const
	rest frequency - incorporates RESTFRQ and VELDEF values.
const MRadialVelocity &	velocity () const
	Velocity of line being tracked - incorporates VELOCITY and VELDEF values.
const MVFrequency &	skyfreq () const
	intended sky frequency
const String &	coordsys () const
	the raw keyword values as found in the GO file
const String &	radesys () const
const Double &	majorCoord () const
const Double &	minorCoord () const
const Double &	velocityKW () const
const String &	veldef () const
Bool	isDoppler () const
	Does this have the doppler keywords, otherwise it will have the SKYFREQ keyword.
Bool	isOtherCoordsys () const
	Does this use the OTHER coordinate system? If so, the refdir direction is not useful.
Private Member Functions
void	init ()
	fill in the default values, clean up internals
	GBTGOFile (const GBTGOFile &other)
	unavailable
GBTGOFile &	operator= (const GBTGOFile &other)
Private Attributes
Bool	itsValid
Bool	itsAttached
Int	itsProcseqn
Int	itsProcsize
Int	itsLaston
Int	itsLastoff
String	itsObserver
String	itsProcname
String	itsProctype
String	itsSwtchsig
String	itsName
String	itsObstype
String	itsSwstate
String	itsCoordsys
String	itsRadesys
String	itsVeldef
MDirection	itsCmddir
Double	itsEquinox
Double	itsMajor
Double	itsMinor
Double	itsVelocityKW
MRadialVelocity	itsVelocity
MVFrequency	itsRestfrq
MVFrequency	itsSkyfrq
Bool	itsDoppler
Bool	itsOtherCoordsys
MeasFrame	itsFrame

---

Detailed Description

GBTGOFile serves up the information from a GBT GO FITS file.

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Etymology

Synopsis

Example

Motivation

Thrown Exceptions

Definition at line 80 of file GBTGOFile.h.

---

Constructor & Destructor Documentation

GBTGOFile::GBTGOFile

(

)

initialize with default values, no primary keywords

GBTGOFile::GBTGOFile

(

const String &

gofile

)

initialize with the indicated GO file.

GBTGOFile::~GBTGOFile

(

)

[inline]

Definition at line 89 of file GBTGOFile.h.

GBTGOFile::GBTGOFile

(

const GBTGOFile &

other

)

[private]

unavailable

---

Member Function Documentation

Bool GBTGOFile::attach

(

const String &

gofile

)

[virtual]

attach this object to a new FITS file.

If there are problems with the file, the return value is Falso and appropriate warnings are sent to the logger. The resulting object is not attached to any file.

Implements GBTFITSBase.

const String& GBTGOFile::coordsys

(

)

const [inline]

the raw keyword values as found in the GO file

Definition at line 134 of file GBTGOFile.h.

References itsCoordsys.

const Double& GBTGOFile::equinox

(

)

const [inline]

Definition at line 122 of file GBTGOFile.h.

References itsEquinox.

const String& GBTGOFile::file

(

)

const [inline, virtual]

the file name used at construction or most recent reopen

Implements GBTFITSBase.

Definition at line 97 of file GBTGOFile.h.

References itsName.

void GBTGOFile::init

(

)

[private]

fill in the default values, clean up internals

Reimplemented from GBTFITSBase.

Bool GBTGOFile::isAttached

(

)

const [inline, virtual]

is this attached to a FITS file

Reimplemented from GBTFITSBase.

Definition at line 104 of file GBTGOFile.h.

References itsAttached.

Bool GBTGOFile::isDoppler

(

)

const [inline]

Does this have the doppler keywords, otherwise it will have the SKYFREQ keyword.

Definition at line 144 of file GBTGOFile.h.

References itsDoppler.

Bool GBTGOFile::isOtherCoordsys

(

)

const [inline]

Does this use the OTHER coordinate system? If so, the refdir direction is not useful.

Definition at line 148 of file GBTGOFile.h.

References itsOtherCoordsys.

Bool GBTGOFile::isValid

(

)

const [inline]

is this a valid GO file (only consists of a null array PDA with no extensions).

Definition at line 101 of file GBTGOFile.h.

References itsValid.

Int GBTGOFile::lastoff

(

)

const [inline]

Definition at line 118 of file GBTGOFile.h.

References itsLastoff.

Int GBTGOFile::laston

(

)

const [inline]

Definition at line 117 of file GBTGOFile.h.

References itsLaston.

const Double& GBTGOFile::majorCoord

(

)

const [inline]

Definition at line 136 of file GBTGOFile.h.

References itsMajor.

const Double& GBTGOFile::minorCoord

(

)

const [inline]

Definition at line 137 of file GBTGOFile.h.

References itsMinor.

const String& GBTGOFile::observer

(

)

const [inline]

standard fields - these are NOT marked as handled.

handleKeyword must be used for that.

Definition at line 109 of file GBTGOFile.h.

References itsObserver.

const String GBTGOFile::obstype

(

)

const [inline]

Definition at line 114 of file GBTGOFile.h.

References itsObstype.

GBTGOFile& GBTGOFile::operator=

(

const GBTGOFile &

other

)

[private]

const String& GBTGOFile::procname

(

)

const [inline]

Definition at line 110 of file GBTGOFile.h.

References itsProcname.

Int GBTGOFile::procseqn

(

)

const [inline]

Definition at line 112 of file GBTGOFile.h.

References itsProcseqn.

Int GBTGOFile::procsize

(

)

const [inline]

Definition at line 113 of file GBTGOFile.h.

References itsProcsize.

const String& GBTGOFile::proctype

(

)

const [inline]

Definition at line 111 of file GBTGOFile.h.

References itsProctype.

const String& GBTGOFile::radesys

(

)

const [inline]

Definition at line 135 of file GBTGOFile.h.

References itsRadesys.

const MDirection& GBTGOFile::refdir

(

)

const [inline]

reference direction - this includes the RADESYS, RA, DEC and COORDSYS keywords.

Definition at line 121 of file GBTGOFile.h.

References itsCmddir.

const MVFrequency& GBTGOFile::restfrq

(

)

const [inline]

rest frequency - incorporates RESTFRQ and VELDEF values.

Definition at line 124 of file GBTGOFile.h.

References itsRestfrq.

const MVFrequency& GBTGOFile::skyfreq

(

)

const [inline]

intended sky frequency

Definition at line 130 of file GBTGOFile.h.

References itsSkyfrq.

const String& GBTGOFile::swstate

(

)

const [inline]

Definition at line 116 of file GBTGOFile.h.

References itsSwstate.

const String& GBTGOFile::swtchsig

(

)

const [inline]

Definition at line 115 of file GBTGOFile.h.

References itsSwtchsig.

const String& GBTGOFile::veldef

(

)

const [inline]

Definition at line 139 of file GBTGOFile.h.

References itsVeldef.

const MRadialVelocity& GBTGOFile::velocity

(

)

const [inline]

Velocity of line being tracked - incorporates VELOCITY and VELDEF values.

Definition at line 126 of file GBTGOFile.h.

References itsVelocity.

const Double& GBTGOFile::velocityKW

(

)

const [inline]

Definition at line 138 of file GBTGOFile.h.

References itsVelocityKW.

---

Member Data Documentation

Bool GBTGOFile::itsAttached [private]

Definition at line 150 of file GBTGOFile.h.

Referenced by isAttached().

MDirection GBTGOFile::itsCmddir [private]

Definition at line 157 of file GBTGOFile.h.

Referenced by refdir().

String GBTGOFile::itsCoordsys [private]

Definition at line 154 of file GBTGOFile.h.

Referenced by coordsys().

Bool GBTGOFile::itsDoppler [private]

Definition at line 164 of file GBTGOFile.h.

Referenced by isDoppler().

Double GBTGOFile::itsEquinox [private]

Definition at line 159 of file GBTGOFile.h.

Referenced by equinox().

MeasFrame GBTGOFile::itsFrame [private]

Definition at line 166 of file GBTGOFile.h.

Int GBTGOFile::itsLastoff [private]

Definition at line 152 of file GBTGOFile.h.

Referenced by lastoff().

Int GBTGOFile::itsLaston [private]

Definition at line 152 of file GBTGOFile.h.

Referenced by laston().

Double GBTGOFile::itsMajor [private]

Definition at line 159 of file GBTGOFile.h.

Referenced by majorCoord().

Double GBTGOFile::itsMinor [private]

Definition at line 159 of file GBTGOFile.h.

Referenced by minorCoord().

String GBTGOFile::itsName [private]

Definition at line 154 of file GBTGOFile.h.

Referenced by file().

String GBTGOFile::itsObserver [private]

Definition at line 154 of file GBTGOFile.h.

Referenced by observer().

String GBTGOFile::itsObstype [private]

Definition at line 154 of file GBTGOFile.h.

Referenced by obstype().

Bool GBTGOFile::itsOtherCoordsys [private]

Definition at line 164 of file GBTGOFile.h.

Referenced by isOtherCoordsys().

String GBTGOFile::itsProcname [private]

Definition at line 154 of file GBTGOFile.h.

Referenced by procname().

Int GBTGOFile::itsProcseqn [private]

Definition at line 152 of file GBTGOFile.h.

Referenced by procseqn().

Int GBTGOFile::itsProcsize [private]

Definition at line 152 of file GBTGOFile.h.

Referenced by procsize().

String GBTGOFile::itsProctype [private]

Definition at line 154 of file GBTGOFile.h.

Referenced by proctype().

String GBTGOFile::itsRadesys [private]

Definition at line 154 of file GBTGOFile.h.

Referenced by radesys().

MVFrequency GBTGOFile::itsRestfrq [private]

Definition at line 162 of file GBTGOFile.h.

Referenced by restfrq().

MVFrequency GBTGOFile::itsSkyfrq [private]

Definition at line 162 of file GBTGOFile.h.

Referenced by skyfreq().

String GBTGOFile::itsSwstate [private]

Definition at line 154 of file GBTGOFile.h.

Referenced by swstate().

String GBTGOFile::itsSwtchsig [private]

Definition at line 154 of file GBTGOFile.h.

Referenced by swtchsig().

Bool GBTGOFile::itsValid [private]

Definition at line 150 of file GBTGOFile.h.

Referenced by isValid().

String GBTGOFile::itsVeldef [private]

Definition at line 154 of file GBTGOFile.h.

Referenced by veldef().

MRadialVelocity GBTGOFile::itsVelocity [private]

Definition at line 161 of file GBTGOFile.h.

Referenced by velocity().

Double GBTGOFile::itsVelocityKW [private]

Definition at line 159 of file GBTGOFile.h.

Referenced by velocityKW().

---

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

• code/nrao/FITS/GBTGOFile.h