Internal value for MFrequency. More...
#include <MVFrequency.h>
Public Member Functions | |
| MVFrequency () | |
| Default constructor: generate a zero value. | |
| MVFrequency (const MVFrequency &other) | |
| Copy constructor. | |
| MVFrequency & | operator= (const MVFrequency &other) |
| Copy assignment. | |
| MVFrequency (Double d) | |
| Constructor from Double, assuming Hz. | |
| MVFrequency (const Quantity &other) | |
| Constructor from Quantum : value taken will be the canonical value. | |
| MVFrequency (const Quantum< Vector< Double > > &other) | |
| MVFrequency (const Vector< Double > &other) | |
| Constructor from Vector. | |
| MVFrequency (const Vector< Quantity > &other) | |
| ~MVFrequency () | |
| Destructor. | |
| operator Double () const | |
| Conversion operator. | |
| MVFrequency & | operator+= (const MVFrequency &other) |
| Addition. | |
| MVFrequency & | operator-= (const MVFrequency &other) |
| Bool | operator== (const MVFrequency &other) const |
| Comparisons. | |
| 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. | |
| virtual void | print (ostream &os) const |
| Print data. | |
| virtual MeasValue * | clone () const |
| Clone. | |
| Double | getValue () const |
| Adjust value: taken from base class, a NOP. | |
| Quantity | get () const |
| Get quantity in Hz. | |
| Quantity | get (const Unit &unit) const |
| Get the wave characteristics in (recognised) specified units. | |
| virtual Vector< Double > | getVector () const |
| Get the value in internal units. | |
| virtual void | putVector (const Vector< Double > &in) |
| Set the value from internal units (set 0 for empty vector). | |
| virtual Vector< Quantum< Double > > | getRecordValue () const |
Get the internal value as a Vector<Quantity>. | |
| virtual Bool | putValue (const Vector< Quantum< Double > > &in) |
| Set the internal value if correct values and dimensions. | |
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. | |
Private Attributes | |
| Double | val |
| Value. | |
Internal value for MFrequency.
Public interface
From Measure, Value and Frequency
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).
See MFrequency
To aid coordinate transformations possibilities
Definition at line 97 of file MVFrequency.h.
| 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 | ( | ) |
Destructor.
| static void casacore::MVFrequency::assure | ( | const MeasValue & | in | ) | [static] |
| virtual MeasValue* casacore::MVFrequency::clone | ( | ) | const [virtual] |
Clone.
Implements casacore::MeasValue.
Get the wave characteristics in (recognised) specified units.
| Quantity casacore::MVFrequency::get | ( | ) | const |
Get quantity in Hz.
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
Get the value in internal units.
Implements casacore::MeasValue.
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.
Set the internal value if correct values and dimensions.
Implements casacore::MeasValue.
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.
Double casacore::MVFrequency::val [private] |
Value.
Definition at line 180 of file MVFrequency.h.
1.6.1
