carma::services::AngularRate Class Reference
The AngularRate class can represent an angular rate in any units. More...
#include <carma/services/AngularRate.h>
Inheritance diagram for carma::services::AngularRate:
Public Member Functions | |
| AngularRate (double value, const std::string &units) | |
| Construct an AngularRate given a value and units. More... | |
| const AngularRate | operator+ (const AngularRate &ar) const |
| Add two Angular rates. More... | |
| AngularRate & | operator+= (const AngularRate &ar) |
| Increment AngularRate. More... | |
| const AngularRate | operator- (const AngularRate &ar) const |
| Subtract two Angular rates. More... | |
| AngularRate & | operator-= (const AngularRate &ar) |
| Decrement AngularRate. More... | |
| virtual | ~AngularRate () |
| Destructor. More... | |
 Public Member Functions inherited from carma::services::ConformableQuantity | |
| ConformableQuantity (double value, const std::string &units) | |
| Construct an ConformableQuantity given a value and units. More... | |
| virtual double | convert (const std::string &convertTo) const |
| Converts this quantity to any conformable units. More... | |
| virtual std::string | getUnits () const |
| double | getValue () const |
| virtual const ConformableQuantity | operator+ (const ConformableQuantity &quantity) const |
| Add two ConformableQuantities. More... | |
| virtual ConformableQuantity & | operator+= (const ConformableQuantity &quantity) |
| Add ConformableQuantity to itself. More... | |
| virtual const ConformableQuantity | operator- (const ConformableQuantity &quantity) const |
| Subtract two ConformableQuantities. More... | |
| virtual ConformableQuantity & | operator-= (const ConformableQuantity &quantity) |
| Subtract ConformableQuantity from itself. More... | |
| virtual void | reset (double value, const std::string &units) |
| Reset method to change value and/or units. More... | |
| virtual | ~ConformableQuantity () |
| Destructor. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from carma::services::ConformableQuantity | |
| Units | u_ |
| Used for converting between units. More... | |
Detailed Description
The AngularRate class can represent an angular rate in any units.
It uses the Units class internally to handle conversion of any angular rate unit to any other angular rate unit. For example,
AngularRate ar1(1.0,"degrees/s") both
AngularRate ar2(1.0227,"radians/s")
ar1 and ar2 represent the (approximately!) the same physical quantity. Binary operations + and - are supported, as is the stream operation <<.
Definition at line 37 of file AngularRate.h.
Constructor & Destructor Documentation
| carma::services::AngularRate::AngularRate | ( | double | value, |
| const std::string & | units | ||
| ) |
Construct an AngularRate given a value and units.
- Parameters
-
value The value of this angular rate units The units of the value.
|
virtual |
Destructor.
Member Function Documentation
| const AngularRate carma::services::AngularRate::operator+ | ( | const AngularRate & | ar | ) | const |
Add two Angular rates.
- Returns
- a AngularRate with rad/s units that is the sum of the two Angular rates.
- Exceptions
-
ConformabilityException
| AngularRate& carma::services::AngularRate::operator+= | ( | const AngularRate & | ar | ) |
Increment AngularRate.
- Returns
- incremented AngularRate
| const AngularRate carma::services::AngularRate::operator- | ( | const AngularRate & | ar | ) | const |
Subtract two Angular rates.
- Returns
- an AngularRate with rad/s units that is the difference of the two Angular rates
- Exceptions
-
ConformabilityException
| AngularRate& carma::services::AngularRate::operator-= | ( | const AngularRate & | ar | ) |
Decrement AngularRate.
- Returns
- decremented AngularRate
The documentation for this class was generated from the following file:
- carma/services/AngularRate.h
