Package org.djunits.quantity
Class ElectricalCapacitance
- All Implemented Interfaces:
Serializable,Comparable<ElectricalCapacitance>,Additive<ElectricalCapacitance>,Scalable<ElectricalCapacitance>,Value<ElectricalCapacitance>
ElectricalCapacitance denotes the ability of an object to store electric charge, and is expressed in farad.
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 classElectricalCapacitance.Unit encodes the units of capacitance (in farad). -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ElectricalCapacitanceConstant with value NaN.static final ElectricalCapacitanceConstant with value -MAX_VALUE.static final ElectricalCapacitanceConstant with value NEGATIVE_INFINITY.static final ElectricalCapacitanceConstant with value one.static final ElectricalCapacitanceConstant with value MAX_VALUE.static final ElectricalCapacitanceConstant with value POSITIVE_INFINITY.static final ElectricalCapacitanceConstant with value zero. -
Constructor Summary
ConstructorsConstructorDescriptionElectricalCapacitance(double valueInUnit, ElectricalCapacitance.Unit unit) Instantiate a ElectricalCapacitance quantity expressed in the given unit.ElectricalCapacitance(double value, ElectricalCapacitance.Unit displayUnit, boolean useSi) Instantiate a ElectricalCapacitance quantity with an SI or base value and a display unit. -
Method Summary
Modifier and TypeMethodDescriptionCalculate the division of ElectricalCapacitance and Duration, which results in a ElectricalConductance scalar.Calculate the division of ElectricalCapacitance and ElectricalCapacitance, which results in a Dimensionless quantity.Calculate the division of ElectricalCapacitance and ElectricalConductance, which results in a Duration scalar.Retrieve the unit of this Value.instantiateSi(double siValue, UnitInterface<ElectricalCapacitance> displayUnit) Instantiate a quantity with an SI or base value, and a display unit.Calculate the multiplication of ElectricalCapacitance and ElectricPotential, which results in a ElectricCharge scalar.static ElectricalCapacitanceReturns a ElectricalCapacitance based on a value and the textual representation of the unit, which can be localized.static ElectricalCapacitanceof(double valueInUnit, ElectricalCapacitance.Unit unit) Returns a ElectricalCapacitance based on a value expressed in the unit.static ElectricalCapacitanceofSi(double si) Return a ElectricalCapacitance instance based on an SI value.static ElectricalCapacitanceofSi(double siValue, ElectricalCapacitance.Unit displayUnit) Instantiate a ElectricalCapacitance quantity with an SI or base value and a display unit.static ElectricalCapacitanceReturns a ElectricalCapacitance 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, format, ge, ge0, getInUnit, getInUnit, getName, gt, gt0, hashCode, instantiate, instantiateSi, interpolate, intValue, isRelative, le, le0, longValue, lt, lt0, max, mean, min, multiply, ne, ne0, negate, of, product, reciprocal, scaleBy, si, siUnit, subtract, sum, toString, 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
-
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
-
ElectricalCapacitance
Instantiate a ElectricalCapacitance quantity with an SI or base value and a display unit.- Parameters:
value- the quantity value expressed in the SI or base unitdisplayUnit- the display unit to useuseSi- use SI value when true, use value in unit when false
-
ElectricalCapacitance
Instantiate a ElectricalCapacitance quantity expressed in the given unit.- Parameters:
valueInUnit- the quantity value expressed in the given unitunit- the unit of the value, also acts as the display unit
-
-
Method Details
-
ofSi
Return a ElectricalCapacitance instance based on an SI value.- Parameters:
si- the si value- Returns:
- the ElectricalCapacitance instance based on an SI value
-
ofSi
Instantiate a ElectricalCapacitance quantity with an SI or base value and a display unit.- Parameters:
siValue- the quantity value expressed in the SI or base unitdisplayUnit- the display unit to use- Returns:
- the ElectricalCapacitance instance based on an SI value with the given display unit
-
instantiateSi
public ElectricalCapacitance instantiateSi(double siValue, UnitInterface<ElectricalCapacitance> displayUnit) Description copied from class:QuantityInstantiate a quantity with an SI or base value, and a display unit.- Specified by:
instantiateSiin classQuantity<ElectricalCapacitance>- Parameters:
siValue- the value expressed in the base (SI) unitdisplayUnit- the display unit to use for the quantity- Returns:
- a quantity with the given SI or base value, and the given display unit
-
valueOf
Returns a ElectricalCapacitance 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 ElectricalCapacitance- 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 ElectricalCapacitance based on a value expressed in the unit.- Parameters:
valueInUnit- the value, expressed in the given unitunit- the unit of the value, also acts as the display unit- Returns:
- ab ElectricalCapacitance representation of the value in its unit
-
of
Returns a ElectricalCapacitance based on a value and the textual representation of the unit, which can be localized.- Parameters:
valueInUnit- the value, expressed in the unit as given by unitStringunitString- 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
-
getDisplayUnit
Description copied from interface:ValueRetrieve the unit of this Value.- Specified by:
getDisplayUnitin interfaceValue<ElectricalCapacitance>- Overrides:
getDisplayUnitin classQuantity<ElectricalCapacitance>- Returns:
- the unit of this Value
-
divide
Calculate the division of ElectricalCapacitance and ElectricalCapacitance, which results in a Dimensionless quantity.- Parameters:
v- quantity- Returns:
- quantity as a division of ElectricalCapacitance and ElectricalCapacitance
-
multiply
Calculate the multiplication of ElectricalCapacitance and ElectricPotential, which results in a ElectricCharge scalar.- Parameters:
v- scalar- Returns:
- scalar as a multiplication of ElectricalCapacitance and ElectricPotential
-
divide
Calculate the division of ElectricalCapacitance and Duration, which results in a ElectricalConductance scalar.- Parameters:
v- scalar- Returns:
- scalar as a division of ElectricalCapacitance and Duration
-
divide
Calculate the division of ElectricalCapacitance and ElectricalConductance, which results in a Duration scalar.- Parameters:
v- scalar- Returns:
- scalar as a division of ElectricalCapacitance and ElectricalConductance
-