Units::Angle Class Reference

Convenience class for angle computations. More...

#include <Angle.h>

Public Member Functions
Q_INVOKABLE bool	isFinite () const
	Checks if the angle is valid.
Q_INVOKABLE Units::Angle	operator+ (Units::Angle rhs) const
	Sum of two angles.
Q_INVOKABLE Units::Angle	operator- (Units::Angle rhs) const
	Difference of two angles.
Q_INVOKABLE bool	operator== (const Units::Angle &rhs) const =default
	Comparison: equal.
Q_INVOKABLE bool	operator!= (const Units::Angle &rhs) const =default
	Comparison: not equal.
Q_INVOKABLE double	cos () const
	Cosine of an angle, as a dimension-less number.
Q_INVOKABLE double	sin () const
	Sine of an angle, as a dimension-less number.
Q_INVOKABLE QString	toClock () const
	Convert angle to clock position.
Q_INVOKABLE double	toDEG () const
	Convert angle to degrees.
Q_INVOKABLE double	toRAD () const
	Convert angle to radian.

Static Public Member Functions
static Q_INVOKABLE Units::Angle	fromRAD (double angleInRAD)
	Constructs an angle.
static Q_INVOKABLE Units::Angle	fromDEG (double angleInDEG)
	Constructs an angle.
static Q_INVOKABLE Units::Angle	nan ()
	Constructs an invalid angle.
static Q_INVOKABLE Units::Angle	asin (double arg)
	Arcsine of a dimension-less number as an angle.

Detailed Description

Convenience class for angle computations.

This extremely simple class allows computation with angles, without the need to worry about units.

Definition at line 41 of file Angle.h.

Member Function Documentation

asin()

Q_INVOKABLE Units::Angle Units::Angle::asin ( double arg )

inlinestatic

Arcsine of a dimension-less number as an angle.

Parameters

arg	Number whose arcsine is computed

Returns

Angle computed

Definition at line 156 of file Angle.h.

cos()

Q_INVOKABLE double Units::Angle::cos ( ) const

inlinenodiscard

Cosine of an angle, as a dimension-less number.

Returns

Cosine of the angle

Definition at line 136 of file Angle.h.

fromDEG()

Q_INVOKABLE Units::Angle Units::Angle::fromDEG ( double angleInDEG )

inlinestatic

Constructs an angle.

Parameters

angleInDEG

Angle in degrees

Returns

Angle

Definition at line 65 of file Angle.h.

fromRAD()

Q_INVOKABLE Units::Angle Units::Angle::fromRAD ( double angleInRAD )

inlinestatic

Constructs an angle.

Parameters

angleInRAD

Angle in radian

Returns

Angle

Definition at line 52 of file Angle.h.

isFinite()

Q_INVOKABLE bool Units::Angle::isFinite ( ) const

inlinenodiscard

Checks if the angle is valid.

Returns

True is the angle is a finite number

Definition at line 85 of file Angle.h.

nan()

Q_INVOKABLE Units::Angle Units::Angle::nan ( )

inlinestatic

Constructs an invalid angle.

Returns

Invalid Angle

Definition at line 76 of file Angle.h.

operator!=()

Q_INVOKABLE bool Units::Angle::operator!= ( const Units::Angle & rhs ) const

nodiscarddefault

Comparison: not equal.

Parameters

rhs	Right hand side of the comparison

Returns

Result of the comparison

operator+()

Q_INVOKABLE Units::Angle Units::Angle::operator+ ( Units::Angle rhs ) const

inline

Sum of two angles.

Parameters

rhs	Right hand side of the sum

Returns

Sum of the two angles

Definition at line 96 of file Angle.h.

operator-()

Q_INVOKABLE Units::Angle Units::Angle::operator- ( Units::Angle rhs ) const

inline

Difference of two angles.

Parameters

rhs	Right hand side of the difference

Returns

Difference of the two angles

Definition at line 109 of file Angle.h.

operator==()

Q_INVOKABLE bool Units::Angle::operator== ( const Units::Angle & rhs ) const

nodiscarddefault

Comparison: equal.

Parameters

rhs	Right hand side of the comparison

Returns

Result of the comparison

sin()

Q_INVOKABLE double Units::Angle::sin ( ) const

inlinenodiscard

Sine of an angle, as a dimension-less number.

Returns

Sine of the angle

Definition at line 145 of file Angle.h.

toClock()

Q_INVOKABLE QString Units::Angle::toClock ( ) const

nodiscard

Convert angle to clock position.

Returns

Translated, human-readable string of of the form "12 o'clock", or "-" if the angle is not finite.

toDEG()

Q_INVOKABLE double Units::Angle::toDEG ( ) const

inlinenodiscard

Convert angle to degrees.

Returns

Angle, as a number in degrees. The result is NaN, or lies in the interval [0.0, 360.0]

Definition at line 172 of file Angle.h.

toRAD()

Q_INVOKABLE double Units::Angle::toRAD ( ) const

inlinenodiscard

Convert angle to radian.

Returns

Angle, as a number in radian

Definition at line 189 of file Angle.h.

---

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

• /home/runner/work/enroute/enroute/src/units/Angle.h