DataType AngularVelocity. More...

#include <ad/physics/AngularVelocity.hpp>

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

_AD_PHYSICS_ANGULARVELOCITY_EXPLICIT_CONVERSION_	AngularVelocity (double const iAngularVelocity)
	standard constructor More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

bool	isValid () const

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

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

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

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

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

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

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

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

Detailed Description

DataType AngularVelocity.

The rate of change of angular velocity of an object with respect to time. The unit is: RadianPerSecond

Constructor & Destructor Documentation

◆ AngularVelocity() [1/2]

ad::physics::AngularVelocity::AngularVelocity ( )

inline

default constructor

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

◆ AngularVelocity() [2/2]

_AD_PHYSICS_ANGULARVELOCITY_EXPLICIT_CONVERSION_ ad::physics::AngularVelocity::AngularVelocity ( double const iAngularVelocity )

inline

standard constructor

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

Member Function Documentation

◆ ensureValid()

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

inline

ensure that the AngularVelocity is valid

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

◆ ensureValidNonZero()

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

inline

ensure that the AngularVelocity is valid and non zero

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

◆ isValid()

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

inline

Returns: true if the AngularVelocity in a valid range

An AngularVelocity value is defined to be valid if:

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

◆ operator double()

_AD_PHYSICS_ANGULARVELOCITY_EXPLICIT_CONVERSION_ ad::physics::AngularVelocity::operator double ( ) const

inline

conversion to base type: double

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

◆ operator!=()

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

inline

standard comparison operator

Parameters

[in] other Other AngularVelocity.

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

◆ operator*()

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

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

inline

standard arithmetic operator

Parameters

[in] other Other AngularVelocity

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

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

inline

standard arithmetic operator

Parameters

[in] other Other AngularVelocity

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]

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

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

inline

standard arithmetic operator

Parameters

[in] other Other AngularVelocity

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

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

inline

standard arithmetic operator

Parameters

[in] other Other AngularVelocity

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

inline

standard arithmetic operator

Parameters

[in] other Other AngularVelocity

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

◆ operator/() [2/2]

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

inline

standard comparison operator

Parameters

[in] other Other AngularVelocity.

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

Note: the precision of AngularVelocity is considered

◆ operator<=()

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

inline

standard comparison operator

Parameters

[in] other Other AngularVelocity

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

Note: the precision of AngularVelocity is considered

◆ operator=() [1/2]

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

default

standard move operator

Parameters

[in] other Other AngularVelocity

Returns: Reference to this AngularVelocity.

◆ operator=() [2/2]

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

default

standard assignment operator

Parameters

[in] other Other AngularVelocity

Returns: Reference to this AngularVelocity.

◆ operator==()

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

inline

standard comparison operator

Parameters

[in] other Other AngularVelocity

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

◆ operator>()

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

inline

standard comparison operator

Parameters

[in] other Other AngularVelocity.

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

Note: the precision of AngularVelocity is considered

◆ operator>=()

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

inline

standard comparison operator

Parameters

[in] other Other AngularVelocity.

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

Note: the precision of AngularVelocity is considered

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

generated/include/ad/physics/AngularVelocity.hpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AngularVelocity() [1/2]

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