AbsoluteTemperature.java
package org.djunits.value.vdouble.scalar;
import java.util.Locale;
import org.djunits.unit.AbsoluteTemperatureUnit;
import org.djunits.unit.TemperatureUnit;
import org.djunits.value.vdouble.scalar.base.DoubleScalarAbs;
import org.djutils.base.NumberParser;
import org.djutils.exceptions.Throw;
import jakarta.annotation.Generated;
/**
* Easy access methods for the Absolute AbsoluteTemperature DoubleScalar.
* <p>
* Copyright (c) 2013-2025 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. <br>
* All rights reserved. <br>
* BSD-style license. See <a href="https://djunits.org/docs/license.html">DJUNITS License</a>.
* </p>
* @author <a href="https://www.tudelft.nl/averbraeck">Alexander Verbraeck</a>
* @author <a href="https://www.tudelft.nl/staff/p.knoppers/">Peter Knoppers</a>
*/
@Generated(value = "org.djunits.generator.GenerateDJUNIT", date = "2025-09-06T15:16:28.380798Z")
public class AbsoluteTemperature
extends DoubleScalarAbs<AbsoluteTemperatureUnit, AbsoluteTemperature, TemperatureUnit, Temperature>
{
/** */
private static final long serialVersionUID = 20150901L;
/** Constant with value zero. */
public static final AbsoluteTemperature ZERO = new AbsoluteTemperature(0.0, AbsoluteTemperatureUnit.DEFAULT);
/**
* Construct AbsoluteTemperature scalar with a unit.
* @param value the double value, expressed in the given unit
* @param unit unit for the double value
*/
public AbsoluteTemperature(final double value, final AbsoluteTemperatureUnit unit)
{
super(value, unit);
}
/**
* Construct AbsoluteTemperature scalar.
* @param value Scalar from which to construct this instance
*/
public AbsoluteTemperature(final AbsoluteTemperature value)
{
super(value);
}
@Override
public final AbsoluteTemperature instantiateAbs(final double value, final AbsoluteTemperatureUnit unit)
{
return new AbsoluteTemperature(value, unit);
}
@Override
public final Temperature instantiateRel(final double value, final TemperatureUnit unit)
{
return new Temperature(value, unit);
}
/**
* Construct AbsoluteTemperature scalar based on a BASE unit value.
* @param value value in BASE units
* @return the new scalar with the BASE unit value
*/
public static final AbsoluteTemperature ofSI(final double value)
{
return new AbsoluteTemperature(value, AbsoluteTemperatureUnit.DEFAULT);
}
/**
* Interpolate between two values. Note that the first value does not have to be smaller than the second.
* @param zero the value at a ratio of zero
* @param one the value at a ratio of one
* @param ratio the ratio between 0 and 1, inclusive
* @return a AbsoluteTemperature at the given ratio between 0 and 1
*/
public static AbsoluteTemperature interpolate(final AbsoluteTemperature zero, final AbsoluteTemperature one,
final double ratio)
{
Throw.when(ratio < 0.0 || ratio > 1.0, IllegalArgumentException.class,
"ratio for interpolation should be between 0 and 1, but is %f", ratio);
return new AbsoluteTemperature(zero.getInUnit() * (1 - ratio) + one.getInUnit(zero.getDisplayUnit()) * ratio,
zero.getDisplayUnit());
}
/**
* Return the maximum value of two absolute scalars.
* @param a1 the first scalar
* @param a2 the second scalar
* @return the maximum value of two absolute scalars
*/
public static AbsoluteTemperature max(final AbsoluteTemperature a1, final AbsoluteTemperature a2)
{
return a1.gt(a2) ? a1 : a2;
}
/**
* Return the maximum value of more than two absolute scalars.
* @param a1 the first scalar
* @param a2 the second scalar
* @param an the other scalars
* @return the maximum value of more than two absolute scalars
*/
public static AbsoluteTemperature max(final AbsoluteTemperature a1, final AbsoluteTemperature a2,
final AbsoluteTemperature... an)
{
AbsoluteTemperature maxa = a1.gt(a2) ? a1 : a2;
for (AbsoluteTemperature a : an)
{
if (a.gt(maxa))
{
maxa = a;
}
}
return maxa;
}
/**
* Return the minimum value of two absolute scalars.
* @param a1 the first scalar
* @param a2 the second scalar
* @return the minimum value of two absolute scalars
*/
public static AbsoluteTemperature min(final AbsoluteTemperature a1, final AbsoluteTemperature a2)
{
return a1.lt(a2) ? a1 : a2;
}
/**
* Return the minimum value of more than two absolute scalars.
* @param a1 the first scalar
* @param a2 the second scalar
* @param an the other scalars
* @return the minimum value of more than two absolute scalars
*/
public static AbsoluteTemperature min(final AbsoluteTemperature a1, final AbsoluteTemperature a2,
final AbsoluteTemperature... an)
{
AbsoluteTemperature mina = a1.lt(a2) ? a1 : a2;
for (AbsoluteTemperature a : an)
{
if (a.lt(mina))
{
mina = a;
}
}
return mina;
}
/**
* Returns a AbsoluteTemperature 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.
* @param text the textual representation to parse into a AbsoluteTemperature
* @return the Scalar representation of the value in its unit
* @throws IllegalArgumentException when the text cannot be parsed
* @throws NullPointerException when the text argument is null
*/
public static AbsoluteTemperature valueOf(final String text)
{
Throw.whenNull(text, "Error parsing AbsoluteTemperature: text to parse is null");
Throw.when(text.length() == 0, IllegalArgumentException.class,
"Error parsing AbsoluteTemperature: empty text to parse");
try
{
NumberParser numberParser = new NumberParser().lenient().trailing();
double d = numberParser.parseDouble(text);
String unitString = text.substring(numberParser.getTrailingPosition()).trim();
AbsoluteTemperatureUnit unit = AbsoluteTemperatureUnit.BASE.getUnitByAbbreviation(unitString);
Throw.when(unit == null, IllegalArgumentException.class, "Unit %s not found for quantity AbsoluteTemperature",
unitString);
return new AbsoluteTemperature(d, unit);
}
catch (Exception exception)
{
throw new IllegalArgumentException("Error parsing AbsoluteTemperature from " + text + " using Locale "
+ Locale.getDefault(Locale.Category.FORMAT), exception);
}
}
/**
* Returns a AbsoluteTemperature based on a value and the textual representation of the unit, which can be localized.
* @param value the value to use
* @param unitString the textual representation of the unit
* @return the Scalar representation of the value in its unit
* @throws IllegalArgumentException when the unit cannot be parsed or is incorrect
* @throws NullPointerException when the unitString argument is null
*/
public static AbsoluteTemperature of(final double value, final String unitString)
{
Throw.whenNull(unitString, "Error parsing AbsoluteTemperature: unitString is null");
Throw.when(unitString.length() == 0, IllegalArgumentException.class,
"Error parsing AbsoluteTemperature: empty unitString");
AbsoluteTemperatureUnit unit = AbsoluteTemperatureUnit.BASE.getUnitByAbbreviation(unitString);
Throw.when(unit == null, IllegalArgumentException.class, "Error parsing AbsoluteTemperature with unit %s", unitString);
return new AbsoluteTemperature(value, unit);
}
}