casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::MVFrequency Class Reference

Internal value for MFrequency. More...

#include <MVFrequency.h>

Inheritance diagram for casacore::MVFrequency:
casacore::MeasValue

Public Member Functions

 MVFrequency ()
 Default constructor: generate a zero value. More...
 
 MVFrequency (const MVFrequency &other)
 Copy constructor. More...
 
MVFrequencyoperator= (const MVFrequency &other)
 Copy assignment. More...
 
 MVFrequency (Double d)
 Constructor from Double, assuming Hz. More...
 
 MVFrequency (const Quantity &other)
 Constructor from Quantum : value taken will be the canonical value. More...
 
 MVFrequency (const Quantum< Vector< Double > > &other)
 
 MVFrequency (const Vector< Double > &other)
 Constructor from Vector. More...
 
 MVFrequency (const Vector< Quantity > &other)
 
 ~MVFrequency ()
 Destructor. More...
 
 operator Double () const
 Conversion operator. More...
 
MVFrequencyoperator+= (const MVFrequency &other)
 Addition. More...
 
MVFrequencyoperator-= (const MVFrequency &other)
 
Bool operator== (const MVFrequency &other) const
 Comparisons. More...
 
Bool operator!= (const MVFrequency &other) const
 
Bool near (const MVFrequency &other, Double tol=1e-13) const
 
Bool nearAbs (const MVFrequency &other, Double tol=1e-13) const
 
virtual uInt type () const
 Tell me your type. More...
 
virtual void print (ostream &os) const
 Print data. More...
 
virtual MeasValueclone () const
 Clone. More...
 
Double getValue () const
 Adjust value: taken from base class, a NOP. More...
 
Quantity get () const
 Get quantity in Hz. More...
 
Quantity get (const Unit &unit) const
 Get the wave characteristics in (recognised) specified units. More...
 
virtual Vector< DoublegetVector () const
 Get the value in internal units. More...
 
virtual void putVector (const Vector< Double > &in)
 Set the value from internal units (set 0 for empty vector) More...
 
virtual Vector< Quantum< Double > > getRecordValue () const
 Get the internal value as a Vector<Quantity>. More...
 
virtual Bool putValue (const Vector< Quantum< Double > > &in)
 Set the internal value if correct values and dimensions. More...
 
- Public Member Functions inherited from casacore::MeasValue
void dummy_constr () const
 Each derived class should have at least the following constructors: More...
 
virtual ~MeasValue ()
 Destructor. More...
 
void dummy_operator () const
 The following operators should be present at least. More...
 
virtual Vector< Quantum< Double > > getXRecordValue () const
 
virtual Vector< Quantum< Double > > getTMRecordValue () const
 
virtual void adjust ()
 Some of the Measure values used need the occasional adjustments to proper values. More...
 
virtual void adjust (Double &val)
 Adjust value and return a normalisation value. More...
 
virtual void readjust (Double val)
 Re-adjust, i.e. More...
 

Static Public Member Functions

static void assure (const MeasValue &in)
 

Private Member Functions

Double makeF (Double v, const Unit &dt, Bool rev=False) const
 Get correct data type conversion factor from input Quantum. More...
 

Private Attributes

Double val
 Value. More...
 

Detailed Description

Internal value for MFrequency.

Intended use:

Public interface

Review Status

Reviewed By:
tcornwel
Date Reviewed:
1996/02/23
Test programs:
tMeasMath

Prerequisite

Etymology

From Measure, Value and Frequency

Synopsis

An MVFrequency is a simple Double, to be used in the MFrequency measure. Requirements can be found in the MeasValue base class.
The only reasonable constructor is (but all MeasValue constructors are present) MVFrequency(Double) (with assumed Hz units); and an operator Double takes care of all other possibilities. Its external use is for MeasConvert, to distinguish between input in internal Measure units, and values which have to have units applied.
The MVFrequency(Quantum) constructors recognise the type of wave characteristics presented from its units. Recognised are:


The frequency is returned in Hz with getValue(); or as a Quantity in Hz with get(); or in one of the above units with get(unit).

Example

See MFrequency

Motivation

To aid coordinate transformations possibilities

Definition at line 97 of file MVFrequency.h.

Constructor & Destructor Documentation

casacore::MVFrequency::MVFrequency ( )

Default constructor: generate a zero value.

casacore::MVFrequency::MVFrequency ( const MVFrequency other)

Copy constructor.

casacore::MVFrequency::MVFrequency ( Double  d)

Constructor from Double, assuming Hz.

casacore::MVFrequency::MVFrequency ( const Quantity other)

Constructor from Quantum : value taken will be the canonical value.

casacore::MVFrequency::MVFrequency ( const Quantum< Vector< Double > > &  other)
casacore::MVFrequency::MVFrequency ( const Vector< Double > &  other)

Constructor from Vector.

A zero value will be taken for an empty vector, the canonical value for a quantum vector.

Thrown Exceptions

casacore::MVFrequency::MVFrequency ( const Vector< Quantity > &  other)
casacore::MVFrequency::~MVFrequency ( )

Destructor.

Member Function Documentation

static void casacore::MVFrequency::assure ( const MeasValue in)
static
virtual MeasValue* casacore::MVFrequency::clone ( ) const
virtual

Clone.

Implements casacore::MeasValue.

Quantity casacore::MVFrequency::get ( ) const

Get quantity in Hz.

Quantity casacore::MVFrequency::get ( const Unit unit) const

Get the wave characteristics in (recognised) specified units.

virtual Vector<Quantum<Double> > casacore::MVFrequency::getRecordValue ( ) const
virtual

Get the internal value as a Vector<Quantity>.

Usable in records. The getXRecordValue() gets additional information for records. Note that the Vectors could be empty.

Implements casacore::MeasValue.

Double casacore::MVFrequency::getValue ( ) const

Adjust value: taken from base class, a NOP.

Get value in Hz

virtual Vector<Double> casacore::MVFrequency::getVector ( ) const
virtual

Get the value in internal units.

Implements casacore::MeasValue.

Double casacore::MVFrequency::makeF ( Double  v,
const Unit dt,
Bool  rev = False 
) const
private

Get correct data type conversion factor from input Quantum.

Bool casacore::MVFrequency::near ( const MVFrequency other,
Double  tol = 1e-13 
) const
Bool casacore::MVFrequency::nearAbs ( const MVFrequency other,
Double  tol = 1e-13 
) const
casacore::MVFrequency::operator Double ( ) const

Conversion operator.

Bool casacore::MVFrequency::operator!= ( const MVFrequency other) const
MVFrequency& casacore::MVFrequency::operator+= ( const MVFrequency other)

Addition.

MVFrequency& casacore::MVFrequency::operator-= ( const MVFrequency other)
MVFrequency& casacore::MVFrequency::operator= ( const MVFrequency other)

Copy assignment.

Bool casacore::MVFrequency::operator== ( const MVFrequency other) const

Comparisons.

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

Print data.

Implements casacore::MeasValue.

virtual Bool casacore::MVFrequency::putValue ( const Vector< Quantum< Double > > &  in)
virtual

Set the internal value if correct values and dimensions.

Implements casacore::MeasValue.

virtual void casacore::MVFrequency::putVector ( const Vector< Double > &  in)
virtual

Set the value from internal units (set 0 for empty vector)

Implements casacore::MeasValue.

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

Tell me your type.

Implements casacore::MeasValue.

Member Data Documentation

Double casacore::MVFrequency::val
private

Value.

Definition at line 180 of file MVFrequency.h.


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