DataType AngularAcceleration. More...

#include <ad/physics/AngularAcceleration.hpp>

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

_AD_PHYSICS_ANGULARACCELERATION_EXPLICIT_CONVERSION_	AngularAcceleration (double const iAngularAcceleration)
	standard constructor More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

bool	isValid () const

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

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

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

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

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

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

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

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

Detailed Description

DataType AngularAcceleration.

The rate of change of AngularVelocity of an object with respect to time. The unit is: RadianPerSecondSquared

Constructor & Destructor Documentation

◆ AngularAcceleration() [1/2]

ad::physics::AngularAcceleration::AngularAcceleration ( )

inline

default constructor

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

◆ AngularAcceleration() [2/2]

_AD_PHYSICS_ANGULARACCELERATION_EXPLICIT_CONVERSION_ ad::physics::AngularAcceleration::AngularAcceleration ( double const iAngularAcceleration )

inline

standard constructor

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

Member Function Documentation

◆ ensureValid()

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

inline

ensure that the AngularAcceleration is valid

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

◆ ensureValidNonZero()

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

inline

ensure that the AngularAcceleration is valid and non zero

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

◆ isValid()

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

inline

Returns: true if the AngularAcceleration in a valid range

An AngularAcceleration value is defined to be valid if:

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

◆ operator double()

_AD_PHYSICS_ANGULARACCELERATION_EXPLICIT_CONVERSION_ ad::physics::AngularAcceleration::operator double ( ) const

inline

conversion to base type: double

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

◆ operator!=()

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

inline

standard comparison operator

Parameters

[in] other Other AngularAcceleration.

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

◆ operator*()

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

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

inline

standard arithmetic operator

Parameters

[in] other Other AngularAcceleration

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

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

inline

standard arithmetic operator

Parameters

[in] other Other AngularAcceleration

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]

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

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

inline

standard arithmetic operator

Parameters

[in] other Other AngularAcceleration

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

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

inline

standard arithmetic operator

Parameters

[in] other Other AngularAcceleration

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

inline

standard arithmetic operator

Parameters

[in] other Other AngularAcceleration

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

◆ operator/() [2/2]

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

inline

standard comparison operator

Parameters

[in] other Other AngularAcceleration.

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

Note: the precision of AngularAcceleration is considered

◆ operator<=()

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

inline

standard comparison operator

Parameters

[in] other Other AngularAcceleration

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

Note: the precision of AngularAcceleration is considered

◆ operator=() [1/2]

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

default

standard move operator

Parameters

[in] other Other AngularAcceleration

Returns: Reference to this AngularAcceleration.

◆ operator=() [2/2]

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

default

standard assignment operator

Parameters

[in] other Other AngularAcceleration

Returns: Reference to this AngularAcceleration.

◆ operator==()

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

inline

standard comparison operator

Parameters

[in] other Other AngularAcceleration

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

◆ operator>()

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

inline

standard comparison operator

Parameters

[in] other Other AngularAcceleration.

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

Note: the precision of AngularAcceleration is considered

◆ operator>=()

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

inline

standard comparison operator

Parameters

[in] other Other AngularAcceleration.

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

Note: the precision of AngularAcceleration is considered

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

generated/include/ad/physics/AngularAcceleration.hpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AngularAcceleration() [1/2]

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