casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Types | Public Member Functions | Static Public Member Functions | Friends
casa::MBaseline Class Reference

A Measure: Baseline on Earth. More...

#include <MBaseline.h>

Inheritance diagram for casa::MBaseline:
casa::MeasBase< MVBaseline, MeasRef< MBaseline > > casa::Measure

List of all members.

Public Types

enum  Types {
  J2000,
  JMEAN,
  JTRUE,
  APP,
  B1950,
  B1950_VLA,
  BMEAN,
  BTRUE,
  GALACTIC,
  HADEC,
  AZEL,
  AZELSW,
  AZELGEO,
  AZELSWGEO,
  JNAT,
  ECLIPTIC,
  MECLIPTIC,
  TECLIPTIC,
  SUPERGAL,
  ITRF,
  TOPO,
  ICRS,
  N_Types,
  DEFAULT,
  AZELNE,
  AZELNEGEO
}
 Types of known MBaselines
Warning: The order defines the order in the translation matrix FromTo in the getConvert routine; Do not change the order without changing the array; Additions should be made before N_types, and an additional row and column should be coded in FromTo, and in showType();
More...
typedef MVBaseline MVType
 Measure value container for this class (i.e.
typedef MCBaseline MCType
 Measure conversion routines for this class (i.e.
typedef MeasRef< MBaselineRef
 Measure reference (i.e.
typedef MeasConvert< MBaselineConvert
 Measure Convert (i.e.
typedef ScalarMeasColumn
< MBaseline
ScalarColumn
 Measure table Columns (e.g., MBaseline::ScalarColumn)
typedef ArrayMeasColumn
< MBaseline
ArrayColumn

Public Member Functions

typedef WHATEVER_SUN_TYPEDEF (MBaseline) Types Types
 Reference enum Types (included originally for gcc 2.95)
 MBaseline ()
 
Tip: In the following constructors and other functions, all MeasRef can be replaced with simple Measure::TYPE where no offsets or frames are needed in the reference;
Default constructor; generates the ITRF centre
 MBaseline (const MVBaseline &dt)
 Create from data and reference.
 MBaseline (const MVBaseline &dt, const MBaseline::Ref &rf)
 MBaseline (const MVBaseline &dt, MBaseline::Types rf)
 MBaseline (const Measure *dt)
 MBaseline (const MeasValue *dt)
 MBaseline (const MBaseline &)
 
     

MBaselineoperator= (const MBaseline &)
virtual ~MBaseline ()
 
    

virtual const StringtellMe () const
 Tell me your type.
virtual uInt type () const
 Get the type (== Register() of derived Measure (faster than Strings) All should have: static uInt myType();.
Bool giveMe (MBaseline::Ref &mr, const String &in)
virtual Bool setOffset (const Measure &in)
 Set the offset in the reference (False if non-matching Measure)
virtual Bool setRefString (const String &in)
 Set the reference type to the specified String.
virtual const StringgetDefaultType () const
 Get the default reference type.
virtual const StringallTypes (Int &nall, Int &nextra, const uInt *&typ) const
 Get a list of all known reference codes.
virtual void checkTypes () const
 Check if all internal tables of types (both enum and String) are complete and correct.
virtual String getRefString () const
 Get the reference type (for records, including codes like R_)
Quantum< Vector< Double > > get (const Unit &inunit) const
 Get Measure data.
Quantum< Vector< Double > > getAngle () const
Quantum< Vector< Double > > getAngle (const Unit &inunit) const
virtual Measureclone () const
 Make copy.

Static Public Member Functions

static const StringshowMe ()
static void assure (const Measure &in)
static MBaseline::Types castType (uInt tp)
 Translate reference code.
static const StringshowType (MBaseline::Types tp)
static const StringshowType (uInt tp)
static Bool getType (MBaseline::Types &tp, const String &in)
 Translate string to reference code.
static const StringallMyTypes (Int &nall, Int &nextra, const uInt *&typ)
static void checkMyTypes ()
static MBaseline::Types fromDirType (const MDirection::Types in)
 Get the correct MBaseline type from a given direction type (or v.v.)
static MDirection::Types toDirType (const MBaseline::Types in)
static uInt myType ()
 Get my type (as Register)

Friends

class MeasConvert< MBaseline >
 Conversion of data.

Detailed Description

A Measure: Baseline on Earth.

Intended use:

Public interface

 <h3>Review Status</h3><dl><dt>Reviewed By:<dd>UNKNOWN<dt>Date Reviewed:<dd>before2004/08/25<dt>Test programs:<dd>tMBaseline</dl> 

Prerequisite

Etymology

From Measure and Baseline

Synopsis

MBaseline forms derived Measure class for an interferometer baseline. Baselines can be given in any of the direction types, or as ITRF, the IERS base.
Note that at the moment no correction for Earth tides (error <~ 0.05 mm/km EW baseline), plate motion (not relevant for telescopes on same plate) and relativistic effects are incorporated. B1950 has the same caveat as in MDirection .

Example

Motivation

To Do

Definition at line 85 of file MBaseline.h.


Member Typedef Documentation

Definition at line 141 of file MBaseline.h.

Measure Convert (i.e.

MBaseline::Convert)

Reimplemented from casa::Measure.

Definition at line 138 of file MBaseline.h.

Measure conversion routines for this class (i.e.

MBaseline::MCType)

Definition at line 134 of file MBaseline.h.

Measure value container for this class (i.e.

MBaseline::MVType)

Definition at line 132 of file MBaseline.h.

Measure reference (i.e.

MBaseline::Ref)

Definition at line 136 of file MBaseline.h.

Measure table Columns (e.g., MBaseline::ScalarColumn)

Definition at line 140 of file MBaseline.h.


Member Enumeration Documentation

Types of known MBaselines
Warning: The order defines the order in the translation matrix FromTo in the getConvert routine; Do not change the order without changing the array; Additions should be made before N_types, and an additional row and column should be coded in FromTo, and in showType();

Enumerator:
J2000 
JMEAN 
JTRUE 
APP 
B1950 
B1950_VLA 
BMEAN 
BTRUE 
GALACTIC 
HADEC 
AZEL 
AZELSW 
AZELGEO 
AZELSWGEO 
JNAT 
ECLIPTIC 
MECLIPTIC 
TECLIPTIC 
SUPERGAL 
ITRF 
TOPO 
ICRS 
N_Types 
DEFAULT 

Defaults.

AZELNE 

Synonyms.

AZELNEGEO 

Reimplemented from casa::Measure.

Definition at line 100 of file MBaseline.h.


Constructor & Destructor Documentation


Tip: In the following constructors and other functions, all MeasRef can be replaced with simple Measure::TYPE where no offsets or frames are needed in the reference;
Default constructor; generates the ITRF centre

Create from data and reference.

casa::MBaseline::MBaseline ( const MVBaseline dt,
const MBaseline::Ref rf 
)

     

virtual casa::MBaseline::~MBaseline ( ) [virtual]

    


Member Function Documentation

static const String* casa::MBaseline::allMyTypes ( Int nall,
Int nextra,
const uInt *&  typ 
) [static]
virtual const String* casa::MBaseline::allTypes ( Int nall,
Int nextra,
const uInt *&  typ 
) const [virtual]

Get a list of all known reference codes.

nall returns the number in list, nextra the number of specials (like planets) that should be at end of list). typ returns the list of corresponding types.

Reimplemented from casa::Measure.

static void casa::MBaseline::assure ( const Measure in) [static]

Translate reference code.

The uInt version has a check for valid codes (i.e. it is a safe cast).

Thrown Exceptions

  • AipsError in the uInt interface if illegal code given
static void casa::MBaseline::checkMyTypes ( ) [static]
virtual void casa::MBaseline::checkTypes ( ) const [virtual]

Check if all internal tables of types (both enum and String) are complete and correct.

This function is called automatically if and when necessary.

Thrown Exceptions

  • AipsError if a (programming) error in the types.

Implements casa::Measure.

virtual Measure* casa::MBaseline::clone ( ) const [virtual]

Make copy.

Implements casa::Measure.

Get the correct MBaseline type from a given direction type (or v.v.)

Quantum<Vector<Double> > casa::MBaseline::get ( const Unit inunit) const

Get Measure data.

Quantum<Vector<Double> > casa::MBaseline::getAngle ( const Unit inunit) const
virtual const String& casa::MBaseline::getDefaultType ( ) const [virtual]

Get the default reference type.

Implements casa::Measure.

virtual String casa::MBaseline::getRefString ( ) const [virtual]

Get the reference type (for records, including codes like R_)

Implements casa::Measure.

static Bool casa::MBaseline::getType ( MBaseline::Types tp,
const String in 
) [static]

Translate string to reference code.

Bool casa::MBaseline::giveMe ( MBaseline::Ref mr,
const String in 
)
static uInt casa::MBaseline::myType ( ) [static]

Get my type (as Register)

MBaseline& casa::MBaseline::operator= ( const MBaseline )
virtual Bool casa::MBaseline::setOffset ( const Measure in) [virtual]

Set the offset in the reference (False if non-matching Measure)

Implements casa::Measure.

virtual Bool casa::MBaseline::setRefString ( const String in) [virtual]

Set the reference type to the specified String.

False if illegal string, reference set to DEFAULT.

Implements casa::Measure.

static const String& casa::MBaseline::showMe ( ) [static]
static const String& casa::MBaseline::showType ( MBaseline::Types  tp) [static]
static const String& casa::MBaseline::showType ( uInt  tp) [static]
virtual const String& casa::MBaseline::tellMe ( ) const [virtual]

Tell me your type.

Implements casa::Measure.

virtual uInt casa::MBaseline::type ( ) const [virtual]

Get the type (== Register() of derived Measure (faster than Strings) All should have: static uInt myType();.

Implements casa::Measure.

Reference enum Types (included originally for gcc 2.95)


Friends And Related Function Documentation

friend class MeasConvert< MBaseline > [friend]

Conversion of data.

Definition at line 90 of file MBaseline.h.


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