Package org.djunits.quantity
Class ElectricCurrent
java.lang.Object
java.lang.Number
org.djunits.quantity.def.Quantity<ElectricCurrent,ElectricCurrent.Unit>
org.djunits.quantity.ElectricCurrent
- All Implemented Interfaces:
Serializable,Comparable<ElectricCurrent>,Additive<ElectricCurrent>,Scalable<ElectricCurrent>,Value<ElectricCurrent.Unit,ElectricCurrent>
ElectricCurrent is the net rate of flow of electric charge through a surface.
Copyright (c) 2025-2026 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://djunits.org. The DJUNITS project is distributed under a three-clause BSD-style license.
- Author:
- Alexander Verbraeck
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classElectricCurrent.Unit encodes the units of electric current (A). -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ElectricCurrentConstant with value NaN.static final ElectricCurrentConstant with value -MAX_VALUE.static final ElectricCurrentConstant with value NEGATIVE_INFINITY.static final ElectricCurrentConstant with value one.static final ElectricCurrentConstant with value MAX_VALUE.static final ElectricCurrentConstant with value POSITIVE_INFINITY.static final ElectricCurrentConstant with value zero. -
Constructor Summary
ConstructorsConstructorDescriptionElectricCurrent(double value, String abbreviation) Instantiate a ElectricCurrent quantity with a unit, expressed as a String.ElectricCurrent(double value, ElectricCurrent.Unit unit) Instantiate a ElectricCurrent quantity with a unit.ElectricCurrent(ElectricCurrent value) Construct ElectricCurrent quantity. -
Method Summary
Modifier and TypeMethodDescriptionfinal ElectricPotentialCalculate the division of ElectricalCurrent and ElectricalConductance, which results in a ElectricalPotential scalar.final DimensionlessCalculate the division of ElectricCurrent and ElectricCurrent, which results in a Dimensionless quantity.final ElectricalConductanceCalculate the division of ElectricalCurrent and ElectricalPotential, which results in a ElectricalConductance scalar.instantiate(double si) Instantiate a quantity with an SI or base value.final ElectricChargeCalculate the multiplication of ElectricalCurrent and Duration, which results in a ElectricalCharge scalar.final ElectricPotentialCalculate the multiplication of ElectricalCurrent and ElectricalResistance, which results in a ElectricalPotential scalar.final PowerCalculate the multiplication of ElectricalCurrent and ElectricalPotential, which results in a Power scalar.static ElectricCurrentReturns a ElectricCurrent based on a value and the textual representation of the unit, which can be localized.static ElectricCurrentofSi(double si) Return a ElectricCurrent instance based on an SI value.siUnit()Return the SI unit of this quantity.static ElectricCurrentReturns a ElectricCurrent representation of a textual representation of a value with a unit.Methods inherited from class org.djunits.quantity.def.Quantity
abs, add, as, compareTo, divide, doubleValue, eq, eq0, equals, floatValue, format, format, ge, ge0, getDisplayUnit, getInUnit, getInUnit, getName, gt, gt0, hashCode, instantiate, interpolate, intValue, isRelative, le, le0, longValue, lt, lt0, max, mean, min, multiply, ne, ne0, negate, of, product, reciprocal, scaleBy, setDisplayUnit, si, subtract, sum, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toStringSIPrefixed, toTextualString, toTextualString, valueOfMethods inherited from class java.lang.Number
byteValue, shortValueMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.djunits.value.Value
isAbsolute, setDisplayUnit
-
Field Details
-
ZERO
Constant with value zero. -
ONE
Constant with value one. -
NaN
Constant with value NaN. -
POSITIVE_INFINITY
Constant with value POSITIVE_INFINITY. -
NEGATIVE_INFINITY
Constant with value NEGATIVE_INFINITY. -
POS_MAXVALUE
Constant with value MAX_VALUE. -
NEG_MAXVALUE
Constant with value -MAX_VALUE.
-
-
Constructor Details
-
ElectricCurrent
Instantiate a ElectricCurrent quantity with a unit.- Parameters:
value- the value, expressed in the unitunit- the unit in which the value is expressed
-
ElectricCurrent
Instantiate a ElectricCurrent quantity with a unit, expressed as a String.- Parameters:
value- the value, expressed in the unitabbreviation- the String abbreviation of the unit in which the value is expressed
-
ElectricCurrent
Construct ElectricCurrent quantity.- Parameters:
value- Scalar from which to construct this instance
-
-
Method Details
-
ofSi
Return a ElectricCurrent instance based on an SI value.- Parameters:
si- the si value- Returns:
- the ElectricCurrent instance based on an SI value
-
instantiate
Description copied from class:QuantityInstantiate a quantity with an SI or base value.- Specified by:
instantiatein classQuantity<ElectricCurrent,ElectricCurrent.Unit> - Parameters:
si- the value expressed in the base (SI) unit- Returns:
- a quantity with the given SI-value and base (SI) unit
-
siUnit
Description copied from class:QuantityReturn the SI unit of this quantity.- Overrides:
siUnitin classQuantity<ElectricCurrent,ElectricCurrent.Unit> - Returns:
- the SI unit of this quantity
-
valueOf
Returns a ElectricCurrent representation of a textual representation of a value with a unit. The String representation that can be parsed is the double value in the unit, followed by a localized or English abbreviation of the unit. Spaces are allowed, but not required, between the value and the unit.- Parameters:
text- the textual representation to parse into a ElectricCurrent- Returns:
- the Scalar representation of the value in its unit
- Throws:
IllegalArgumentException- when the text cannot be parsedNullPointerException- when the text argument is null
-
of
Returns a ElectricCurrent based on a value and the textual representation of the unit, which can be localized.- Parameters:
value- the value to useunitString- the textual representation of the unit- Returns:
- the Scalar representation of the value in its unit
- Throws:
IllegalArgumentException- when the unit cannot be parsed or is incorrectNullPointerException- when the unitString argument is null
-
divide
Calculate the division of ElectricCurrent and ElectricCurrent, which results in a Dimensionless quantity.- Parameters:
v- quantity- Returns:
- quantity as a division of ElectricCurrent and ElectricCurrent
-
multiply
Calculate the multiplication of ElectricalCurrent and ElectricalPotential, which results in a Power scalar.- Parameters:
v- scalar- Returns:
- scalar as a multiplication of ElectricalCurrent and ElectricalPotential
-
multiply
Calculate the multiplication of ElectricalCurrent and Duration, which results in a ElectricalCharge scalar.- Parameters:
v- scalar- Returns:
- scalar as a multiplication of ElectricalCurrent and Duration
-
multiply
Calculate the multiplication of ElectricalCurrent and ElectricalResistance, which results in a ElectricalPotential scalar.- Parameters:
v- scalar- Returns:
- scalar as a multiplication of ElectricalCurrent and ElectricalResistance
-
divide
Calculate the division of ElectricalCurrent and ElectricalPotential, which results in a ElectricalConductance scalar.- Parameters:
v- scalar- Returns:
- scalar as a division of ElectricalCurrent and ElectricalPotential
-
divide
Calculate the division of ElectricalCurrent and ElectricalConductance, which results in a ElectricalPotential scalar.- Parameters:
v- scalar- Returns:
- scalar as a division of ElectricalCurrent and ElectricalConductance
-