DataType Longitude. More...

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

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

_AD_MAP_POINT_LONGITUDE_EXPLICIT_CONVERSION_	Longitude (double const iLongitude)
	standard constructor More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

bool	isValid () const

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

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

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

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

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

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

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

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

Detailed Description

DataType Longitude.

WGS-84 Longitude The unit is: Degree

Constructor & Destructor Documentation

◆ Longitude() [1/2]

ad::map::point::Longitude::Longitude ( )

inline

default constructor

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

◆ Longitude() [2/2]

_AD_MAP_POINT_LONGITUDE_EXPLICIT_CONVERSION_ ad::map::point::Longitude::Longitude ( double const iLongitude )

inline

standard constructor

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

Member Function Documentation

◆ ensureValid()

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

inline

ensure that the Longitude is valid

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

◆ ensureValidNonZero()

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

inline

ensure that the Longitude is valid and non zero

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

◆ isValid()

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

inline

Returns: true if the Longitude in a valid range

An Longitude value is defined to be valid if:

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

◆ operator double()

_AD_MAP_POINT_LONGITUDE_EXPLICIT_CONVERSION_ ad::map::point::Longitude::operator double ( ) const

inline

conversion to base type: double

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

◆ operator!=()

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

inline

standard comparison operator

Parameters

[in] other Other Longitude.

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

◆ operator*()

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

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

inline

standard arithmetic operator

Parameters

[in] other Other Longitude

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

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

inline

standard arithmetic operator

Parameters

[in] other Other Longitude

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]

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

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

inline

standard arithmetic operator

Parameters

[in] other Other Longitude

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

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

inline

standard arithmetic operator

Parameters

[in] other Other Longitude

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]

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

inline

standard arithmetic operator

Parameters

[in] other Other Longitude

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

◆ operator<()

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

inline

standard comparison operator

Parameters

[in] other Other Longitude.

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

Note: the precision of Longitude is considered

◆ operator<=()

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

inline

standard comparison operator

Parameters

[in] other Other Longitude

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

Note: the precision of Longitude is considered

◆ operator=() [1/2]

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

default

standard assignment operator

Parameters

[in] other Other Longitude

Returns: Reference to this Longitude.

◆ operator=() [2/2]

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

default

standard move operator

Parameters

[in] other Other Longitude

Returns: Reference to this Longitude.

◆ operator==()

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

inline

standard comparison operator

Parameters

[in] other Other Longitude

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

◆ operator>()

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

inline

standard comparison operator

Parameters

[in] other Other Longitude.

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

Note: the precision of Longitude is considered

◆ operator>=()

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

inline

standard comparison operator

Parameters

[in] other Other Longitude.

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

Note: the precision of Longitude is considered

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

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Longitude() [1/2]

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