DataType ENUHeading. More...

#include <ad/map/point/ENUHeading.hpp>

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

_AD_MAP_POINT_ENUHEADING_EXPLICIT_CONVERSION_	ENUHeading (double const iENUHeading)
	standard constructor More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

bool	isValid () const

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

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

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

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

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

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

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

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

Detailed Description

DataType ENUHeading.

Angle in ENU coordinate system as angle measured from East to North axis (yaw) in radians. The unit is: Radian

Constructor & Destructor Documentation

◆ ENUHeading() [1/2]

ad::map::point::ENUHeading::ENUHeading ( )

inline

default constructor

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

◆ ENUHeading() [2/2]

_AD_MAP_POINT_ENUHEADING_EXPLICIT_CONVERSION_ ad::map::point::ENUHeading::ENUHeading ( double const iENUHeading )

inline

standard constructor

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

Member Function Documentation

◆ ensureValid()

void ad::map::point::ENUHeading::ensureValid ( ) const

inline

ensure that the ENUHeading is valid

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

◆ ensureValidNonZero()

void ad::map::point::ENUHeading::ensureValidNonZero ( ) const

inline

ensure that the ENUHeading is valid and non zero

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

◆ isValid()

bool ad::map::point::ENUHeading::isValid ( ) const

inline

Returns: true if the ENUHeading in a valid range

An ENUHeading value is defined to be valid if:

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

◆ operator double()

_AD_MAP_POINT_ENUHEADING_EXPLICIT_CONVERSION_ ad::map::point::ENUHeading::operator double ( ) const

inline

conversion to base type: double

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

◆ operator!=()

bool ad::map::point::ENUHeading::operator!= ( const ENUHeading & other ) const

inline

standard comparison operator

Parameters

[in] other Other ENUHeading.

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

◆ operator*()

ENUHeading ad::map::point::ENUHeading::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+()

ENUHeading ad::map::point::ENUHeading::operator+ ( const ENUHeading & other ) const

inline

standard arithmetic operator

Parameters

[in] other Other ENUHeading

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+=()

ENUHeading& ad::map::point::ENUHeading::operator+= ( const ENUHeading & other )

inline

standard arithmetic operator

Parameters

[in] other Other ENUHeading

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]

ENUHeading ad::map::point::ENUHeading::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]

ENUHeading ad::map::point::ENUHeading::operator- ( const ENUHeading & other ) const

inline

standard arithmetic operator

Parameters

[in] other Other ENUHeading

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-=()

ENUHeading ad::map::point::ENUHeading::operator-= ( const ENUHeading & other )

inline

standard arithmetic operator

Parameters

[in] other Other ENUHeading

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]

ENUHeading ad::map::point::ENUHeading::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/() [2/2]

double ad::map::point::ENUHeading::operator/ ( const ENUHeading & other ) const

inline

standard arithmetic operator

Parameters

[in] other Other ENUHeading

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 ENUHeading is a type with physical unit, the division results in the dimensionless type.

◆ operator<()

bool ad::map::point::ENUHeading::operator< ( const ENUHeading & other ) const

inline

standard comparison operator

Parameters

[in] other Other ENUHeading.

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

Note: the precision of ENUHeading is considered

◆ operator<=()

bool ad::map::point::ENUHeading::operator<= ( const ENUHeading & other ) const

inline

standard comparison operator

Parameters

[in] other Other ENUHeading

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

Note: the precision of ENUHeading is considered

◆ operator=() [1/2]

ENUHeading& ad::map::point::ENUHeading::operator= ( const ENUHeading & other )

default

standard assignment operator

Parameters

[in] other Other ENUHeading

Returns: Reference to this ENUHeading.

◆ operator=() [2/2]

ENUHeading& ad::map::point::ENUHeading::operator= ( ENUHeading && other )

default

standard move operator

Parameters

[in] other Other ENUHeading

Returns: Reference to this ENUHeading.

◆ operator==()

bool ad::map::point::ENUHeading::operator== ( const ENUHeading & other ) const

inline

standard comparison operator

Parameters

[in] other Other ENUHeading

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

◆ operator>()

bool ad::map::point::ENUHeading::operator> ( const ENUHeading & other ) const

inline

standard comparison operator

Parameters

[in] other Other ENUHeading.

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

Note: the precision of ENUHeading is considered

◆ operator>=()

bool ad::map::point::ENUHeading::operator>= ( const ENUHeading & other ) const

inline

standard comparison operator

Parameters

[in] other Other ENUHeading.

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

Note: the precision of ENUHeading is considered

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

generated/include/ad/map/point/ENUHeading.hpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ENUHeading() [1/2]

◆ ENUHeading() [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>=()