casacore::MPosition Class Reference

A Measure: position on Earth. More...

#include <MPosition.h>

Inheritance diagram for casacore::MPosition:

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< MPosition >	Ref
	Measure reference (i.e.
typedef MeasConvert< MPosition >	Convert
	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 &)
MPosition &	operator= (const MPosition &)
virtual	~MPosition ()
virtual const String &	tellMe () 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 String &	getDefaultType () const
	Get the default reference type.
virtual const String *	allTypes (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 Measure *	clone () const
	Make copy.
Static Public Member Functions
static const String &	showMe ()
static void	assure (const Measure &in)
static MPosition::Types	castType (uInt tp)
	Translate reference code.
static const String &	showType (MPosition::Types tp)
static const String &	showType (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 String *	allMyTypes (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

Measure class

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

typedef ArrayMeasColumn<MPosition> casacore::MPosition::ArrayColumn

Definition at line 111 of file MPosition.h.

typedef MeasConvert<MPosition> casacore::MPosition::Convert

Measure Convert (i.e.

MPosition::Convert)

Reimplemented from casacore::Measure.

Definition at line 108 of file MPosition.h.

typedef MCPosition casacore::MPosition::MCType

Measure conversion routines for this class (i.e.

MPosition::MCType)

Definition at line 104 of file MPosition.h.

typedef MVPosition casacore::MPosition::MVType

Measure value container for this class (i.e.

MPosition::MVType)

Definition at line 102 of file MPosition.h.

typedef MeasRef<MPosition> casacore::MPosition::Ref

Measure reference (i.e.

MPosition::Ref)

Definition at line 106 of file MPosition.h.

typedef ScalarMeasColumn<MPosition> casacore::MPosition::ScalarColumn

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

Definition at line 110 of file MPosition.h.

Member Enumeration Documentation

enum casacore::MPosition::Types

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 casacore::Measure.

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 Unit & inunit ) const

Quantum<Vector<Double> > casacore::MPosition::getAngle ( ) 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 MPosition::Types casacore::MPosition::getType ( const String & in ) [static]

this one throws an exception for an unrecognized String

static Bool casacore::MPosition::getType	(	MPosition::Types &	tp,
		const String &	in
	)			`[static]`

Translate string to reference code.

Bool casacore::MPosition::giveMe	(	MPosition::Ref &	mr,
		const String &	in
	)

static uInt casacore::MPosition::myType ( ) [static]

Get my type (as Register).

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).

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 ( uInt tp ) [static]

static const String& casacore::MPosition::showType ( MPosition::Types tp ) [static]

virtual const String& casacore::MPosition::tellMe ( ) const [virtual]

Tell me your type.

Implements casacore::Measure.

virtual uInt casacore::MPosition::type ( ) const [virtual]

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

Implements casacore::Measure.

typedef casacore::MPosition::WHATEVER_SUN_TYPEDEF ( MPosition )

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:

casacore/measures/Measures/MPosition.h

casacore::MPosition Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Example

Motivation

To Do

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Thrown Exceptions

Thrown Exceptions

Friends And Related Function Documentation