Package org.djunits.quantity

Class SIQuantity

java.lang.Object

java.lang.Number

org.djunits.quantity.def.Quantity<SIQuantity>

org.djunits.quantity.SIQuantity

All Implemented Interfaces:

Serializable, Comparable<SIQuantity>, Additive<SIQuantity>, Scalable<SIQuantity>, Value<SIQuantity>

public class SIQuantity
extends Quantity<SIQuantity>

SI quantity, with arbitrary SI unit. The class has as... methods such as asDuration(...), which will succeed if the SI unit of the quantity is a duration unit, i.e., 's'.

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:

• Serialized Form

Field Summary

Fields inherited from class org.djunits.quantity.def.Quantity

si

Constructor Summary

Constructors

Constructor	Description
SIQuantity(double valueInUnit, SIUnit unit)	Instantiate a SIQuantity quantity expressed in the given unit.
SIQuantity(double value, SIUnit displayUnit, boolean useSi)	Instantiate a SIQuantity quantity with an SI or base value and a display unit.

Method Summary

Modifier and Type	Method	Description
SIUnit	getDisplayUnit()	Retrieve the unit of this Value.
SIQuantity	instantiateSi(double siValue, UnitInterface<SIQuantity> displayUnit)	Instantiate a quantity with an SI or base value, and a display unit.
static SIQuantity	of(double valueInUnit, String unitString)	Returns an SI quantity based on a value and the textual representation of the unit, which can be localized.
static SIQuantity	of(double valueInUnit, SIUnit unit)	Returns a SIQuantity based on a value expressed in the unit.
static SIQuantity	ofSi(double si)	Return a SIQuantity instance based on an SI value.
static SIQuantity	ofSi(double siValue, SIUnit displayUnit)	Instantiate a SIQuantity quantity with an SI or base value and a display unit.
static SIQuantity	valueOf(String text)	Returns an SI quantity 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, valueOf

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.djunits.value.Scalable

divideBy

Methods inherited from interface org.djunits.value.Value

isAbsolute

Constructor Details

SIQuantity

public SIQuantity(double value,
 SIUnit displayUnit,
 boolean useSi)

Instantiate a SIQuantity quantity with an SI or base value and a display unit.

Parameters:

value - the quantity value expressed in the SI or base unit

displayUnit - the display unit to use

useSi - use SI value when true, use value in unit when false

SIQuantity

public SIQuantity(double valueInUnit,
 SIUnit unit)

Instantiate a SIQuantity quantity expressed in the given unit.

Parameters:

valueInUnit - the quantity value expressed in the given unit

unit - the unit of the value, also acts as the display unit

Method Details

ofSi

public static SIQuantity ofSi(double si)

Return a SIQuantity instance based on an SI value.

Parameters:

si - the si value

Returns:

the SIQuantity instance based on an SI value

ofSi

public static SIQuantity ofSi(double siValue,
 SIUnit displayUnit)

Instantiate a SIQuantity quantity with an SI or base value and a display unit.

Parameters:

siValue - the quantity value expressed in the SI or base unit

displayUnit - the display unit to use

Returns:

the SIQuantity instance based on an SI value with the given display unit

instantiateSi

public SIQuantity instantiateSi(double siValue,
 UnitInterface<SIQuantity> displayUnit)

Description copied from class: Quantity

Instantiate a quantity with an SI or base value, and a display unit.

Specified by:

instantiateSi in class Quantity<SIQuantity>

Parameters:

siValue - the value expressed in the base (SI) unit

displayUnit - the display unit to use for the quantity

Returns:

a quantity with the given SI or base value, and the given display unit

of

public static SIQuantity of(double valueInUnit,
 SIUnit unit)

Returns a SIQuantity based on a value expressed in the unit.

Parameters:

valueInUnit - the value, expressed in the given unit

unit - the unit of the value, also acts as the display unit

Returns:

ab SIQuantity representation of the value in its unit

getDisplayUnit

public SIUnit getDisplayUnit()

Description copied from interface: Value

Retrieve the unit of this Value.

Specified by:

getDisplayUnit in interface Value<SIQuantity>

Overrides:

getDisplayUnit in class Quantity<SIQuantity>

Returns:

the unit of this Value

valueOf

public static SIQuantity valueOf(String text)

Returns an SI quantity 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 SI

Returns:

the Scalar representation of the value in its unit

Throws:

IllegalArgumentException - when the text cannot be parsed

NullPointerException - when the text argument is null

of

public static SIQuantity of(double valueInUnit,
 String unitString)

Returns an SI quantity 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 unitString

unitString - 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 incorrect

NullPointerException - when the unitString argument is null