Electric current, also known as amperage. Represents a flow of electric charge or a time rate of change of electric charge. More...

#include "ElectricCurrent.hpp"

Public Member Functions
	ElectricCurrent ()=default
	Default constructor. Constructs an electric current with an uninitialized value. More...

	ElectricCurrent (const NumericType value, const Unit::ElectricCurrent unit)
	Constructor. Constructs an electric current with a given value expressed in a given electric current unit. More...

constexpr	ElectricCurrent (const ElectricCharge< NumericType > &electric_charge, const Time< NumericType > &time)
	Constructor. Constructs an electric current from a given electric charge and time using the definition of electric current. More...

constexpr	ElectricCurrent (const ElectricCharge< NumericType > &electric_charge, const Frequency< NumericType > &frequency)
	Constructor. Constructs an electric current from a given electric charge and frequency using the definition of electric current. More...

	~ElectricCurrent () noexcept=default
	Destructor. Destroys this electric current. More...

constexpr	ElectricCurrent (const ElectricCurrent< NumericType > &other)=default
	Copy constructor. Constructs an electric current by copying another one. More...

template<typename OtherNumericType >
constexpr	ElectricCurrent (const ElectricCurrent< OtherNumericType > &other)
	Copy constructor. Constructs an electric current by copying another one. More...

constexpr	ElectricCurrent (ElectricCurrent< NumericType > &&other) noexcept=default
	Move constructor. Constructs an electric current by moving another one. More...

constexpr ElectricCurrent< NumericType > &	operator= (const ElectricCurrent< NumericType > &other)=default
	Copy assignment operator. Assigns this electric current by copying another one. More...

template<typename OtherNumericType >
constexpr ElectricCurrent< NumericType > &	operator= (const ElectricCurrent< OtherNumericType > &other)
	Copy assignment operator. Assigns this electric current by copying another one. More...

constexpr ElectricCurrent< NumericType > &	operator= (ElectricCurrent< NumericType > &&other) noexcept=default
	Move assignment operator. Assigns this electric current by moving another one. More...

constexpr ElectricCurrent< NumericType >	operator+ (const ElectricCurrent< NumericType > &electric_current) const

constexpr ElectricCurrent< NumericType >	operator- (const ElectricCurrent< NumericType > &electric_current) const

constexpr ElectricCurrent< NumericType >	operator* (const NumericType number) const

constexpr ElectricCharge< NumericType >	operator* (const Time< NumericType > &time) const

constexpr ElectricCurrent< NumericType >	operator/ (const NumericType number) const

constexpr NumericType	operator/ (const ElectricCurrent< NumericType > &electric_current) const noexcept

constexpr ElectricCharge< NumericType >	operator/ (const Frequency< NumericType > &frequency) const

constexpr Frequency< NumericType >	operator/ (const ElectricCharge< NumericType > &electric_charge) const

constexpr void	operator+= (const ElectricCurrent< NumericType > &electric_current) noexcept

constexpr void	operator-= (const ElectricCurrent< NumericType > &electric_current) noexcept

constexpr void	operator*= (const NumericType number) noexcept

constexpr void	operator/= (const NumericType number) noexcept

constexpr double	Value () const noexcept
	Value of this physical quantity expressed in its standard unit of measure. More...

double	Value (const Unit::ElectricCurrent unit) const
	Value of this physical quantity expressed in a given unit of measure. More...

constexpr double	StaticValue () const
	Value of this physical quantity expressed in a given unit of measure. This method can be evaluated statically at compile-time. More...

constexpr double &	MutableValue () noexcept
	Returns the value of this physical quantity expressed in its standard unit of measure as a mutable value. More...

constexpr void	SetValue (const double value) noexcept
	Sets the value of this physical quantity expressed in its standard unit of measure to the given value. More...

std::string	Print () const
	Prints this physical quantity as a string. This physical quantity's value is expressed in its standard unit of measure. More...

std::string	Print (const Unit::ElectricCurrent unit) const
	Prints this physical quantity as a string. This physical quantity's value is expressed in the given unit of measure. More...

std::string	JSON () const
	Serializes this physical quantity as a JSON message. This physical quantity's value is expressed in its standard unit of measure. More...

std::string	JSON (const Unit::ElectricCurrent unit) const
	Serializes this physical quantity as a JSON message. This physical quantity's value is expressed in the given unit of measure. More...

