casa::MeasBase< Mv, Mr > Class Template Reference

Base class for all measures. More...

#include <MeasBase.h>

Inheritance diagram for casa::MeasBase< Mv, Mr >:

List of all members.

Public Member Functions
	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
	MeasBase (const MeasBase< Mv, Mr > &other)
	Copy constructor.
MeasBase< Mv, Mr > &	operator= (const MeasBase< Mv, Mr > &other)
	Copy assignment.
	MeasBase (const Mv &dt, const Mr &rf)
	Create from data and reference.
	MeasBase (const Mv &dt, uInt rf)
	MeasBase (const Quantity &dt, const Mr &rf)
	MeasBase (const Quantity &dt, uInt rf)
	MeasBase (const Measure *dt)
	MeasBase (const Mr &rf)
	MeasBase (const uInt rf)
virtual	~MeasBase ()
virtual Bool	areYou (const String &tp) const
	Check the type of derived entity.
virtual void	assured (const String &tp) const
	Assert that we are the correct type.
void	set (const Mv &dt)
	Refill the specified entities.
void	set (const Mr &rf)
void	set (const Mv &dt, const Mr &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):
virtual Bool	putValue (const Vector< Quantum< Double > > &in)
Mr	getRef () const
	Get reference.
const Mv &	getValue () const
	Get Measure data.
const Unit &	getUnit () const
	Get Unit.
virtual MRBase *	getRefPtr () const
	Get reference pointer.
virtual const MeasValue *	getData () const
	Get pointer to data.
virtual void	print (std::ostream &os) const
	Print a Measure.
Protected Attributes
Mv	data
	The measure value (e.g.
Mr	ref
	Reference frame data.
Unit	unit
	Possible input units.
Private Member Functions
void	clear ()
	Error information MeasErr error;.

---

Detailed Description

template<class Mv, class Mr>
class casa::MeasBase< Mv, Mr >

Base class for all measures.

Intended use:

Internal

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

Prerequisite

• Measure class

Etymology

Measure and Base

Synopsis

MeasBase forms derived Measure class for all actual measures

Example

Motivation

To have most work in single routine

To Do

Definition at line 75 of file MeasBase.h.

---

Constructor & Destructor Documentation

template<class Mv, class Mr>

casa::MeasBase< Mv, Mr >::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

template<class Mv, class Mr>

casa::MeasBase< Mv, Mr >::MeasBase

(

const MeasBase< Mv, Mr > &

other

)

Copy constructor.

template<class Mv, class Mr>

casa::MeasBase< Mv, Mr >::MeasBase	(	const Mv &	dt,
		const Mr &	rf
	)

Create from data and reference.

template<class Mv, class Mr>

casa::MeasBase< Mv, Mr >::MeasBase	(	const Mv &	dt,
		uInt	rf
	)

template<class Mv, class Mr>

casa::MeasBase< Mv, Mr >::MeasBase	(	const Quantity &	dt,
		const Mr &	rf
	)

template<class Mv, class Mr>

casa::MeasBase< Mv, Mr >::MeasBase	(	const Quantity &	dt,
		uInt	rf
	)

template<class Mv, class Mr>

casa::MeasBase< Mv, Mr >::MeasBase

(

const Measure *

dt

)

template<class Mv, class Mr>

casa::MeasBase< Mv, Mr >::MeasBase

(

const Mr &

rf

)

template<class Mv, class Mr>

casa::MeasBase< Mv, Mr >::MeasBase

(

const uInt

rf

)

template<class Mv, class Mr>

virtual casa::MeasBase< Mv, Mr >::~MeasBase

(

)

[virtual]

---

Member Function Documentation

template<class Mv, class Mr>

virtual Bool casa::MeasBase< Mv, Mr >::areYou

(

const String &

tp

)

const [virtual]

Check the type of derived entity.

Implements casa::Measure.

template<class Mv, class Mr>

virtual void casa::MeasBase< Mv, Mr >::assured

(

const String &

tp

)

const [virtual]

Assert that we are the correct type.

Thrown Exceptions

• AipsError if wrong Measure

Implements casa::Measure.

template<class Mv, class Mr>

void casa::MeasBase< Mv, Mr >::clear

(

)

[private, virtual]

Error information MeasErr error;.

Clear the measure

Implements casa::Measure.

template<class Mv, class Mr>

virtual const MeasValue* casa::MeasBase< Mv, Mr >::getData

(

)

const [virtual]

Get pointer to data.

Implements casa::Measure.

template<class Mv, class Mr>

Mr casa::MeasBase< Mv, Mr >::getRef

(

)

const

Get reference.

template<class Mv, class Mr>

virtual MRBase* casa::MeasBase< Mv, Mr >::getRefPtr

(

)

const [virtual]

Get reference pointer.

Implements casa::Measure.

template<class Mv, class Mr>

const Unit& casa::MeasBase< Mv, Mr >::getUnit

(

)

const [virtual]

Get Unit.

Implements casa::Measure.

template<class Mv, class Mr>

const Mv& casa::MeasBase< Mv, Mr >::getValue

(

)

const

Get Measure data.

template<class Mv, class Mr>

MeasBase<Mv,Mr>& casa::MeasBase< Mv, Mr >::operator=

(

const MeasBase< Mv, Mr > &

other

)

Copy assignment.

template<class Mv, class Mr>

virtual void casa::MeasBase< Mv, Mr >::print

(

std::ostream &

os

)

const [virtual]

Print a Measure.

Implements casa::Measure.

template<class Mv, class Mr>

virtual Bool casa::MeasBase< Mv, Mr >::putValue

(

const Vector< Quantum< Double > > &

in

)

[virtual]

Implements casa::Measure.

template<class Mv, class Mr>

void casa::MeasBase< Mv, Mr >::set

(

const Mv &

dt

)

Refill the specified entities.

template<class Mv, class Mr>

void casa::MeasBase< Mv, Mr >::set

(

const Mr &

rf

)

template<class Mv, class Mr>

void casa::MeasBase< Mv, Mr >::set	(	const Mv &	dt,
		const Mr &	rf
	)

template<class Mv, class Mr>

void casa::MeasBase< Mv, Mr >::set

(

const Unit &

inunit

)

template<class Mv, class Mr>

virtual void casa::MeasBase< Mv, Mr >::set

(

const MeasValue &

dt

)

[virtual]

Each Measure should have the following set functions (with appropiate MVs and Ref):

        void set(const MVmeasure &dt);
        void set(const Measure::Ref &rf);
        void set(const MVmeasure &dt, const Measure::Ref &rf);

Implements casa::Measure.

---

Member Data Documentation

template<class Mv, class Mr>

Mv casa::MeasBase< Mv, Mr >::data [protected]

The measure value (e.g.

instant in time)

Definition at line 157 of file MeasBase.h.

template<class Mv, class Mr>

Mr casa::MeasBase< Mv, Mr >::ref [protected]

Reference frame data.

Definition at line 159 of file MeasBase.h.

template<class Mv, class Mr>

Unit casa::MeasBase< Mv, Mr >::unit [protected]

Possible input units.

Definition at line 161 of file MeasBase.h.

---

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

• casacore/measures/Measures/MeasBase.h