AMCAX::ThermodynamicTemperatureUnit Class Reference

Class for SI Base Units. More...

#include <misc/ThermodynamicTemperatureUnit.hpp>

Inheritance diagram for AMCAX::ThermodynamicTemperatureUnit:

Collaboration diagram for AMCAX::ThermodynamicTemperatureUnit:

Public Member Functions
AMCAX_API	ThermodynamicTemperatureUnit ()
	Default constructor.
AMCAX_API	ThermodynamicTemperatureUnit (const double multiplication)
	Construct a new ThermodynamicTemperatureUnit object with a multiplication. More...
AMCAX_API	ThermodynamicTemperatureUnit (const UnitPrefix prefix)
	Construct a new ThermodynamicTemperatureUnit object with a prefix. More...
AMCAX_API	ThermodynamicTemperatureUnit (const ThermodynamicTemperatureUnit &other)
	Copy constructor. More...
AMCAX_API	ThermodynamicTemperatureUnit (const ThermodynamicTemperatureUnit &&other) noexcept
	Move constructor. More...
AMCAX_API ThermodynamicTemperatureUnit &	operator= (const ThermodynamicTemperatureUnit &other)
	Copy assignment operator. More...
AMCAX_API ThermodynamicTemperatureUnit &	operator= (const ThermodynamicTemperatureUnit &&other) noexcept
	Move assignment operator. More...
AMCAX_API	~ThermodynamicTemperatureUnit () override
	Destructor.
AMCAX_API ThermodynamicTemperatureUnit &	SetPrefix (const UnitPrefix prefix)
	Set the prefix of the unit. More...
AMCAX_API ThermodynamicTemperatureUnit &	SetMultiplication (const double multiplication)
	Set the multiplication of the unit. More...
AMCAX_API bool	operator== (const ThermodynamicTemperatureUnit &other) const
	If the ThermodynamicTemperatureUnit same as the other ThermodynamicTemperatureUnit. More...
AMCAX_API bool	operator!= (const ThermodynamicTemperatureUnit &other) const
	If the ThermodynamicTemperatureUnit different from the other ThermodynamicTemperatureUnit. More...
AMCAX_API bool	operator< (const ThermodynamicTemperatureUnit &other) const
	If the ThermodynamicTemperatureUnit less than the other ThermodynamicTemperatureUnit. More...
AMCAX_API bool	operator> (const ThermodynamicTemperatureUnit &other) const
	If the ThermodynamicTemperatureUnit greater than the other ThermodynamicTemperatureUnit. More...
AMCAX_API bool	operator<= (const ThermodynamicTemperatureUnit &other) const
	If the ThermodynamicTemperatureUnit less than or equal to the other ThermodynamicTemperatureUnit. More...
AMCAX_API bool	operator>= (const ThermodynamicTemperatureUnit &other) const
	If the ThermodynamicTemperatureUnit greater than or equal to the other ThermodynamicTemperatureUnit. More...
Public Member Functions inherited from AMCAX::AbstructUnit
AMCAX_API const UnitPrefix &	GetPrefix () const
	Get an immutable reference to the prefix of the unit. More...
AMCAX_API const double &	GetMultiplication () const
	Get the derived prefix of the unit. More...
virtual AMCAX_API double	ToBase (const double value=1.0) const
	Get the derived value of the unit. More...
AMCAX_API bool	IsEqual (const AbstructUnit &other, const double tol=1E-12) const
	If the AbstructUnit same as the other AbstructUnit within a tolerance. More...
AMCAX_API bool	IsEqualE (const AbstructUnit &other) const
	If the AbstructUnit same as the other AbstructUnit within the epsilon. More...

Detailed Description

Class for SI Base Units.

Constructor & Destructor Documentation

ThermodynamicTemperatureUnit() [1/4]

AMCAX_API AMCAX::ThermodynamicTemperatureUnit::ThermodynamicTemperatureUnit

(

const double

multiplication

)

Construct a new ThermodynamicTemperatureUnit object with a multiplication.

Parameters

multiplication

How many base units are in the multiplication unit

Note

This constructor should only be used to create a non-SI unit

ThermodynamicTemperatureUnit() [2/4]

AMCAX_API AMCAX::ThermodynamicTemperatureUnit::ThermodynamicTemperatureUnit

(

const UnitPrefix

prefix

)

Construct a new ThermodynamicTemperatureUnit object with a prefix.

Parameters

prefix

The prefix of the unit

ThermodynamicTemperatureUnit() [3/4]

AMCAX_API AMCAX::ThermodynamicTemperatureUnit::ThermodynamicTemperatureUnit

(

const ThermodynamicTemperatureUnit &

other

)

Copy constructor.

