Package org.djunits.quantity
Class AbsorbedDose.Unit
- All Implemented Interfaces:
UnitInterface<AbsorbedDose>
- Enclosing class:
- AbsorbedDose
AbsorbedDose.Unit encodes the units of absorbed dose (of ionizing radiation).
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
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final AbsorbedDose.Uniterg/g.static final AbsorbedDose.UnitGray.static final AbsorbedDose.UnitmGy.static final AbsorbedDose.UnitµGy.static final AbsorbedDose.Unitrad.static final AbsorbedDose.UnitThe SI or BASE unit.static final SIUnitThe dimensions of the absorbed dose: m2/s2. -
Constructor Summary
ConstructorsConstructorDescriptionUnit(String id, String name, double scaleFactorToBaseUnit, UnitSystem unitSystem) Create a new AbsorbedDose unit.Unit(String textualAbbreviation, String displayAbbreviation, String name, Scale scale, UnitSystem unitSystem, SIPrefix siPrefix) Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation. -
Method Summary
Modifier and TypeMethodDescriptionderiveUnit(String abbreviation, String name, double scaleFactor, UnitSystem unitSystem) Return a linearly scaled derived unit for this unit, with an abbreviation and scale factor.deriveUnit(String textualAbbreviation, String displayAbbreviation, String name, double scaleFactor, UnitSystem unitSystem, SIPrefix siPrefix) Return a linearly scaled derived unit for this unit, with textual abbreviation(s) and a display abbreviation.Return the base unit for this unit.ofSi(double si, UnitInterface<AbsorbedDose> displayUnit) Return a quantity for this unit with the SI-value and the provided display unit.siUnit()Return the SI unit for this unit.Methods inherited from class org.djunits.unit.AbstractUnit
equals, generateSiPrefixes, getDisplayAbbreviation, getId, getName, getScale, getSiPrefix, getStoredDisplayAbbreviation, getStoredName, getStoredTextualAbbreviation, getTextualAbbreviation, getUnitSystem, hashCode, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.djunits.unit.UnitInterface
fromBaseValue, ofSi, quantityInUnit, toBaseValue
-
Field Details
-
SI_UNIT
The dimensions of the absorbed dose: m2/s2. -
Gy
Gray. -
SI
The SI or BASE unit. -
mGy
mGy. -
muGy
µGy. -
erg_g
erg/g. -
rad
rad.
-
-
Constructor Details
-
Unit
Create a new AbsorbedDose unit.- Parameters:
id- the id or main abbreviation of the unitname- the full name of the unitscaleFactorToBaseUnit- the scale factor of the unit to convert it TO the base (SI) unitunitSystem- the unit system such as SI or IMPERIAL
-
Unit
public Unit(String textualAbbreviation, String displayAbbreviation, String name, Scale scale, UnitSystem unitSystem, SIPrefix siPrefix) Return a derived unit for this unit, with textual abbreviation(s) and a display abbreviation.- Parameters:
textualAbbreviation- the textual abbreviation of the unit, which doubles as the iddisplayAbbreviation- the display abbreviation of the unitname- the full name of the unitscale- the scale to use to convert from this unit to the standard (e.g., SI, BASE) unitunitSystem- unit system, e.g. SI or ImperialsiPrefix- the SI Prefix of this unit
-
-
Method Details
-
siUnit
Description copied from interface:UnitInterfaceReturn the SI unit for this unit.- Returns:
- the SI unit for this unit
-
getBaseUnit
Description copied from interface:UnitInterfaceReturn the base unit for this unit.- Returns:
- the base unit for this unit
-
ofSi
Description copied from interface:UnitInterfaceReturn a quantity for this unit with the SI-value and the provided display unit.- Parameters:
si- the value in SI or BASE unitsdisplayUnit- the display unit to use- Returns:
- a quantity for this unit with the SI-value and the provided display unit
-
deriveUnit
public AbsorbedDose.Unit deriveUnit(String abbreviation, String name, double scaleFactor, UnitSystem unitSystem) Description copied from class:AbstractUnitReturn a linearly scaled derived unit for this unit, with an abbreviation and scale factor.- Overrides:
deriveUnitin classAbstractUnit<AbsorbedDose>- Parameters:
abbreviation- the textual abbreviation of the unit, which doubles as the idname- the full name of the unitscaleFactor- the (linear) scale factor to multiply with the current (linear) scale factorunitSystem- unit system, e.g. SI or Imperial- Returns:
- a derived unit for this unit
-
deriveUnit
public AbsorbedDose.Unit deriveUnit(String textualAbbreviation, String displayAbbreviation, String name, double scaleFactor, UnitSystem unitSystem, SIPrefix siPrefix) Description copied from class:AbstractUnitReturn a linearly scaled derived unit for this unit, with textual abbreviation(s) and a display abbreviation.- Specified by:
deriveUnitin classAbstractUnit<AbsorbedDose>- Parameters:
textualAbbreviation- the textual abbreviation of the unit, which doubles as the iddisplayAbbreviation- the display abbreviation of the unitname- the full name of the unitscaleFactor- the (linear) scale factor to multiply with the current (linear) scale factorunitSystem- unit system, e.g. SI or ImperialsiPrefix- the SI prefix of this unit- Returns:
- a derived unit for this unit
-