DataType Angle. More...

#include <ad/physics/Angle.hpp>

Public Member Functions
	Angle ()
	default constructor More...

_AD_PHYSICS_ANGLE_EXPLICIT_CONVERSION_	Angle (double const iAngle)
	standard constructor More...

	Angle (const Angle &other)=default
	standard copy constructor

	Angle (Angle &&other)=default
	standard move constructor

Angle &	operator= (const Angle &other)=default
	standard assignment operator More...

Angle &	operator= (Angle &&other)=default
	standard move operator More...

bool	operator== (const Angle &other) const
	standard comparison operator More...

bool	operator!= (const Angle &other) const
	standard comparison operator More...

bool	operator> (const Angle &other) const
	standard comparison operator More...

bool	operator< (const Angle &other) const
	standard comparison operator More...

bool	operator>= (const Angle &other) const
	standard comparison operator More...

bool	operator<= (const Angle &other) const
	standard comparison operator More...

Angle	operator+ (const Angle &other) const
	standard arithmetic operator More...

Angle &	operator+= (const Angle &other)
	standard arithmetic operator More...

Angle	operator- (const Angle &other) const
	standard arithmetic operator More...

Angle	operator-= (const Angle &other)
	standard arithmetic operator More...

Angle	operator* (const double &scalar) const
	standard arithmetic operator More...

Angle	operator/ (const double &scalar) const
	standard arithmetic operator More...

double	operator/ (const Angle &other) const
	standard arithmetic operator More...

Angle	operator- () const
	standard arithmetic operator More...

_AD_PHYSICS_ANGLE_EXPLICIT_CONVERSION_	operator double () const
	conversion to base type: double More...

bool	isValid () const

void	ensureValid () const
	ensure that the Angle is valid More...

void	ensureValidNonZero () const
	ensure that the Angle is valid and non zero More...

Static Public Member Functions
static Angle	getMin ()
	get minimum valid Angle (i.e. cMinValue)

static Angle	getMax ()
	get maximum valid Angle (i.e. cMaxValue)

static Angle	getPrecision ()
	get assumed accuracy of Angle (i.e. cPrecisionValue)

Static Public Attributes
static const double	cMinValue
	constant defining the minimum valid Angle value (used in isValid())

static const double	cMaxValue
	constant defining the maximum valid Angle value (used in isValid())

static const double	cPrecisionValue
	constant defining the assumed Angle value accuracy (used in comparison operator==(), operator!=())

Detailed Description

DataType Angle.

An angle measured in radians The unit is: Radian

Constructor & Destructor Documentation

◆ Angle() [1/2]

ad::physics::Angle::Angle ( )

inline

default constructor

The default value of Angle is: std::numeric_limits<double>::quiet_NaN()

◆ Angle() [2/2]

_AD_PHYSICS_ANGLE_EXPLICIT_CONVERSION_ ad::physics::Angle::Angle ( double const iAngle )

inline

standard constructor

Note: _AD_PHYSICS_ANGLE_EXPLICIT_CONVERSION_ defines, if only an explicit conversion is allowed.

Member Function Documentation

◆ ensureValid()

void ad::physics::Angle::ensureValid ( ) const

inline

ensure that the Angle is valid

Throws an std::out_of_range() exception if the Angle in not valid (i.e. isValid() returns false)

◆ ensureValidNonZero()

void ad::physics::Angle::ensureValidNonZero ( ) const

inline

ensure that the Angle is valid and non zero

Throws an std::out_of_range() exception if the Angle in not valid or zero (i.e. isValid() returns false)

◆ isValid()

bool ad::physics::Angle::isValid ( ) const

inline

Returns: true if the Angle in a valid range

An Angle value is defined to be valid if:

It is normal or zero (see std::fpclassify())
cMinValue <= value <= cMaxValue

◆ operator double()

_AD_PHYSICS_ANGLE_EXPLICIT_CONVERSION_ ad::physics::Angle::operator double ( ) const

inline

conversion to base type: double

Note: the conversion to the base type removes the physical unit. _AD_PHYSICS_ANGLE_EXPLICIT_CONVERSION_ defines, if only explicit calls are allowed.

◆ operator!=()

bool ad::physics::Angle::operator!= ( const Angle & other ) const

inline

standard comparison operator

Parameters

[in] other Other Angle.

Returns: true if one of the Angle is not valid or they can be taken as numerically different

◆ operator*()

