ostk.physics.unit.ElectricCurrent

class ElectricCurrent(

self: ostk.physics.unit.ElectricCurrent,

arg0: ostk.core.type.Real,

arg1: ostk::physics::unit::ElectricCurrent::Unit,

)

Bases: pybind11_object

Electric current.

https://en.wikipedia.org/wiki/Electric_current

Constructor.

Parameters:

• aReal (Real) -- A real number.

• aUnit (ElectricCurrent.Unit) -- An electric current unit.

Methods

amperes	Construct an electric current in amperes.
get_unit	Get the electric current unit.
in_amperes	Get the electric current in amperes.
in_unit	Get the electric current in a given unit.
is_defined	Check if the electric current is defined.
string_from_unit	Get the string representation of an electric current unit.
symbol_from_unit	Get the symbol of an electric current unit.
to_string	Get the string representation of the electric current.
undefined	Get an undefined electric current.

class Unit(self: ostk.physics.unit.ElectricCurrent.Unit, value: int)

Bases: pybind11_object

Members:

Undefined :

Undefined.

Ampere :

Ampere (SI).

property name

static amperes(arg0: ostk.core.type.Real) → ostk.physics.unit.ElectricCurrent

Construct an electric current in amperes.

Returns:

An electric current in amperes.

Return type:

ElectricCurrent

get_unit(

self: ostk.physics.unit.ElectricCurrent,

) → ostk::physics::unit::ElectricCurrent::Unit

Get the electric current unit.

Returns:

The electric current unit.

Return type:

ElectricCurrent.Unit

in_amperes(

self: ostk.physics.unit.ElectricCurrent,

) → ostk.core.type.Real

Get the electric current in amperes.

Returns:

The electric current in amperes.

Return type:

float

in_unit(

self: ostk.physics.unit.ElectricCurrent,

arg0: ostk::physics::unit::ElectricCurrent::Unit,

) → ostk.core.type.Real

Get the electric current in a given unit.

Returns:

The electric current in the given unit.

Return type:

float

is_defined(self: ostk.physics.unit.ElectricCurrent) → bool

Check if the electric current is defined.

Returns:

True if defined.

Return type:

bool

static string_from_unit(

arg0: ostk::physics::unit::ElectricCurrent::Unit,

) → ostk.core.type.String

Get the string representation of an electric current unit.

Returns:

The string representation.

Return type:

str

static symbol_from_unit(

arg0: ostk::physics::unit::ElectricCurrent::Unit,

) → ostk.core.type.String

Get the symbol of an electric current unit.

Returns:

The symbol.

Return type:

str

to_string(

self: ostk.physics.unit.ElectricCurrent,

aPrecision: ostk.core.type.Integer = Undefined,

) → ostk.core.type.String

Get the string representation of the electric current.

Parameters:

aPrecision (int) -- A precision.

Returns:

The string representation.

Return type:

str

static undefined() → ostk.physics.unit.ElectricCurrent

Get an undefined electric current.

Returns:

An undefined electric current.

Return type:

ElectricCurrent