Package org.djunits.quantity

Class EquivalentDose

java.lang.Object
java.lang.Number
org.djunits.quantity.def.Quantity<EquivalentDose>
org.djunits.quantity.EquivalentDose
All Implemented Interfaces:
Serializable, Comparable<EquivalentDose>, Additive<EquivalentDose>, Scalable<EquivalentDose>, Value<EquivalentDose>
public class EquivalentDose extends Quantity<EquivalentDose>
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:

  • 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 displayUnit, boolean useSi)
      Instantiate a EquivalentDose 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

    • EquivalentDose

      public EquivalentDose(double valueInUnit, EquivalentDose.Unit unit)
      Instantiate a EquivalentDose 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 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

    • ofSi

      public static EquivalentDose ofSi(double siValue, EquivalentDose.Unit displayUnit)
      Instantiate a EquivalentDose 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 EquivalentDose instance based on an SI value with the given display unit

    • instantiateSi

      public EquivalentDose instantiateSi(double siValue, UnitInterface<EquivalentDose> 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<EquivalentDose>
      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

    • 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 valueInUnit, EquivalentDose.Unit unit)
      Returns a EquivalentDose 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 EquivalentDose representation of the value in its unit

    • of

      public static EquivalentDose of(double valueInUnit, String unitString)
      Returns a EquivalentDose 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

    • getDisplayUnit

      public EquivalentDose.Unit getDisplayUnit()
      Description copied from interface: Value
      Retrieve the unit of this Value.
      Specified by:
      getDisplayUnit in interface Value<EquivalentDose>
      Overrides:
      getDisplayUnit in class Quantity<EquivalentDose>
      Returns:
      the unit of this Value

    • divide

      public 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