CARMA C++
Frequency.h
Go to the documentation of this file.
1 // $Id: Frequency.h,v 1.8 2014/04/02 23:11:12 iws Exp $
2 
14 #ifndef CARMA_SERVICES_FREQUENCY_H
15 #define CARMA_SERVICES_FREQUENCY_H
16 
18 #include "carma/services/Units.h"
19 #include <string>
20 
21 namespace carma {
22  namespace services {
39  class Frequency : public ConformableQuantity {
40  public:
41 
47  Frequency(double value, const std::string& units);
48 
50  virtual ~Frequency();
51 
57  double hertz() const;
58 
64  double gigahertz() const;
65 
73  double millihertz() const;
74 
83  double megahertz() const;
84 
92  double wavelength(const std::string& units) const;
93 
99  const Frequency operator+(const Frequency& frequency) const;
100 
106  const Frequency operator-(const Frequency& frequency) const;
107 
114  bool operator<(const Frequency &frequency) const;
115 
122  bool operator>(const Frequency &frequency) const;
123 
128  Frequency &operator+=(const Frequency &frequency);
129 
134  Frequency &operator-=(const Frequency &frequency);
135 
136  };
140 std::ostream& operator<<(std::ostream& os,
141  const carma::services::Frequency& frequency);
142 
143  }
144 }
145 
146 
147 #endif //CARMA_SERVICES_FREQUENCY_H
The ConformableQuantity class can represent any quantity that can be expressed in many units...
const Frequency operator+(const Frequency &frequency) const
Add two Frequencys.
Frequency(double value, const std::string &units)
Construct an Frequency given a value and units.
Frequency & operator+=(const Frequency &frequency)
Increment Frequency.
The Frequency class can represent any frequency in any units.
Definition: Frequency.h:39
bool operator>(const Frequency &frequency) const
Compare two frequencies.
double gigahertz() const
Convenience method that returns the value of this frequency in GHz.
double hertz() const
Convenience method that returns the value of this frequency in Hertz.
Frequency & operator-=(const Frequency &frequency)
Decrement Frequency.
bool operator<(const Frequency &frequency) const
Compare two frequencies.
const Frequency operator-(const Frequency &frequency) const
Subtract two Frequencys.
double wavelength(const std::string &units) const
Convenience method that returns the value of this the wavelength equivalent of this frequency...
virtual ~Frequency()
Destructor.
double millihertz() const
Convenience method that returns the value of this frequency in millihertz.
Parent class for representations of quantities that can have conformable units, e.g.
std::ostream & operator<<(std::ostream &os, const carma::services::Angle &angle)
Define the &lt;&lt; operator to allow, e.g.
double megahertz() const
Convenience method that returns the value of this frequency in millihertz.