casacore::QBase Class Reference

Base for Quantities (i.e. dimensioned values) More...

#include <QBase.h>

Inheritance diagram for casacore::QBase:

Public Member Functions
	QBase ()
	Default constructor, generates "". More...
	QBase (const Unit &s)
	Construct dimensioned QBase (e.g. More...
virtual	~QBase ()
	Destructor. More...
virtual QBase *	clone () const =0
	Get a copy of Quantum. More...
virtual const Unit &	getFullUnit () const =0
	Get the unit attached to the Quantum (use getUnit() if only interested in the String part of the unit) More...
virtual void	print (ostream &os) const =0
	Print a Quantum. More...
virtual uInt	type () const =0
	Get the type of derived Quantum (using QuantumType). More...
const String &	getUnit () const
	Get units of QBase. More...
void	setUnit (const Unit &s)
	Re-specify parts of a QBase. More...
void	setUnit (const QBase &other)
	Set new unit, copied from specified QBase, without changing value. More...
Bool	isConform (const Unit &s) const
	Check for conformal matching units (e.g. More...
Bool	isConform (const QBase &other) const
	Using units specified in QBase. More...

Protected Attributes
Unit	qUnit

Detailed Description

Base for Quantities (i.e. dimensioned values)

Intended use:

Internal

Review Status

Reviewed By:

UNKNOWN

Date Reviewed:

before2004/08/25

Test programs:

tQuantum

Prerequisite

• Unit

Etymology

QBase is the base class for Quantum.

Synopsis

Quantities are values with a unit. Their basic specification can be one of two forms:

Quantity(Double value, String unit);   // or: Unit unit
Quantum<Type> (Type value, String unit)    // or: Unit unit

See Quantum for details.

Motivation

To provide the possibilty of mixing units from different Quantum<T1>, Quantum<T2>

To Do

• Some inlining (did not work first go)

Definition at line 80 of file QBase.h.

Constructor & Destructor Documentation

casacore::QBase::QBase

(

)

Default constructor, generates "".

casacore::QBase::QBase

(

const Unit &

s

)

Construct dimensioned QBase (e.g.

'km/Mpc')

Thrown Exceptions

• AipsError if non-matching unit dimensions

virtual casacore::QBase::~QBase ( )

virtual

Destructor.

Member Function Documentation

virtual QBase* casacore::QBase::clone ( ) const

pure virtual

Get a copy of Quantum.

Implemented in casacore::Quantum< Qtype >, casacore::Quantum< Double >, casacore::Quantum< casacore::Vector< Double > >, casacore::Quantum< Vector< Double > >, and casacore::Quantum< Vector< T > >.

virtual const Unit& casacore::QBase::getFullUnit ( ) const

pure virtual

Get the unit attached to the Quantum (use getUnit() if only interested in the String part of the unit)

Implemented in casacore::Quantum< Qtype >, casacore::Quantum< Double >, casacore::Quantum< casacore::Vector< Double > >, casacore::Quantum< Vector< Double > >, and casacore::Quantum< Vector< T > >.

const String& casacore::QBase::getUnit

(

)

const

Get units of QBase.

Return the string representation of the current units attached to QBase

Bool casacore::QBase::isConform

(

const Unit &

s

)

const

Check for conformal matching units (e.g.

dam and Mpc) Using specified units

Bool casacore::QBase::isConform

(

const QBase &

other

)

const

Using units specified in QBase.

virtual void casacore::QBase::print ( ostream &  os ) const

pure virtual

Print a Quantum.

Implemented in casacore::Quantum< Qtype >, casacore::Quantum< Double >, casacore::Quantum< casacore::Vector< Double > >, casacore::Quantum< Vector< Double > >, and casacore::Quantum< Vector< T > >.

void casacore::QBase::setUnit

(

const Unit &

s

)

Re-specify parts of a QBase.

Set new unit, without changing value

void casacore::QBase::setUnit

(

const QBase &

other

)

Set new unit, copied from specified QBase, without changing value.

virtual uInt casacore::QBase::type ( ) const

pure virtual

Get the type of derived Quantum (using QuantumType).

All should have: static uInt myType();

Implemented in casacore::Quantum< Qtype >, casacore::Quantum< Double >, casacore::Quantum< casacore::Vector< Double > >, casacore::Quantum< Vector< Double > >, and casacore::Quantum< Vector< T > >.

Member Data Documentation

Unit casacore::QBase::qUnit

protected

Definition at line 135 of file QBase.h.

---

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

• casa/Quanta/QBase.h