casa::MPosition Class Reference
[Measures]

#include <MPosition.h>

Inheritance diagram for casa::MPosition:

[legend]Collaboration diagram for casa::MPosition:

[legend]List of all members.

Detailed Description

A Measure: position on Earth.

Intended use:

Part of API

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 81 of file MPosition.h.

MPosition (const MPosition &)

MPosition & operator= (const 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();.

static const String & showMe ()

static void assure (const Measure &in)

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

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

Translate string to reference code.

virtual const String *const allTypes (Int &nall, Int &nextra, const uInt *&typ) const

Get a list of all known reference codes.

static const String *const allMyTypes (Int &nall, Int &nextra, const uInt *&typ)

virtual void checkTypes () const

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

static void checkMyTypes ()

Public Types

enum Types

Types of known MPositions Warning: The order defines the order in the translation matrix FromTo in the getConvert routine. 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 ROScalarMeasColumn<
MPosition > ROScalarColumn

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

typedef ScalarMeasColumn<
MPosition > ScalarColumn

typedef ROArrayMeasColumn<
MPosition > ROArrayColumn

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.

virtual ~MPosition ()

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 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 uInt myType ()

Get my type (as Register).

static MPosition::Types castType (uInt tp)

Translate reference code.

static const String & showType (MPosition::Types tp)

static const String & showType (uInt tp)

Friends

class MeasConvert< MPosition >

Conversion of data.

Member Typedef Documentation

typedef MVPosition casa::MPosition::MVType

Measure value container for this class (i.e.

MPosition::MVType)

Definition at line 104 of file MPosition.h.

typedef MCPosition casa::MPosition::MCType

Measure conversion routines for this class (i.e.

MPosition::MCType)

Definition at line 106 of file MPosition.h.

typedef MeasRef<MPosition> casa::MPosition::Ref

Measure reference (i.e.

MPosition::Ref)

Definition at line 108 of file MPosition.h.

typedef MeasConvert<MPosition> casa::MPosition::Convert

Measure Convert (i.e.

MPosition::Convert)

Reimplemented from casa::Measure.

Definition at line 110 of file MPosition.h.

typedef ROScalarMeasColumn<MPosition> casa::MPosition::ROScalarColumn

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

Definition at line 112 of file MPosition.h.

typedef ScalarMeasColumn<MPosition> casa::MPosition::ScalarColumn

Definition at line 113 of file MPosition.h.

typedef ROArrayMeasColumn<MPosition> casa::MPosition::ROArrayColumn

Definition at line 114 of file MPosition.h.

typedef ArrayMeasColumn<MPosition> casa::MPosition::ArrayColumn

Definition at line 115 of file MPosition.h.

Member Enumeration Documentation

enum casa::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().

Reimplemented from casa::Measure.

Definition at line 96 of file MPosition.h.

Constructor & Destructor Documentation

casa::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

casa::MPosition::MPosition ( const MVPosition & dt )

Create from data and reference.

casa::MPosition::MPosition	(	const MVPosition &	dt,
		const MPosition::Ref &	rf
	)

casa::MPosition::MPosition	(	const MVPosition &	dt,
		MPosition::Types	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
	)

casa::MPosition::MPosition ( const Measure * dt )

casa::MPosition::MPosition ( const MeasValue * dt )

casa::MPosition::MPosition ( const MPosition & )

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

casa::MPosition::MPosition ( const MVPosition & dt )

Create from data and reference.

casa::MPosition::MPosition	(	const MVPosition &	dt,
		const MPosition::Ref &	rf
	)

casa::MPosition::MPosition	(	const MVPosition &	dt,
		MPosition::Types	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
	)

casa::MPosition::MPosition ( const Measure * dt )

casa::MPosition::MPosition ( const MeasValue * dt )

Member Function Documentation

typedef casa::MPosition::WHATEVER_SUN_TYPEDEF ( MPosition )

Reference enum Types (included originally for gcc 2.95).

MPosition& casa::MPosition::operator= ( const MPosition & )

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

Tell me your type.

Implements casa::Measure.

static const String& casa::MPosition::showMe ( ) [static]

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.

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

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

static const String& casa::MPosition::showType ( uInt tp ) [static]

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

Translate string to reference code.

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

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.

virtual const String& casa::MPosition::getDefaultType ( ) const [virtual]

Get the default reference type.

Implements casa::Measure.

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

static void casa::MPosition::checkMyTypes ( ) [static]

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

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

Implements casa::Measure.

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

Get my type (as Register).

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

Get Measure data.

Quantum<Vector<Double> > casa::MPosition::getAngle ( ) const

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

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

Make copy.

Implements casa::Measure.

Friends And Related Function Documentation

friend class MeasConvert< MPosition > [friend]

Conversion of data.

Definition at line 86 of file MPosition.h.

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

measures/implement/Measures/MPosition.h

Generated on Tue Aug 26 22:34:23 2008 for NRAOCASA by

1.5.1


	MPosition (const MPosition &)
MPosition &	operator= (const 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();.
static const String &	showMe ()
static void	assure (const Measure &in)
Bool	giveMe (MPosition::Ref &mr, const String &in)
static Bool	getType (MPosition::Types &tp, const String &in)
	Translate string to reference code.
virtual const String *const	allTypes (Int &nall, Int &nextra, const uInt *&typ) const
	Get a list of all known reference codes.
static const String *const	allMyTypes (Int &nall, Int &nextra, const uInt *&typ)
virtual void	checkTypes () const
	Check if all internal tables of types (both enum and String) are complete and correct.
static void	checkMyTypes ()
Public Types
enum	Types
	Types of known MPositions Warning: The order defines the order in the translation matrix FromTo in the getConvert routine. 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 ROScalarMeasColumn< MPosition >	ROScalarColumn
	Measure table Columns (e.g., MPosition::ROScalarColumn).
typedef ScalarMeasColumn< MPosition >	ScalarColumn
typedef ROArrayMeasColumn< MPosition >	ROArrayColumn
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.*
virtual	~MPosition ()
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 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 uInt	myType ()
	Get my type (as Register).

static MPosition::Types	castType (uInt tp)
	Translate reference code.
static const String &	showType (MPosition::Types tp)
static const String &	showType (uInt tp)
Friends
class	MeasConvert< MPosition >
	Conversion of data.

casa::MPosition Class Reference [Measures]

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Example

Motivation

To Do

Public Types

Public Member Functions

Static Public Member Functions

Friends

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Thrown Exceptions

Thrown Exceptions

Friends And Related Function Documentation

casa::MPosition Class Reference
[Measures]