Package org.djunits.quantity

Class EquivalentDose

java.lang.Object

java.lang.Number

org.djunits.quantity.def.Quantity<EquivalentDose,EquivalentDose.Unit>

org.djunits.quantity.EquivalentDose

All Implemented Interfaces:

Serializable, Comparable<EquivalentDose>, Additive<EquivalentDose>, Scalable<EquivalentDose>, Value<EquivalentDose.Unit,EquivalentDose>

public class EquivalentDose
extends Quantity<EquivalentDose,EquivalentDose.Unit>

Equivalent dose is a measure of radiation exposure accounting for biological effect, expressed in sieverts (Sv).

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EquivalentDose.Unit	EquivalentDose.Unit encodes the unit of radiation exposure.

Field Summary

Fields

Modifier and Type	Field	Description
static final EquivalentDose	NaN	Constant with value NaN.
static final EquivalentDose	NEG_MAXVALUE	Constant with value -MAX_VALUE.
static final EquivalentDose	NEGATIVE_INFINITY	Constant with value NEGATIVE_INFINITY.
static final EquivalentDose	ONE	Constant with value one.
static final EquivalentDose	POS_MAXVALUE	Constant with value MAX_VALUE.
static final EquivalentDose	POSITIVE_INFINITY	Constant with value POSITIVE_INFINITY.
static final EquivalentDose	ZERO	Constant with value zero.

Constructor Summary

Constructors

Constructor	Description
EquivalentDose(double value, String abbreviation)	Instantiate a EquivalentDose quantity with a unit, expressed as a String.
EquivalentDose(double value, EquivalentDose.Unit unit)	Instantiate a EquivalentDose quantity with a unit.
EquivalentDose(EquivalentDose value)	Construct EquivalentDose quantity.

Method Summary

Modifier and Type	Method	Description
final Dimensionless	divide(EquivalentDose v)	Calculate the division of EquivalentDose and EquivalentDose, which results in a Dimensionless quantity.
EquivalentDose	instantiate(double si)	Instantiate a quantity with an SI or base value.
static EquivalentDose	of(double value, String unitString)	Returns a EquivalentDose based on a value and the textual representation of the unit, which can be localized.
static EquivalentDose	ofSi(double si)	Return a EquivalentDose instance based on an SI value.
SIUnit	siUnit()	Return the SI unit of this quantity.
static EquivalentDose	valueOf(String text)	Returns a EquivalentDose 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, 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, setDisplayUnit

Field Details

ZERO

public static final EquivalentDose ZERO

Constant with value zero.

ONE

public static final EquivalentDose ONE

Constant with value one.

NaN

public static final EquivalentDose NaN

Constant with value NaN.

POSITIVE_INFINITY

public static final EquivalentDose POSITIVE_INFINITY

Constant with value POSITIVE_INFINITY.

NEGATIVE_INFINITY

public static final EquivalentDose NEGATIVE_INFINITY

Constant with value NEGATIVE_INFINITY.

POS_MAXVALUE

public static final EquivalentDose POS_MAXVALUE

Constant with value MAX_VALUE.

NEG_MAXVALUE

public static final EquivalentDose NEG_MAXVALUE

Constant with value -MAX_VALUE.

Constructor Details

EquivalentDose

public EquivalentDose(double value,
 EquivalentDose.Unit unit)

Instantiate a EquivalentDose quantity with a unit.

Parameters:

value - the value, expressed in the unit

unit - the unit in which the value is expressed

EquivalentDose

public EquivalentDose(double value,
 String abbreviation)

Instantiate a EquivalentDose quantity with a unit, expressed as a String.

Parameters:

value - the value, expressed in the unit

abbreviation - the String abbreviation of the unit in which the value is expressed

EquivalentDose

public EquivalentDose(EquivalentDose value)

Construct EquivalentDose quantity.

Parameters:

value - Scalar from which to construct this instance

Method Details

ofSi

public static EquivalentDose ofSi(double si)

Return a EquivalentDose instance based on an SI value.

Parameters:

si - the si value

Returns:

the EquivalentDose instance based on an SI value

instantiate

public EquivalentDose instantiate(double si)

Description copied from class: Quantity

Instantiate a quantity with an SI or base value.

Specified by:

instantiate in class Quantity<EquivalentDose,EquivalentDose.Unit>

Parameters:

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

Returns:

a quantity with the given SI-value and base (SI) unit

siUnit

public SIUnit siUnit()

Description copied from class: Quantity

Return the SI unit of this quantity.

Overrides:

siUnit in class Quantity<EquivalentDose,EquivalentDose.Unit>

Returns:

the SI unit of this quantity

valueOf

public static EquivalentDose valueOf(String text)

Returns a EquivalentDose 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 EquivalentDose

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 EquivalentDose of(double value,
 String unitString)

Returns a EquivalentDose based on a value and the textual representation of the unit, which can be localized.

Parameters:

value - the value to use

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

divide

public final Dimensionless divide(EquivalentDose v)

Calculate the division of EquivalentDose and EquivalentDose, which results in a Dimensionless quantity.

Parameters:

v - quantity

Returns:

quantity as a division of EquivalentDose and EquivalentDose