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::MPosition Class Reference

A Measure: position on Earth. More...

#include <MPosition.h>

Inheritance diagram for casa::MPosition:
casa::MeasBase< MVPosition, MeasRef< MPosition > > casa::Measure

List of all members.

Public Types

enum  Types {
  ITRF,
  WGS84,
  N_Types,
  DEFAULT
}
 Types of known MPositions
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 MVPosition MVType
 Measure value container for this class (i.e.
typedef MCPosition MCType
 Measure conversion routines for this class (i.e.
typedef MeasRef< MPositionRef
 Measure reference (i.e.
typedef MeasConvert< MPositionConvert
 Measure Convert (i.e.
typedef ScalarMeasColumn
< MPosition
ScalarColumn
 Measure table Columns (e.g., MPosition::ScalarColumn)
typedef ArrayMeasColumn
< MPosition
ArrayColumn

Public Member Functions

typedef WHATEVER_SUN_TYPEDEF (MPosition) Types Types
 Reference enum Types (included originally for gcc 2.95)
 MPosition ()
 
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
 MPosition (const MVPosition &dt)
 Create from data and reference.
 MPosition (const MVPosition &dt, const MPosition::Ref &rf)
 MPosition (const MVPosition &dt, MPosition::Types rf)
 MPosition (const Quantity &dt, const Quantity &dt1, const Quantity &dt2)
 MPosition (const Quantity &dt, const Quantity &dt1, const Quantity &dt2, const MPosition::Ref &rf)
 MPosition (const Quantity &dt, const Quantity &dt1, const Quantity &dt2, MPosition::Types rf)
 MPosition (const Quantity &dt0, const Quantum< Vector< Double > > &dt)
 MPosition (const Quantity &dt0, const Quantum< Vector< Double > > &dt, const MPosition::Ref &rf)
 MPosition (const Quantity &dt0, const Quantum< Vector< Double > > &dt, MPosition::Types rf)
 MPosition (const Measure *dt)
 MPosition (const MeasValue *dt)
 MPosition (const MPosition &)
 
     

MPositionoperator= (const MPosition &)
virtual ~MPosition ()
 
    

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 (MPosition::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 MPosition::Types castType (uInt tp)
 Translate reference code.
static const StringshowType (MPosition::Types tp)
static const StringshowType (uInt tp)
static Bool getType (MPosition::Types &tp, const String &in)
 Translate string to reference code.
static MPosition::Types getType (const String &in)
 this one throws an exception for an unrecognized String
static const StringallMyTypes (Int &nall, Int &nextra, const uInt *&typ)
static void checkMyTypes ()
static uInt myType ()
 Get my type (as Register)

Friends

class MeasConvert< MPosition >
 Conversion of data.

Detailed Description

A Measure: position on Earth.

Intended use:

Public interface

Review Status

Reviewed By:
UNKNOWN
Date Reviewed:
before2004/08/25
Test programs:
tMeasure

Prerequisite

Etymology

Synopsis

MPosition forms derived Measure class for an instant in time.

Example

Motivation

To Do

Definition at line 79 of file MPosition.h.


Member Typedef Documentation

Definition at line 111 of file MPosition.h.

Measure Convert (i.e.

MPosition::Convert)

Reimplemented from casa::Measure.

Definition at line 108 of file MPosition.h.

Measure conversion routines for this class (i.e.

MPosition::MCType)

Definition at line 104 of file MPosition.h.

Measure value container for this class (i.e.

MPosition::MVType)

Definition at line 102 of file MPosition.h.

Measure reference (i.e.

MPosition::Ref)

Definition at line 106 of file MPosition.h.

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

Definition at line 110 of file MPosition.h.


Member Enumeration Documentation

Types of known MPositions
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:
ITRF 
WGS84 
N_Types 
DEFAULT 

Reimplemented from casa::Measure.

Definition at line 94 of file MPosition.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::MPosition::MPosition ( const MVPosition dt,
const MPosition::Ref rf 
)
casa::MPosition::MPosition ( const Quantity dt,
const Quantity dt1,
const Quantity dt2 
)
casa::MPosition::MPosition ( const Quantity dt,
const Quantity dt1,
const Quantity dt2,
const MPosition::Ref rf 
)
casa::MPosition::MPosition ( const Quantity dt,
const Quantity dt1,
const Quantity dt2,
MPosition::Types  rf 
)
casa::MPosition::MPosition ( const Quantity dt0,
const Quantum< Vector< Double > > &  dt 
)
casa::MPosition::MPosition ( const Quantity dt0,
const Quantum< Vector< Double > > &  dt,
const MPosition::Ref rf 
)
casa::MPosition::MPosition ( const Quantity dt0,
const Quantum< Vector< Double > > &  dt,
MPosition::Types  rf 
)

     

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

    


Member Function Documentation

static const String* casa::MPosition::allMyTypes ( Int nall,
Int nextra,
const uInt *&  typ 
) [static]
virtual const String* casa::MPosition::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::MPosition::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::MPosition::checkMyTypes ( ) [static]
virtual void casa::MPosition::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::MPosition::clone ( ) const [virtual]

Make copy.

Implements casa::Measure.

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

Get Measure data.

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

Get the default reference type.

Implements casa::Measure.

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

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

Implements casa::Measure.

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

Translate string to reference code.

static MPosition::Types casa::MPosition::getType ( const String in) [static]

this one throws an exception for an unrecognized String

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

Get my type (as Register)

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

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

Implements casa::Measure.

virtual Bool casa::MPosition::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::MPosition::showMe ( ) [static]
static const String& casa::MPosition::showType ( MPosition::Types  tp) [static]
static const String& casa::MPosition::showType ( uInt  tp) [static]
virtual const String& casa::MPosition::tellMe ( ) const [virtual]

Tell me your type.

Implements casa::Measure.

virtual uInt casa::MPosition::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< MPosition > [friend]

Conversion of data.

Definition at line 84 of file MPosition.h.


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