AMCAX::AbstructUnit Class Reference

Class for SI Base Units. More...

#include <misc/AbstructUnit.hpp>

Inheritance diagram for AMCAX::AbstructUnit:

Public Member Functions
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.

Member Function Documentation

GetMultiplication()

AMCAX_API const double & AMCAX::AbstructUnit::GetMultiplication

(

)

const

Get the derived prefix of the unit.

Returns

The derived prefix of the unit

GetPrefix()

AMCAX_API const UnitPrefix & AMCAX::AbstructUnit::GetPrefix

(

)

const

Get an immutable reference to the prefix of the unit.

Returns

An immutable reference to the prefix of the unit

IsEqual()

AMCAX_API bool AMCAX::AbstructUnit::IsEqual	(	const AbstructUnit &	other,
		const double	tol = 1E-12
	)		const

If the AbstructUnit same as the other AbstructUnit within a tolerance.

Parameters

other	The other AbstructUnit
tol	The tolerance to compare with

Returns

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

IsEqualE()

AMCAX_API bool AMCAX::AbstructUnit::IsEqualE

(

const AbstructUnit &

other

)

const

If the AbstructUnit same as the other AbstructUnit within the epsilon.

Parameters

other

The other AbstructUnit

Returns

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

ToBase()

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

virtual

Get the derived value of the unit.

Returns

The derived value of the unit

Reimplemented in AMCAX::MassUnit.

---

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

• misc/AbstructUnit.hpp