It defines the basic type CDegrees, used to store an angle value in degrees.
More...
#include <angles.h>
It defines the basic type CDegrees, used to store an angle value in degrees.
Definition at line 288 of file angles.h.
◆ CDegrees() [1/2]
argos::CDegrees::CDegrees |
( |
| ) |
|
|
inline |
Class constructor It initializes m_fValue to 0 degrees.
Definition at line 296 of file angles.h.
◆ CDegrees() [2/2]
argos::CDegrees::CDegrees |
( |
Real |
f_value | ) |
|
|
inlineexplicit |
Class constructor It initializes m_fValue to the passed value.
- Parameters
-
f_value | the wanted value in degrees |
Definition at line 305 of file angles.h.
◆ FromValueInRadians()
void argos::CDegrees::FromValueInRadians |
( |
Real |
f_value | ) |
|
|
inline |
Sets the value from a value in radians It sets m_fValue (which is in degrees) converting from the passed value in radians.
- Parameters
-
f_value | a value in radians |
Definition at line 314 of file angles.h.
◆ GetAbsoluteValue()
Real argos::CDegrees::GetAbsoluteValue |
( |
| ) |
const |
|
inline |
Returns the absolute value in degrees.
- Returns
- the absolute value in degrees
Definition at line 330 of file angles.h.
◆ GetValue()
Real argos::CDegrees::GetValue |
( |
| ) |
const |
|
inline |
Returns the value in degrees.
- Returns
- the value in degrees
Definition at line 322 of file angles.h.
◆ operator!=()
bool argos::CDegrees::operator!= |
( |
const CDegrees & |
c_degrees | ) |
const |
|
inline |
◆ operator*()
◆ operator*=()
◆ operator+() [1/2]
CDegrees& argos::CDegrees::operator+ |
( |
| ) |
|
|
inline |
◆ operator+() [2/2]
◆ operator+=()
◆ operator-() [1/2]
CDegrees argos::CDegrees::operator- |
( |
| ) |
const |
|
inline |
◆ operator-() [2/2]
◆ operator-=()
◆ operator/() [1/2]
Real argos::CDegrees::operator/ |
( |
const CDegrees & |
c_degrees | ) |
const |
|
inline |
◆ operator/() [2/2]
◆ operator/=()
◆ operator<()
bool argos::CDegrees::operator< |
( |
const CDegrees & |
c_degrees | ) |
const |
|
inline |
◆ operator<=()
bool argos::CDegrees::operator<= |
( |
const CDegrees & |
c_degrees | ) |
const |
|
inline |
◆ operator==()
bool argos::CDegrees::operator== |
( |
const CDegrees & |
c_degrees | ) |
const |
|
inline |
◆ operator>()
bool argos::CDegrees::operator> |
( |
const CDegrees & |
c_degrees | ) |
const |
|
inline |
◆ operator>=()
bool argos::CDegrees::operator>= |
( |
const CDegrees & |
c_degrees | ) |
const |
|
inline |
◆ SetValue()
void argos::CDegrees::SetValue |
( |
Real |
f_value | ) |
|
|
inline |
Sets the value in degrees.
- Parameters
-
f_value | the wanted value in degrees |
Definition at line 338 of file angles.h.
◆ SignedNormalize()
CDegrees& argos::CDegrees::SignedNormalize |
( |
| ) |
|
|
inline |
Normalizes the value in the range [-180:180].
- Returns
- A reference to the current object
- See also
- CRange
Definition at line 347 of file angles.h.
◆ UnsignedNormalize()
CDegrees& argos::CDegrees::UnsignedNormalize |
( |
| ) |
|
|
inline |
Normalizes the value in the range [0:360].
- Returns
- A reference to the current object
- See also
- CRange
Definition at line 357 of file angles.h.
◆ NormalizedDifference
Calculates the normalized difference between the given angles.
The difference is calculated as c_angle1 - c_angle2 and normalized in the range [-180,180].
- Parameters
-
c_angle1 | The first angle |
c_angle2 | The second angle |
- Returns
- The smallest difference between the two angles
Definition at line 528 of file angles.h.
◆ operator*
◆ operator<<
std::ostream& operator<< |
( |
std::ostream & |
c_os, |
|
|
const CDegrees & |
c_degrees |
|
) |
| |
|
friend |
◆ operator>>
std::istream& operator>> |
( |
std::istream & |
is, |
|
|
CDegrees & |
c_degrees |
|
) |
| |
|
friend |
◆ ToRadians
Converts this object to CRadians.
- Returns
- the conversion of m_fValue into CRadians
- Parameters
-
c_degrees | the object to convert |
- Returns
- the converted CRadians object
Definition at line 498 of file angles.h.
The documentation for this class was generated from the following files: