rapid
A ROS robotics library.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
rapid::Radians Class Reference

Type for angles measured in radians. More...

#include <deg_rad.h>

Public Member Functions

 Radians (double radians)
 Constructor. More...
 
 Radians (const Degrees &degrees)
 Implicit converting constructor from degrees to radians. More...
 
double value () const
 

Detailed Description

Type for angles measured in radians.

Allows algorithms to explicitly document what units it expects for angle inputs.

Degrees can be implicitly converted to Radians.

Definition at line 43 of file deg_rad.h.

Constructor & Destructor Documentation

rapid::Radians::Radians ( double  radians)
explicit

Constructor.

Parameters
[in]radiansThe angle expressed in radians.
rapid::Radians::Radians ( const Degrees degrees)

Implicit converting constructor from degrees to radians.

This allows algorithms that expect Radians to also accept Degrees without developers having to explicitly do the conversion. For example, if PanTilt expects arguments as Radians, both of these are correct:

PanTilt(rapid::Radians(0.707), rapid::Radians(0.5));
PanTilt(rapid::Degrees(45), rapid::Degrees(30));
Parameters
[in]degreesThe angle expressed in degrees.

Member Function Documentation

double rapid::Radians::value ( ) const
Returns
The number of radians.

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