Parameters

other

The other ThermodynamicTemperatureUnit object

ThermodynamicTemperatureUnit() [4/4]

AMCAX_API AMCAX::ThermodynamicTemperatureUnit::ThermodynamicTemperatureUnit ( const ThermodynamicTemperatureUnit &&  other )

noexcept

Move constructor.

Parameters

other

The other ThermodynamicTemperatureUnit object

Member Function Documentation

operator!=()

AMCAX_API bool AMCAX::ThermodynamicTemperatureUnit::operator!=

(

const ThermodynamicTemperatureUnit &

other

)

const

If the ThermodynamicTemperatureUnit different from the other ThermodynamicTemperatureUnit.

Parameters

other

The other ThermodynamicTemperatureUnit to compare with

Returns

True if the ThermodynamicTemperatureUnit is different from the other ThermodynamicTemperatureUnit, false otherwise

operator<()

AMCAX_API bool AMCAX::ThermodynamicTemperatureUnit::operator<

(

const ThermodynamicTemperatureUnit &

other

)

const

If the ThermodynamicTemperatureUnit less than the other ThermodynamicTemperatureUnit.

Parameters

other

The other ThermodynamicTemperatureUnit to compare with

Returns

True if the ThermodynamicTemperatureUnit is less than the other ThermodynamicTemperatureUnit, false otherwise

operator<=()

AMCAX_API bool AMCAX::ThermodynamicTemperatureUnit::operator<=

(

const ThermodynamicTemperatureUnit &

other

)

const

If the ThermodynamicTemperatureUnit less than or equal to the other ThermodynamicTemperatureUnit.

Parameters

other

The other ThermodynamicTemperatureUnit to compare with

Returns

True if the ThermodynamicTemperatureUnit is less than or equal to the other ThermodynamicTemperatureUnit, false otherwise

operator=() [1/2]

AMCAX_API ThermodynamicTemperatureUnit & AMCAX::ThermodynamicTemperatureUnit::operator= ( const ThermodynamicTemperatureUnit &&  other )

noexcept

Move assignment operator.

Parameters

other

The other ThermodynamicTemperatureUnit object

Returns

The ThermodynamicTemperatureUnit object

operator=() [2/2]

AMCAX_API ThermodynamicTemperatureUnit & AMCAX::ThermodynamicTemperatureUnit::operator=

(

const ThermodynamicTemperatureUnit &

other

)

Copy assignment operator.

Parameters

other

The other ThermodynamicTemperatureUnit object

Returns

The ThermodynamicTemperatureUnit object

operator==()

AMCAX_API bool AMCAX::ThermodynamicTemperatureUnit::operator==

(

const ThermodynamicTemperatureUnit &

other

)

const

If the ThermodynamicTemperatureUnit same as the other ThermodynamicTemperatureUnit.

Parameters

other

The other ThermodynamicTemperatureUnit to compare with

Returns

True if the ThermodynamicTemperatureUnit is the same as the other ThermodynamicTemperatureUnit, false otherwise

operator>()

AMCAX_API bool AMCAX::ThermodynamicTemperatureUnit::operator>

(

const ThermodynamicTemperatureUnit &

other

)

const

If the ThermodynamicTemperatureUnit greater than the other ThermodynamicTemperatureUnit.

Parameters

other

The other ThermodynamicTemperatureUnit to compare with

Returns

True if the ThermodynamicTemperatureUnit is greater than the other ThermodynamicTemperatureUnit, false otherwise

operator>=()

AMCAX_API bool AMCAX::ThermodynamicTemperatureUnit::operator>=

(

const ThermodynamicTemperatureUnit &

other

)

const

If the ThermodynamicTemperatureUnit greater than or equal to the other ThermodynamicTemperatureUnit.

Parameters

other

The other ThermodynamicTemperatureUnit to compare with

Returns

True if the ThermodynamicTemperatureUnit is greater than or equal to the other ThermodynamicTemperatureUnit, false otherwise

SetMultiplication()

AMCAX_API ThermodynamicTemperatureUnit & AMCAX::ThermodynamicTemperatureUnit::SetMultiplication

(

const double

multiplication

)

Set the multiplication of the unit.

Parameters

multiplication

How many base units are in the multiplication unit

Returns

The ThermodynamicTemperatureUnit object

SetPrefix()

AMCAX_API ThermodynamicTemperatureUnit & AMCAX::ThermodynamicTemperatureUnit::SetPrefix

(

const UnitPrefix

prefix

)

Set the prefix of the unit.

Parameters

prefix

The prefix of the unit

Returns

The ThermodynamicTemperatureUnit object

---

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

• misc/ThermodynamicTemperatureUnit.hpp