AMCAX::ElectricCurrentUnit Class Reference

Class for SI Base Units. More...

#include <misc/ElectricCurrentUnit.hpp>

Inheritance diagram for AMCAX::ElectricCurrentUnit:

Collaboration diagram for AMCAX::ElectricCurrentUnit:

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

ElectricCurrentUnit() [1/4]

AMCAX_API AMCAX::ElectricCurrentUnit::ElectricCurrentUnit

(

const double

multiplication

)

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

ElectricCurrentUnit() [2/4]

AMCAX_API AMCAX::ElectricCurrentUnit::ElectricCurrentUnit

(

const UnitPrefix

prefix

)

Construct a new ElectricCurrentUnit object with a prefix.

Parameters

prefix

The prefix of the unit

ElectricCurrentUnit() [3/4]

AMCAX_API AMCAX::ElectricCurrentUnit::ElectricCurrentUnit

(

const ElectricCurrentUnit &

other

)

Copy constructor.

Parameters

other

The other ElectricCurrentUnit object

ElectricCurrentUnit() [4/4]

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

noexcept

Move constructor.

Parameters

other

The other ElectricCurrentUnit object

Member Function Documentation

operator!=()

AMCAX_API bool AMCAX::ElectricCurrentUnit::operator!=

(

const ElectricCurrentUnit &

other

)

const

If the ElectricCurrentUnit different from the other ElectricCurrentUnit.

Parameters

other

The other ElectricCurrentUnit to compare with

Returns

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

operator<()

AMCAX_API bool AMCAX::ElectricCurrentUnit::operator<

(

const ElectricCurrentUnit &

other

)

const

If the ElectricCurrentUnit less than the other ElectricCurrentUnit.

Parameters

other

The other ElectricCurrentUnit to compare with

Returns

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

operator<=()

AMCAX_API bool AMCAX::ElectricCurrentUnit::operator<=

(

const ElectricCurrentUnit &

other

)

const

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

Parameters

other

The other ElectricCurrentUnit to compare with

Returns

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

operator=() [1/2]

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

noexcept

Move assignment operator.

Parameters

other

The other ElectricCurrentUnit object

Returns

The ElectricCurrentUnit object

operator=() [2/2]

AMCAX_API ElectricCurrentUnit & AMCAX::ElectricCurrentUnit::operator=

(

const ElectricCurrentUnit &

other

)

Copy assignment operator.

Parameters

other

The other ElectricCurrentUnit object

Returns

The ElectricCurrentUnit object

operator==()

AMCAX_API bool AMCAX::ElectricCurrentUnit::operator==

(

const ElectricCurrentUnit &

other

)

const

If the ElectricCurrentUnit same as the other ElectricCurrentUnit.

Parameters

other

The other ElectricCurrentUnit to compare with

Returns

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

operator>()

AMCAX_API bool AMCAX::ElectricCurrentUnit::operator>

(

const ElectricCurrentUnit &

other

)

const

If the ElectricCurrentUnit greater than the other ElectricCurrentUnit.

Parameters

other

The other ElectricCurrentUnit to compare with

Returns

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

operator>=()

AMCAX_API bool AMCAX::ElectricCurrentUnit::operator>=

(

const ElectricCurrentUnit &

other

)

const

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

Parameters

other

The other ElectricCurrentUnit to compare with

Returns

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

SetMultiplication()

AMCAX_API ElectricCurrentUnit & AMCAX::ElectricCurrentUnit::SetMultiplication

(

const double

multiplication

)

Set the multiplication of the unit.

Parameters

multiplication

How many base units are in the multiplication unit

Returns

The ElectricCurrentUnit object

SetPrefix()

AMCAX_API ElectricCurrentUnit & AMCAX::ElectricCurrentUnit::SetPrefix

(

const UnitPrefix

prefix

)

Set the prefix of the unit.

Parameters

prefix

The prefix of the unit

Returns

The ElectricCurrentUnit object

---

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

• misc/ElectricCurrentUnit.hpp