std::string	XML () const
	Serializes this physical quantity as an XML message. This physical quantity's value is expressed in its standard unit of measure. More...

std::string	XML (const Unit::ElectricCurrent unit) const
	Serializes this physical quantity as an XML message. This physical quantity's value is expressed in the given unit of measure. More...

std::string	YAML () const
	Serializes this physical quantity as a YAML message. This physical quantity's value is expressed in its standard unit of measure. More...

std::string	YAML (const Unit::ElectricCurrent unit) const
	Serializes this physical quantity as a YAML message. This physical quantity's value is expressed in the given unit of measure. More...

Static Public Member Functions
static constexpr ElectricCurrent< NumericType >	Zero ()
	Statically creates an electric current of zero. More...

template<Unit::ElectricCurrent Unit>
static constexpr ElectricCurrent< NumericType >	Create (const NumericType value)
	Statically creates an electric current with a given value expressed in a given electric current unit. More...

static constexpr const PhQ::Dimensions &	Dimensions ()
	Physical dimension set of this physical quantity. More...

static constexpr Unit::ElectricCurrent	Unit ()
	Standard unit of measure for this physical quantity. This physical quantity's value is stored internally in this unit of measure. More...

Protected Attributes
double	value
	Value of this physical quantity expressed in its standard unit of measure. More...

Private Member Functions
constexpr	ElectricCurrent (const NumericType value)
	Constructor. Constructs an electric current with a given value expressed in the standard electric current unit. More...

Detailed Description

template<typename NumericType = double>
class PhQ::ElectricCurrent< NumericType >

Electric current, also known as amperage. Represents a flow of electric charge or a time rate of change of electric charge.

Definition at line 43 of file ElectricCurrent.hpp.

Constructor & Destructor Documentation

◆ ElectricCurrent() [1/8]

template<typename NumericType = double>

PhQ::ElectricCurrent< NumericType >::ElectricCurrent ( )

default

Default constructor. Constructs an electric current with an uninitialized value.

◆ ElectricCurrent() [2/8]

template<typename NumericType = double>

PhQ::ElectricCurrent< NumericType >::ElectricCurrent	(	const NumericType	value,
		const Unit::ElectricCurrent< NumericType >	unit
	)

inline

Constructor. Constructs an electric current with a given value expressed in a given electric current unit.

Definition at line 50 of file ElectricCurrent.hpp.

◆ ElectricCurrent() [3/8]

template<typename NumericType = double>

constexpr PhQ::ElectricCurrent< NumericType >::ElectricCurrent	(	const ElectricCharge< NumericType > &	electric_charge,
		const Time< NumericType > &	time
	)

inlineconstexpr

Constructor. Constructs an electric current from a given electric charge and time using the definition of electric current.

Definition at line 55 of file ElectricCurrent.hpp.

◆ ElectricCurrent() [4/8]

template<typename NumericType = double>

constexpr PhQ::ElectricCurrent< NumericType >::ElectricCurrent	(	const ElectricCharge< NumericType > &	electric_charge,
		const Frequency< NumericType > &	frequency
	)

inlineconstexpr

Constructor. Constructs an electric current from a given electric charge and frequency using the definition of electric current.

Definition at line 61 of file ElectricCurrent.hpp.

◆ ~ElectricCurrent()

template<typename NumericType = double>

PhQ::ElectricCurrent< NumericType >::~ElectricCurrent ( )

defaultnoexcept

Destructor. Destroys this electric current.

◆ ElectricCurrent() [5/8]

template<typename NumericType = double>

constexpr PhQ::ElectricCurrent< NumericType >::ElectricCurrent ( const ElectricCurrent< NumericType > & other )

constexprdefault

Copy constructor. Constructs an electric current by copying another one.

◆ ElectricCurrent() [6/8]

template<typename NumericType = double>

template<typename OtherNumericType >

constexpr PhQ::ElectricCurrent< NumericType >::ElectricCurrent ( const ElectricCurrent< OtherNumericType > & other )

inlineexplicitconstexpr

Copy constructor. Constructs an electric current by copying another one.

Definition at line 73 of file ElectricCurrent.hpp.

◆ ElectricCurrent() [7/8]

template<typename NumericType = double>

constexpr PhQ::ElectricCurrent< NumericType >::ElectricCurrent ( ElectricCurrent< NumericType > && other )

constexprdefaultnoexcept

Move constructor. Constructs an electric current by moving another one.

◆ ElectricCurrent() [8/8]

template<typename NumericType = double>

constexpr PhQ::ElectricCurrent< NumericType >::ElectricCurrent ( const NumericType value )

inlineexplicitconstexprprivate

Constructor. Constructs an electric current with a given value expressed in the standard electric current unit.

Definition at line 163 of file ElectricCurrent.hpp.

Member Function Documentation

◆ Create()

template<typename NumericType = double>

template<Unit::ElectricCurrent Unit>

static constexpr ElectricCurrent<NumericType> PhQ::ElectricCurrent< NumericType >::Create ( const NumericType value )

inlinestaticconstexpr

Statically creates an electric current with a given value expressed in a given electric current unit.

Definition at line 103 of file ElectricCurrent.hpp.

References PhQ::DimensionalScalar< Unit::ElectricCurrent, double >::value.

◆ Dimensions()

static constexpr const PhQ::Dimensions& PhQ::DimensionalScalar< Unit::ElectricCurrent , double >::Dimensions ( )

inlinestaticconstexprinherited

Physical dimension set of this physical quantity.

Definition at line 54 of file DimensionalScalar.hpp.

◆ JSON() [1/2]

std::string PhQ::DimensionalScalar< Unit::ElectricCurrent , double >::JSON ( ) const

inlineinherited

Serializes this physical quantity as a JSON message. This physical quantity's value is expressed in its standard unit of measure.

Definition at line 107 of file DimensionalScalar.hpp.

◆ JSON() [2/2]

std::string PhQ::DimensionalScalar< Unit::ElectricCurrent , double >::JSON ( const Unit::ElectricCurrent unit ) const

inlineinherited

Serializes this physical quantity as a JSON message. This physical quantity's value is expressed in the given unit of measure.

Definition at line 117 of file DimensionalScalar.hpp.

◆ MutableValue()

constexpr double & PhQ::DimensionalScalar< Unit::ElectricCurrent , double >::MutableValue ( )

inlineconstexprnoexceptinherited

Returns the value of this physical quantity expressed in its standard unit of measure as a mutable value.

Definition at line 83 of file DimensionalScalar.hpp.

◆ operator*() [1/2]

template<typename NumericType = double>

constexpr ElectricCurrent<NumericType> PhQ::ElectricCurrent< NumericType >::operator* ( const NumericType number ) const

inlineconstexpr

Definition at line 118 of file ElectricCurrent.hpp.

References PhQ::DimensionalScalar< Unit::ElectricCurrent, double >::value.

◆ operator*() [2/2]

template<typename NumericType = double>

constexpr ElectricCharge<NumericType> PhQ::ElectricCurrent< NumericType >::operator* ( const Time< NumericType > & time ) const

inlineconstexpr

Definition at line 122 of file ElectricCurrent.hpp.

◆ operator*=()

template<typename NumericType = double>

constexpr void PhQ::ElectricCurrent< NumericType >::operator*= ( const NumericType number )

inlineconstexprnoexcept

Definition at line 152 of file ElectricCurrent.hpp.

References PhQ::DimensionalScalar< Unit::ElectricCurrent, double >::value.

◆ operator+()

template<typename NumericType = double>

constexpr ElectricCurrent<NumericType> PhQ::ElectricCurrent< NumericType >::operator+ ( const ElectricCurrent< NumericType > & electric_current ) const

inlineconstexpr

Definition at line 108 of file ElectricCurrent.hpp.

References PhQ::DimensionalScalar< UnitType, NumericType >::value, and PhQ::DimensionalScalar< Unit::ElectricCurrent, double >::value.

◆ operator+=()

template<typename NumericType = double>

constexpr void PhQ::ElectricCurrent< NumericType >::operator+= ( const ElectricCurrent< NumericType > & electric_current )

inlineconstexprnoexcept

Definition at line 144 of file ElectricCurrent.hpp.

References PhQ::DimensionalScalar< Unit::ElectricCurrent, double >::value.

◆ operator-()

template<typename NumericType = double>

constexpr ElectricCurrent<NumericType> PhQ::ElectricCurrent< NumericType >::operator- ( const ElectricCurrent< NumericType > & electric_current ) const

inlineconstexpr

Definition at line 113 of file ElectricCurrent.hpp.

References PhQ::DimensionalScalar< UnitType, NumericType >::value, and PhQ::DimensionalScalar< Unit::ElectricCurrent, double >::value.

◆ operator-=()

template<typename NumericType = double>

constexpr void PhQ::ElectricCurrent< NumericType >::operator-= ( const ElectricCurrent< NumericType > & electric_current )

inlineconstexprnoexcept

Definition at line 148 of file ElectricCurrent.hpp.

References PhQ::DimensionalScalar< Unit::ElectricCurrent, double >::value.

◆ operator/() [1/4]

template<typename NumericType = double>

constexpr Frequency<NumericType> PhQ::ElectricCurrent< NumericType >::operator/ ( const ElectricCharge< NumericType > & electric_charge ) const

inlineconstexpr

Definition at line 139 of file ElectricCurrent.hpp.

◆ operator/() [2/4]

template<typename NumericType = double>

constexpr NumericType PhQ::ElectricCurrent< NumericType >::operator/ ( const ElectricCurrent< NumericType > & electric_current ) const

inlineconstexprnoexcept

Definition at line 130 of file ElectricCurrent.hpp.

References PhQ::DimensionalScalar< Unit::ElectricCurrent, double >::value.

◆ operator/() [3/4]

template<typename NumericType = double>

constexpr ElectricCharge<NumericType> PhQ::ElectricCurrent< NumericType >::operator/ ( const Frequency< NumericType > & frequency ) const

inlineconstexpr

Definition at line 135 of file ElectricCurrent.hpp.

◆ operator/() [4/4]

template<typename NumericType = double>

constexpr ElectricCurrent<NumericType> PhQ::ElectricCurrent< NumericType >::operator/ ( const NumericType number ) const

inlineconstexpr

Definition at line 126 of file ElectricCurrent.hpp.

References PhQ::DimensionalScalar< Unit::ElectricCurrent, double >::value.

◆ operator/=()

template<typename NumericType = double>

constexpr void PhQ::ElectricCurrent< NumericType >::operator/= ( const NumericType number )

inlineconstexprnoexcept

Definition at line 156 of file ElectricCurrent.hpp.

References PhQ::DimensionalScalar< Unit::ElectricCurrent, double >::value.

◆ operator=() [1/3]

template<typename NumericType = double>

constexpr ElectricCurrent<NumericType>& PhQ::ElectricCurrent< NumericType >::operator= ( const ElectricCurrent< NumericType > & other )

constexprdefault

Copy assignment operator. Assigns this electric current by copying another one.

◆ operator=() [2/3]

template<typename NumericType = double>

template<typename OtherNumericType >

constexpr ElectricCurrent<NumericType>& PhQ::ElectricCurrent< NumericType >::operator= ( const ElectricCurrent< OtherNumericType > & other )

inlineconstexpr

Copy assignment operator. Assigns this electric current by copying another one.

Definition at line 85 of file ElectricCurrent.hpp.

References PhQ::DimensionalScalar< UnitType, NumericType >::Value(), and PhQ::DimensionalScalar< Unit::ElectricCurrent, double >::value.

◆ operator=() [3/3]

template<typename NumericType = double>

constexpr ElectricCurrent<NumericType>& PhQ::ElectricCurrent< NumericType >::operator= ( ElectricCurrent< NumericType > && other )

constexprdefaultnoexcept

Move assignment operator. Assigns this electric current by moving another one.

◆ Print() [1/2]

std::string PhQ::DimensionalScalar< Unit::ElectricCurrent , double >::Print ( ) const

inlineinherited

Prints this physical quantity as a string. This physical quantity's value is expressed in its standard unit of measure.

Definition at line 95 of file DimensionalScalar.hpp.

◆ Print() [2/2]

std::string PhQ::DimensionalScalar< Unit::ElectricCurrent , double >::Print ( const Unit::ElectricCurrent unit ) const

inlineinherited

Prints this physical quantity as a string. This physical quantity's value is expressed in the given unit of measure.

Definition at line 101 of file DimensionalScalar.hpp.

◆ SetValue()

constexpr void PhQ::DimensionalScalar< Unit::ElectricCurrent , double >::SetValue ( const double value )

inlineconstexprnoexceptinherited

Sets the value of this physical quantity expressed in its standard unit of measure to the given value.

Definition at line 89 of file DimensionalScalar.hpp.

◆ StaticValue()

constexpr double PhQ::DimensionalScalar< Unit::ElectricCurrent , double >::StaticValue ( ) const

inlineconstexprinherited

Value of this physical quantity expressed in a given unit of measure. This method can be evaluated statically at compile-time.

Definition at line 77 of file DimensionalScalar.hpp.

◆ Unit()

static constexpr Unit::ElectricCurrent PhQ::DimensionalScalar< Unit::ElectricCurrent , double >::Unit ( )

inlinestaticconstexprinherited

Standard unit of measure for this physical quantity. This physical quantity's value is stored internally in this unit of measure.

Definition at line 60 of file DimensionalScalar.hpp.

◆ Value() [1/2]

constexpr double PhQ::DimensionalScalar< Unit::ElectricCurrent , double >::Value ( ) const

inlineconstexprnoexceptinherited

Value of this physical quantity expressed in its standard unit of measure.

Definition at line 65 of file DimensionalScalar.hpp.

◆ Value() [2/2]

double PhQ::DimensionalScalar< Unit::ElectricCurrent , double >::Value ( const Unit::ElectricCurrent unit ) const

inlineinherited

Value of this physical quantity expressed in a given unit of measure.

Definition at line 70 of file DimensionalScalar.hpp.

◆ XML() [1/2]

std::string PhQ::DimensionalScalar< Unit::ElectricCurrent , double >::XML ( ) const

inlineinherited

Serializes this physical quantity as an XML message. This physical quantity's value is expressed in its standard unit of measure.

Definition at line 127 of file DimensionalScalar.hpp.

◆ XML() [2/2]

std::string PhQ::DimensionalScalar< Unit::ElectricCurrent , double >::XML ( const Unit::ElectricCurrent unit ) const

inlineinherited

Serializes this physical quantity as an XML message. This physical quantity's value is expressed in the given unit of measure.

Definition at line 137 of file DimensionalScalar.hpp.

◆ YAML() [1/2]

std::string PhQ::DimensionalScalar< Unit::ElectricCurrent , double >::YAML ( ) const

inlineinherited

Serializes this physical quantity as a YAML message. This physical quantity's value is expressed in its standard unit of measure.

Definition at line 147 of file DimensionalScalar.hpp.

◆ YAML() [2/2]

std::string PhQ::DimensionalScalar< Unit::ElectricCurrent , double >::YAML ( const Unit::ElectricCurrent unit ) const

inlineinherited

Serializes this physical quantity as a YAML message. This physical quantity's value is expressed in the given unit of measure.

Definition at line 157 of file DimensionalScalar.hpp.

◆ Zero()

template<typename NumericType = double>

static constexpr ElectricCurrent<NumericType> PhQ::ElectricCurrent< NumericType >::Zero ( )

inlinestaticconstexpr

Statically creates an electric current of zero.

Definition at line 96 of file ElectricCurrent.hpp.

Member Data Documentation

◆ value

double PhQ::DimensionalScalar< Unit::ElectricCurrent , double >::value

protectedinherited

Value of this physical quantity expressed in its standard unit of measure.

Definition at line 221 of file DimensionalScalar.hpp.

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

PhQ/ElectricCharge.hpp
PhQ/ElectricCurrent.hpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

template<typename NumericType = double> class PhQ::ElectricCurrent< NumericType >

Constructor & Destructor Documentation

◆ ElectricCurrent() [1/8]

◆ ElectricCurrent() [2/8]

◆ ElectricCurrent() [3/8]

◆ ElectricCurrent() [4/8]

◆ ~ElectricCurrent()

◆ ElectricCurrent() [5/8]

◆ ElectricCurrent() [6/8]

◆ ElectricCurrent() [7/8]

◆ ElectricCurrent() [8/8]

Member Function Documentation

◆ Create()

◆ Dimensions()

◆ JSON() [1/2]

◆ JSON() [2/2]

◆ MutableValue()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/() [1/4]

◆ operator/() [2/4]

◆ operator/() [3/4]

◆ operator/() [4/4]

◆ operator/=()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ Print() [1/2]

◆ Print() [2/2]

◆ SetValue()

◆ StaticValue()

◆ Unit()

◆ Value() [1/2]

◆ Value() [2/2]

◆ XML() [1/2]

◆ XML() [2/2]

◆ YAML() [1/2]

◆ YAML() [2/2]

◆ Zero()

Member Data Documentation

◆ value

template<typename NumericType = double>
class PhQ::ElectricCurrent< NumericType >