Current¶

class Current(value: float | int, unit: str)¶

Bases: UnitBase

Current object.

Attributes¶

unitstr: Symbol of the unit of measurement for electrical current.
valuefloat or int: Electrical current numerical value.

Methods¶

to(): It converts actual value to a new value computed using target_unit as the reference unit of measurement.

to(target_unit: str, inplace: bool = False) → Current¶

It converts actual value to a new value computed using target_unit as the reference unit of measurement.

If inplace is True, it overrides actual value and unit, otherwise it returns a new instance with the converted value and the target_unit as unit.

Parameters¶

target_unitstr: Target unit to which convert the current value.
inplacebool, optional: Whether to override the current instance value. Default is False, so it does not override the current value.

Returns¶

Current: Converted electrical current.

Raises

TypeError

If target_unit is not a str,
if inplace is not a bool.

KeyError

If the target_unit is not among available ones.

Examples

Current instantiation.

>>> from gearpy.units import Current
>>> i = Current(1, 'A')
>>> i
1 A

Conversion from ampere to milli-ampere with inplace=False by default, so it does not override the current value.

>>> i.to('mA')
1000.0 mA
>>> i
1 A

Conversion from ampere to milli-ampere with inplace=True, in order to override the current value.

>>> i.to('mA', inplace=True)
1000.0 mA
>>> i
1000.0 mA

property unit: str¶

Symbol of the unit of measurement for electrical current. It must be a str. Available units are:

'A' for ampere,
'mA' for milli-ampere,
'uA' for micro-ampere.

Returns¶

str: Symbol of the unit of measurement for electrical current.

Raises

TypeError: If unit is not a str.
KeyError: If the unit is not among available ones.

property value: float | int¶

Electrical current numerical value. The relative unit is expressed by the unit property.

Returns¶

float or int: Electrical current numerical value.

Raises

TypeError: If value is not a float or an int.