DataType Distance. More...

#include <ad/physics/Distance.hpp>

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

_AD_PHYSICS_DISTANCE_EXPLICIT_CONVERSION_	Distance (double const iDistance)
	standard constructor More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

DistanceSquared	operator* (const Distance &other) const
	standard arithmetic operator More...

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

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

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

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

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

bool	isValid () const

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

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

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

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

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

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

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

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

Detailed Description

DataType Distance.

The length of a specific path traveled between two points. The unit is: Meter

Constructor & Destructor Documentation

◆ Distance() [1/2]

ad::physics::Distance::Distance ( )

inline

default constructor

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

◆ Distance() [2/2]

_AD_PHYSICS_DISTANCE_EXPLICIT_CONVERSION_ ad::physics::Distance::Distance ( double const iDistance )

inline

standard constructor

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

Member Function Documentation

◆ ensureValid()

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

inline

ensure that the Distance is valid

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

◆ ensureValidNonZero()

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

inline

ensure that the Distance is valid and non zero

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

◆ isValid()

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

inline

Returns: true if the Distance in a valid range

An Distance value is defined to be valid if:

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

◆ operator double()

_AD_PHYSICS_DISTANCE_EXPLICIT_CONVERSION_ ad::physics::Distance::operator double ( ) const

inline

conversion to base type: double

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

◆ operator!=()

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

inline

standard comparison operator

Parameters

[in] other Other Distance.

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

◆ operator*() [1/2]

DistanceSquared ad::physics::Distance::operator* ( const Distance & other ) const

standard arithmetic operator

Parameters

[in] other Other Distance

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; since Distance is a type with physical unit, the multiplication results in the Squared type.

◆ operator*() [2/2]

Distance ad::physics::Distance::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+()

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

inline

standard arithmetic operator

Parameters

[in] other Other Distance

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

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

inline

standard arithmetic operator

Parameters

[in] other Other Distance

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]

Distance ad::physics::Distance::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]

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

inline

standard arithmetic operator

Parameters

[in] other Other Distance

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

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

inline

standard arithmetic operator

Parameters

[in] other Other Distance

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::Distance::operator/ ( const Distance & other ) const

inline

standard arithmetic operator

Parameters

[in] other Other Distance

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

◆ operator/() [2/2]

Distance ad::physics::Distance::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::Distance::operator< ( const Distance & other ) const

inline

standard comparison operator

Parameters

[in] other Other Distance.

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

Note: the precision of Distance is considered

◆ operator<=()

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

inline

standard comparison operator

Parameters

[in] other Other Distance

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

Note: the precision of Distance is considered

◆ operator=() [1/2]

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

default

standard assignment operator

Parameters

[in] other Other Distance

Returns: Reference to this Distance.

◆ operator=() [2/2]

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

default

standard move operator

Parameters

[in] other Other Distance

Returns: Reference to this Distance.

◆ operator==()

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

inline

standard comparison operator

Parameters

[in] other Other Distance

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

◆ operator>()

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

inline

standard comparison operator

Parameters

[in] other Other Distance.

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

Note: the precision of Distance is considered

◆ operator>=()

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

inline

standard comparison operator

Parameters

[in] other Other Distance.

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

Note: the precision of Distance is considered

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

generated/include/ad/physics/Distance.hpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Distance() [1/2]

◆ Distance() [2/2]

Member Function Documentation

◆ ensureValid()

◆ ensureValidNonZero()

◆ isValid()

◆ operator double()

◆ operator!=()

◆ operator*() [1/2]

◆ operator*() [2/2]

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