casacore
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
casacore::MPosition Class Reference

A Measure: position on Earth. More...

#include <MPosition.h>

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

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. More...
 
typedef MCPosition MCType
 Measure conversion routines for this class (i.e. More...
 
typedef MeasRef< MPositionRef
 Measure reference (i.e. More...
 
typedef MeasConvert< MPositionConvert
 Measure Convert (i.e. More...
 
typedef ScalarMeasColumn
< MPosition
ScalarColumn
 Measure table Columns (e.g., MPosition::ScalarColumn) More...
 
typedef ArrayMeasColumn
< MPosition
ArrayColumn
 
- Public Types inherited from casacore::Measure
enum  Types {
  N_Types,
  DEFAULT
}
 Each derived class should have a Types enumeration, specifying the recognised frame types. More...
 
typedef void * Convert
 Each Measure should have typedefs of the form: More...
 

Public Member Functions

 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 More...
 
 MPosition (const MVPosition &dt)
 Create from data and reference. More...
 
 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. More...
 
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) More...
 
virtual Bool setRefString (const String &in)
 Set the reference type to the specified String. More...
 
virtual const StringgetDefaultType () const
 Get the default reference type. More...
 
virtual const StringallTypes (Int &nall, Int &nextra, const uInt *&typ) const
 Get a list of all known reference codes. More...
 
virtual void checkTypes () const
 Check if all internal tables of types (both enum and String) are complete and correct. More...
 
virtual String getRefString () const
 Get the reference type (for records, including codes like R_) More...
 
Quantum< Vector< Double > > get (const Unit &inunit) const
 Get Measure data. More...
 
Quantum< Vector< Double > > getAngle () const
 
Quantum< Vector< Double > > getAngle (const Unit &inunit) const
 
virtual Measureclone () const
 Make copy. More...
 
- Public Member Functions inherited from casacore::MeasBase< MVPosition, MeasRef< MPosition > >
 MeasBase ()
 
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; For reasons of compiler limitations the formal arguments had to be specified as uInt rather than the Measure enums that should be used as actual arguments;
Default constructor More...
 
 MeasBase (const MeasBase< MVPosition, MeasRef< MPosition > > &other)
 Copy constructor. More...
 
 MeasBase (const MVPosition &dt, const MeasRef< MPosition > &rf)
 Create from data and reference. More...
 
 MeasBase (const MVPosition &dt, uInt rf)
 
 MeasBase (const Quantity &dt, const MeasRef< MPosition > &rf)
 
 MeasBase (const Quantity &dt, uInt rf)
 
 MeasBase (const Measure *dt)
 
 MeasBase (const MeasRef< MPosition > &rf)
 
 MeasBase (const uInt rf)
 
MeasBase< MVPosition, MeasRef
< MPosition > > & 
operator= (const MeasBase< MVPosition, MeasRef< MPosition > > &other)
 Copy assignment. More...
 
virtual ~MeasBase ()
 
virtual Bool areYou (const String &tp) const
 Check the type of derived entity. More...
 
virtual void assured (const String &tp) const
 Assert that we are the correct type. More...
 
void set (const MVPosition &dt)
 Refill the specified entities. More...
 
void set (const MeasRef< MPosition > &rf)
 
void set (const MVPosition &dt, const MeasRef< MPosition > &rf)
 
void set (const Unit &inunit)
 
virtual void set (const MeasValue &dt)
 Each Measure should have the following set functions (with appropiate MVs and Ref): More...
 
virtual Bool putValue (const Vector< Quantum< Double > > &in)
 
MeasRef< MPositiongetRef () const
 Get reference. More...
 
const MVPositiongetValue () const
 Get Measure data. More...
 
const UnitgetUnit () const
 Get Unit. More...
 
virtual MRBasegetRefPtr () const
 Get reference pointer. More...
 
virtual const MeasValuegetData () const
 Get pointer to data. More...
 
virtual void print (std::ostream &os) const
 Print a Measure. More...
 
- Public Member Functions inherited from casacore::Measure
virtual ~Measure ()
 Destructor. More...
 
virtual Bool isModel () const
 Tell me if you are a pure model (e.g. More...
 
void dummy_giveMe () const
 Each derived class should have a string-to-code translation routine for the reference type. More...
 
void dummy_getRef () const
 Each class should have a function to return its reference: More...
 
void dummy_getValue () const
 Each derived class should be able to get its internal value and have: More...
 

Static Public Member Functions

static const StringshowMe ()
 
static void assure (const Measure &in)
 
static MPosition::Types castType (uInt tp)
 Translate reference code. More...
 
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. More...
 
static MPosition::Types getType (const String &in)
 this one throws an exception for an unrecognized String More...
 
static const StringallMyTypes (Int &nall, Int &nextra, const uInt *&typ)
 
static void checkMyTypes ()
 
- Static Public Member Functions inherited from casacore::Measure
static uInt giveMe (const String &in, Int N_name, const String tname[])
 A general string checking routine to be used in derived measures. More...
 

Friends

class MeasConvert< MPosition >
 Conversion of data. More...
 

Additional Inherited Members

- Protected Attributes inherited from casacore::MeasBase< MVPosition, MeasRef< MPosition > >
MVPosition data
 The measure value (e.g. More...
 
MeasRef< MPositionref
 Reference frame data. More...
 
Unit unit
 Possible input units. More...
 

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)

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 

Definition at line 94 of file MPosition.h.

Constructor & Destructor Documentation

casacore::MPosition::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

casacore::MPosition::MPosition ( const MVPosition dt)

Create from data and reference.

casacore::MPosition::MPosition ( const MVPosition dt,
const MPosition::Ref rf 
)
casacore::MPosition::MPosition ( const MVPosition dt,
MPosition::Types  rf 
)
casacore::MPosition::MPosition ( const Quantity dt,
const Quantity dt1,
const Quantity dt2 
)
casacore::MPosition::MPosition ( const Quantity dt,
const Quantity dt1,
const Quantity dt2,
const MPosition::Ref rf 
)
casacore::MPosition::MPosition ( const Quantity dt,
const Quantity dt1,
const Quantity dt2,
MPosition::Types  rf 
)
casacore::MPosition::MPosition ( const Quantity dt0,
const Quantum< Vector< Double > > &  dt 
)
casacore::MPosition::MPosition ( const Quantity dt0,
const Quantum< Vector< Double > > &  dt,
const MPosition::Ref rf 
)
casacore::MPosition::MPosition ( const Quantity dt0,
const Quantum< Vector< Double > > &  dt,
MPosition::Types  rf 
)
casacore::MPosition::MPosition ( const Measure dt)
casacore::MPosition::MPosition ( const MeasValue dt)
casacore::MPosition::MPosition ( const MPosition )
virtual casacore::MPosition::~MPosition ( )
virtual

Member Function Documentation

static const String* casacore::MPosition::allMyTypes ( Int nall,
Int nextra,
const uInt *&  typ 
)
static
virtual const String* casacore::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 casacore::Measure.

static void casacore::MPosition::assure ( const Measure in)
static
static MPosition::Types casacore::MPosition::castType ( uInt  tp)
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 casacore::MPosition::checkMyTypes ( )
static
virtual void casacore::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 casacore::Measure.

virtual Measure* casacore::MPosition::clone ( ) const
virtual

Make copy.

Implements casacore::Measure.

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

Get Measure data.

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

Get the default reference type.

Implements casacore::Measure.

virtual String casacore::MPosition::getRefString ( ) const
virtual

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

Implements casacore::Measure.

static Bool casacore::MPosition::getType ( MPosition::Types tp,
const String in 
)
static

Translate string to reference code.

static MPosition::Types casacore::MPosition::getType ( const String in)
static

this one throws an exception for an unrecognized String

Bool casacore::MPosition::giveMe ( MPosition::Ref mr,
const String in 
)
MPosition& casacore::MPosition::operator= ( const MPosition )
virtual Bool casacore::MPosition::setOffset ( const Measure in)
virtual

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

Implements casacore::Measure.

virtual Bool casacore::MPosition::setRefString ( const String in)
virtual

Set the reference type to the specified String.

False if illegal string, reference set to DEFAULT.

Implements casacore::Measure.

static const String& casacore::MPosition::showMe ( )
static
static const String& casacore::MPosition::showType ( MPosition::Types  tp)
static
static const String& casacore::MPosition::showType ( uInt  tp)
static
virtual const String& casacore::MPosition::tellMe ( ) const
virtual

Tell me your type.

Implements casacore::Measure.

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: