AMCAX::MassUnit Class Reference

Class for SI Base Units. More...

#include <misc/MassUnit.hpp>

Inheritance diagram for AMCAX::MassUnit:

Collaboration diagram for AMCAX::MassUnit:

Public Member Functions
AMCAX_API	MassUnit ()
	Default constructor.
AMCAX_API	MassUnit (const double multiplication)
	Construct a new MassUnit object with a multiplication. More...
AMCAX_API	MassUnit (const UnitPrefix prefix)
	Construct a new MassUnit object with a prefix. More...
AMCAX_API	MassUnit (const MassUnit &other)
	Copy constructor. More...
AMCAX_API	MassUnit (const MassUnit &&other) noexcept
	Move constructor. More...
AMCAX_API MassUnit &	operator= (const MassUnit &other)
	Copy assignment operator. More...
AMCAX_API MassUnit &	operator= (const MassUnit &&other) noexcept
	Move assignment operator. More...
AMCAX_API	~MassUnit () override
	Destructor.
AMCAX_API MassUnit &	SetPrefix (const UnitPrefix prefix)
	Set the prefix of the unit. More...
AMCAX_API MassUnit &	SetMultiplication (const double multiplication)
	Set the multiplication of the unit. More...
AMCAX_API bool	operator== (const MassUnit &other) const
	If the MassUnit same as the other MassUnit. More...
AMCAX_API bool	operator!= (const MassUnit &other) const
	If the MassUnit different from the other MassUnit. More...
AMCAX_API bool	operator< (const MassUnit &other) const
	If the MassUnit less than the other MassUnit. More...
AMCAX_API bool	operator> (const MassUnit &other) const
	If the MassUnit greater than the other MassUnit. More...
AMCAX_API bool	operator<= (const MassUnit &other) const
	If the MassUnit less than or equal to the other MassUnit. More...
AMCAX_API bool	operator>= (const MassUnit &other) const
	If the MassUnit greater than or equal to the other MassUnit. More...
virtual AMCAX_API double	ToBase (const double value=1.0) const
	Get the derived value of the unit. 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

MassUnit() [1/4]

AMCAX_API AMCAX::MassUnit::MassUnit

(

const double

multiplication

)

Construct a new MassUnit 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

MassUnit() [2/4]

AMCAX_API AMCAX::MassUnit::MassUnit

(

const UnitPrefix

prefix

)

Construct a new MassUnit object with a prefix.

Parameters

prefix

The prefix of the unit

MassUnit() [3/4]

AMCAX_API AMCAX::MassUnit::MassUnit

(

const MassUnit &

other

)

Copy constructor.

Parameters

other

The other MassUnit object

MassUnit() [4/4]

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

noexcept

Move constructor.

Parameters

other

The other MassUnit object

Member Function Documentation

operator!=()

AMCAX_API bool AMCAX::MassUnit::operator!=

(

const MassUnit &

other

)

const

If the MassUnit different from the other MassUnit.

Parameters

other

The other MassUnit to compare with

Returns

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

operator<()

AMCAX_API bool AMCAX::MassUnit::operator<

(

const MassUnit &

other

)

const

If the MassUnit less than the other MassUnit.

Parameters

other

The other MassUnit to compare with

Returns

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

operator<=()

AMCAX_API bool AMCAX::MassUnit::operator<=

(

const MassUnit &

other

)

const

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

Parameters

other

The other MassUnit to compare with

Returns

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

operator=() [1/2]

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

noexcept

Move assignment operator.

Parameters

other

The other MassUnit object

Returns

The MassUnit object

operator=() [2/2]

AMCAX_API MassUnit & AMCAX::MassUnit::operator=

(

const MassUnit &

other

)

Copy assignment operator.

Parameters

other

The other MassUnit object

Returns

The MassUnit object

operator==()

AMCAX_API bool AMCAX::MassUnit::operator==

(

const MassUnit &

other

)

const

If the MassUnit same as the other MassUnit.

Parameters

other

The other MassUnit to compare with

Returns

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

operator>()

AMCAX_API bool AMCAX::MassUnit::operator>

(

const MassUnit &

other

)

const

If the MassUnit greater than the other MassUnit.

Parameters

other

The other MassUnit to compare with

Returns

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

operator>=()

AMCAX_API bool AMCAX::MassUnit::operator>=

(

const MassUnit &

other

)

const

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

Parameters

other

The other MassUnit to compare with

Returns

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

SetMultiplication()

AMCAX_API MassUnit & AMCAX::MassUnit::SetMultiplication

(

const double

multiplication

)

Set the multiplication of the unit.

Parameters

multiplication

How many base units are in the multiplication unit

Returns

The MassUnit object

SetPrefix()

AMCAX_API MassUnit & AMCAX::MassUnit::SetPrefix

(

const UnitPrefix

prefix

)

Set the prefix of the unit.

Parameters

prefix

The prefix of the unit

Returns

The MassUnit object

ToBase()

virtual AMCAX_API double AMCAX::MassUnit::ToBase ( const double  value = 1.0 ) const

virtual

Get the derived value of the unit.

Returns

The derived value of the unit

Reimplemented from AMCAX::AbstructUnit.

---

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

• misc/MassUnit.hpp