DataType ENUCoordinate. More...

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

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

_AD_MAP_POINT_ENUCOORDINATE_EXPLICIT_CONVERSION_	ENUCoordinate (double const iENUCoordinate)
	standard constructor More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

bool	isValid () const

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

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

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

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

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

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

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

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

Detailed Description

DataType ENUCoordinate.

Maximum ENU coordinate (16 km): 16384 The unit is: Meter

Constructor & Destructor Documentation

◆ ENUCoordinate() [1/2]

ad::map::point::ENUCoordinate::ENUCoordinate ( )

inline

default constructor

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

◆ ENUCoordinate() [2/2]

_AD_MAP_POINT_ENUCOORDINATE_EXPLICIT_CONVERSION_ ad::map::point::ENUCoordinate::ENUCoordinate ( double const iENUCoordinate )

inline

standard constructor

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

Member Function Documentation

◆ ensureValid()

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

inline

ensure that the ENUCoordinate is valid

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

◆ ensureValidNonZero()

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

inline

ensure that the ENUCoordinate is valid and non zero

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

◆ isValid()

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

inline

Returns: true if the ENUCoordinate in a valid range

An ENUCoordinate value is defined to be valid if:

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

◆ operator double()

_AD_MAP_POINT_ENUCOORDINATE_EXPLICIT_CONVERSION_ ad::map::point::ENUCoordinate::operator double ( ) const

inline

conversion to base type: double

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

◆ operator!=()

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

inline

standard comparison operator

Parameters

[in] other Other ENUCoordinate.

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

◆ operator*()

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

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

inline

standard arithmetic operator

Parameters

[in] other Other ENUCoordinate

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

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

inline

standard arithmetic operator

Parameters

[in] other Other ENUCoordinate

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]

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

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

inline

standard arithmetic operator

Parameters

[in] other Other ENUCoordinate

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

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

inline

standard arithmetic operator

Parameters

[in] other Other ENUCoordinate

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]

ENUCoordinate ad::map::point::ENUCoordinate::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::ENUCoordinate::operator/ ( const ENUCoordinate & other ) const

inline

standard arithmetic operator

Parameters

[in] other Other ENUCoordinate

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

◆ operator<()

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

inline

standard comparison operator

Parameters

[in] other Other ENUCoordinate.

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

Note: the precision of ENUCoordinate is considered

◆ operator<=()

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

inline

standard comparison operator

Parameters

[in] other Other ENUCoordinate

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

Note: the precision of ENUCoordinate is considered

◆ operator=() [1/2]

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

default

standard assignment operator

Parameters

[in] other Other ENUCoordinate

Returns: Reference to this ENUCoordinate.

◆ operator=() [2/2]

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

default

standard move operator

Parameters

[in] other Other ENUCoordinate

Returns: Reference to this ENUCoordinate.

◆ operator==()

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

inline

standard comparison operator

Parameters

[in] other Other ENUCoordinate

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

◆ operator>()

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

inline

standard comparison operator

Parameters

[in] other Other ENUCoordinate.

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

Note: the precision of ENUCoordinate is considered

◆ operator>=()

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

inline

standard comparison operator

Parameters

[in] other Other ENUCoordinate.

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

Note: the precision of ENUCoordinate is considered

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

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ENUCoordinate() [1/2]

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