Angle ad::physics::Angle::operator* ( const double & scalar ) const

inline

standard arithmetic operator

Parameters

[in] scalar Scalar double value

Returns: Result of arithmetic operation.

Note: throws a std::out_of_range exception if value or the result of the operation is not valid

◆ operator+()

Angle ad::physics::Angle::operator+ ( const Angle & other ) const

inline

standard arithmetic operator

Parameters

[in] other Other Angle

Returns: Result of arithmetic operation.

Note: throws a std::out_of_range exception if one of the two operands or the result of the operation is not valid

◆ operator+=()

Angle& ad::physics::Angle::operator+= ( const Angle & other )

inline

standard arithmetic operator

Parameters

[in] other Other Angle

Returns: Result of arithmetic operation.

Note: throws a std::out_of_range exception if one of the two operands or the result of the operation is not valid

◆ operator-() [1/2]

Angle ad::physics::Angle::operator- ( ) const

inline

standard arithmetic operator

Returns: Result of arithmetic operation.

Note: throws a std::out_of_range exception if this or the result of the operation is not valid

◆ operator-() [2/2]

Angle ad::physics::Angle::operator- ( const Angle & other ) const

inline

standard arithmetic operator

Parameters

[in] other Other Angle

Returns: Result of arithmetic operation.

Note: throws a std::out_of_range exception if one of the two operands or the result of the operation is not valid

◆ operator-=()

Angle ad::physics::Angle::operator-= ( const Angle & other )

inline

standard arithmetic operator

Parameters

[in] other Other Angle

Returns: Result of arithmetic operation.

Note: throws a std::out_of_range exception if one of the two operands or the result of the operation is not valid

◆ operator/() [1/2]

double ad::physics::Angle::operator/ ( const Angle & other ) const

inline

standard arithmetic operator

Parameters

[in] other Other Angle

Returns: Result of arithmetic operation.

Note: throws a std::out_of_range exception if one of the two operands or the result of the operation is not valid or other is zero; since Angle is a type with physical unit, the division results in the dimensionless type.

◆ operator/() [2/2]

Angle ad::physics::Angle::operator/ ( const double & scalar ) const

inline

standard arithmetic operator

Parameters

[in] scalar Scalar double value

Returns: Result of arithmetic operation.

Note: throws a std::out_of_range exception if this or the result of the operation is not valid or other is zero

◆ operator<()

bool ad::physics::Angle::operator< ( const Angle & other ) const

inline

standard comparison operator

Parameters

[in] other Other Angle.

Returns: true if both Angle are valid and this Angle is strictly numerically smaller than other.

Note: the precision of Angle is considered

◆ operator<=()

bool ad::physics::Angle::operator<= ( const Angle & other ) const

inline

standard comparison operator

Parameters

[in] other Other Angle

Returns: true if both Angle are valid and this Angle is numerically smaller than other.

Note: the precision of Angle is considered

◆ operator=() [1/2]

Angle& ad::physics::Angle::operator= ( Angle && other )

default

standard move operator

Parameters

[in] other Other Angle

Returns: Reference to this Angle.

◆ operator=() [2/2]

Angle& ad::physics::Angle::operator= ( const Angle & other )

default

standard assignment operator

Parameters

[in] other Other Angle

Returns: Reference to this Angle.

◆ operator==()

bool ad::physics::Angle::operator== ( const Angle & other ) const

inline

standard comparison operator

Parameters

[in] other Other Angle

Returns: true if both Angle are valid and can be taken as numerically equal

◆ operator>()

bool ad::physics::Angle::operator> ( const Angle & other ) const

inline

standard comparison operator

Parameters

[in] other Other Angle.

Returns: true if both Angle are valid and this Angle is strictly numerically greater than other.

Note: the precision of Angle is considered

◆ operator>=()

bool ad::physics::Angle::operator>= ( const Angle & other ) const

inline

standard comparison operator

Parameters

[in] other Other Angle.

Returns: true if both Angle are valid and this Angle is numerically greater than other.

Note: the precision of Angle is considered

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

generated/include/ad/physics/Angle.hpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Angle() [1/2]

◆ Angle() [2/2]

Member Function Documentation

◆ ensureValid()

◆ ensureValidNonZero()

◆ isValid()

◆ operator double()

◆ operator!=()

◆ operator*()

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator/() [1/2]

◆ operator/() [2/2]

◆ operator<()

◆ operator<=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator>()

◆ operator>=()