AMCAX::LuminousIntensityUnit Class Reference

Class for SI Base Units. More...

#include <misc/LuminousIntensityUnit.hpp>

Inheritance diagram for AMCAX::LuminousIntensityUnit:

Collaboration diagram for AMCAX::LuminousIntensityUnit:

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

LuminousIntensityUnit() [1/4]

AMCAX_API AMCAX::LuminousIntensityUnit::LuminousIntensityUnit

(

const double

multiplication

)

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

LuminousIntensityUnit() [2/4]

AMCAX_API AMCAX::LuminousIntensityUnit::LuminousIntensityUnit

(

const UnitPrefix

prefix

)

Construct a new LuminousIntensityUnit object with a prefix.

Parameters

prefix

The prefix of the unit

LuminousIntensityUnit() [3/4]

AMCAX_API AMCAX::LuminousIntensityUnit::LuminousIntensityUnit

(

const LuminousIntensityUnit &

other

)

Copy constructor.

Parameters

other

The other LuminousIntensityUnit object

LuminousIntensityUnit() [4/4]

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

noexcept

Move constructor.

Parameters

other

The other LuminousIntensityUnit object

Member Function Documentation

operator!=()

AMCAX_API bool AMCAX::LuminousIntensityUnit::operator!=

(

const LuminousIntensityUnit &

other

)

const

If the LuminousIntensityUnit different from the other LuminousIntensityUnit.

Parameters

other

The other LuminousIntensityUnit to compare with

Returns

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

operator<()

AMCAX_API bool AMCAX::LuminousIntensityUnit::operator<

(

const LuminousIntensityUnit &

other

)

const

If the LuminousIntensityUnit less than the other LuminousIntensityUnit.

Parameters

other

The other LuminousIntensityUnit to compare with

Returns

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

operator<=()

AMCAX_API bool AMCAX::LuminousIntensityUnit::operator<=

(

const LuminousIntensityUnit &

other

)

const

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

Parameters

other

The other LuminousIntensityUnit to compare with

Returns

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

operator=() [1/2]

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

noexcept

Move assignment operator.

Parameters

other

The other LuminousIntensityUnit object

Returns

The LuminousIntensityUnit object

operator=() [2/2]

AMCAX_API LuminousIntensityUnit & AMCAX::LuminousIntensityUnit::operator=

(

const LuminousIntensityUnit &

other

)

Copy assignment operator.

Parameters

other

The other LuminousIntensityUnit object

Returns

The LuminousIntensityUnit object

operator==()

AMCAX_API bool AMCAX::LuminousIntensityUnit::operator==

(

const LuminousIntensityUnit &

other

)

const

If the LuminousIntensityUnit same as the other LuminousIntensityUnit.

Parameters

other

The other LuminousIntensityUnit to compare with

Returns

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

operator>()

AMCAX_API bool AMCAX::LuminousIntensityUnit::operator>

(

const LuminousIntensityUnit &

other

)

const

If the LuminousIntensityUnit greater than the other LuminousIntensityUnit.

Parameters

other

The other LuminousIntensityUnit to compare with

Returns

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

operator>=()

AMCAX_API bool AMCAX::LuminousIntensityUnit::operator>=

(

const LuminousIntensityUnit &

other

)

const

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

Parameters

other

The other LuminousIntensityUnit to compare with

Returns

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

SetMultiplication()

AMCAX_API LuminousIntensityUnit & AMCAX::LuminousIntensityUnit::SetMultiplication

(

const double

multiplication

)

Set the multiplication of the unit.

Parameters

multiplication

How many base units are in the multiplication unit

Returns

The LuminousIntensityUnit object

SetPrefix()

AMCAX_API LuminousIntensityUnit & AMCAX::LuminousIntensityUnit::SetPrefix

(

const UnitPrefix

prefix

)

Set the prefix of the unit.

Parameters

prefix

The prefix of the unit

Returns

The LuminousIntensityUnit object

---

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

• misc/LuminousIntensityUnit.hpp