Package org.djunits.value.vfloat.scalar
Class FloatDirection
java.lang.Object
java.lang.Number
org.djunits.value.base.Scalar<U,S>
org.djunits.value.vfloat.scalar.base.FloatScalar<AU,A>
org.djunits.value.vfloat.scalar.base.FloatScalarAbs<DirectionUnit,FloatDirection,AngleUnit,FloatAngle>
org.djunits.value.vfloat.scalar.FloatDirection
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<FloatDirection>
,Absolute<DirectionUnit,
,FloatDirection, AngleUnit, FloatAngle> Value<DirectionUnit,
FloatDirection>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
date="2023-07-23T14:06:38.224104100Z")
public class FloatDirection
extends FloatScalarAbs<DirectionUnit,FloatDirection,AngleUnit,FloatAngle>
Easy access methods for the FloatDirection FloatScalar.
Copyright (c) 2013-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands.
All rights reserved.
BSD-style license. See DJUNITS License.
- Author:
- Alexander Verbraeck, Peter Knoppers
- See Also:
-
Field Summary
Fields inherited from class org.djunits.value.vfloat.scalar.base.FloatScalar
si
-
Constructor Summary
ConstructorDescriptionFloatDirection
(double value, DirectionUnit unit) Construct FloatDirection scalar using a double value.FloatDirection
(float value, DirectionUnit unit) Construct FloatDirection scalar.FloatDirection
(FloatDirection value) Construct FloatDirection scalar. -
Method Summary
Modifier and TypeMethodDescriptionfinal FloatDirection
instantiateAbs
(float value, DirectionUnit unit) Construct a new Absolute Immutable FloatScalar of the right type.final FloatAngle
instantiateRel
(float value, AngleUnit unit) Construct a new Relative Immutable FloatScalar of the right type.static final FloatDirection
instantiateSI
(float value) Construct FloatDirection scalar.static FloatDirection
interpolate
(FloatDirection zero, FloatDirection one, float ratio) Interpolate between two values.static FloatDirection
max
(FloatDirection a1, FloatDirection a2) Return the maximum value of two absolute scalars.static FloatDirection
max
(FloatDirection a1, FloatDirection a2, FloatDirection... an) Return the maximum value of more than two absolute scalars.static FloatDirection
min
(FloatDirection a1, FloatDirection a2) Return the minimum value of two absolute scalars.static FloatDirection
min
(FloatDirection a1, FloatDirection a2, FloatDirection... an) Return the minimum value of more than two absolute scalars.static FloatDirection
Returns a FloatDirection based on a value and the textual representation of the unit, which can be localized.static FloatDirection
Returns a FloatDirection representation of a textual representation of a value with a unit.Methods inherited from class org.djunits.value.vfloat.scalar.base.FloatScalarAbs
abs, ceil, floor, minus, minus, neg, plus, rint
Methods inherited from class org.djunits.value.vfloat.scalar.base.FloatScalar
compareTo, divide, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, instantiate, instantiateAnonymous, instantiateSI, interpolate, interpolate, intValue, le, le0, longValue, lt, lt0, max, max, min, min, minus, minus, minus, multiply, ne, ne0, plus, plus, plus, toDisplayString, toDisplayString, toString, toString, toString, toString, toStringSIPrefixed, toStringSIPrefixed, toTextualString, toTextualString
Methods inherited from class org.djunits.value.base.Scalar
format, format, getDisplayUnit, setDisplayUnit
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.Value
isAbsolute, isRelative
-
Field Details
-
ZERO
Constant with value zero.
-
-
Constructor Details
-
FloatDirection
Construct FloatDirection scalar.- Parameters:
value
- float; the float valueunit
- DirectionUnit; unit for the float value
-
FloatDirection
Construct FloatDirection scalar using a double value.- Parameters:
value
- double; the double valueunit
- DirectionUnit; unit for the resulting float value
-
FloatDirection
Construct FloatDirection scalar.- Parameters:
value
- FloatDirection; Scalar from which to construct this instance
-
-
Method Details
-
instantiateAbs
Description copied from class:FloatScalarAbs
Construct a new Absolute Immutable FloatScalar of the right type. Each extending class must implement this method.- Specified by:
instantiateAbs
in classFloatScalarAbs<DirectionUnit,
FloatDirection, AngleUnit, FloatAngle> - Parameters:
value
- float; the float valueunit
- AU; the absolute unit- Returns:
- A a new absolute instance of the FloatScalar of the right type
-
instantiateRel
Description copied from class:FloatScalarAbs
Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.- Specified by:
instantiateRel
in classFloatScalarAbs<DirectionUnit,
FloatDirection, AngleUnit, FloatAngle> - Parameters:
value
- float; the float valueunit
- RU; the unit- Returns:
- R a new relative instance of the FloatScalar of the right type
-
instantiateSI
Construct FloatDirection scalar.- Parameters:
value
- float; the float value in BASE units- Returns:
- FloatDirection; the new scalar with the BASE value
-
interpolate
Interpolate between two values.- Parameters:
zero
- FloatDirection; the low valueone
- FloatDirection; the high valueratio
- float; the ratio between 0 and 1, inclusive- Returns:
- FloatDirection; a Scalar at the ratio between
-
max
Return the maximum value of two absolute scalars.- Parameters:
a1
- FloatDirection; the first scalara2
- FloatDirection; the second scalar- Returns:
- FloatDirection; the maximum value of two absolute scalars
-
max
Return the maximum value of more than two absolute scalars.- Parameters:
a1
- FloatDirection; the first scalara2
- FloatDirection; the second scalaran
- FloatDirection...; the other scalars- Returns:
- FloatDirection; the maximum value of more than two absolute scalars
-
min
Return the minimum value of two absolute scalars.- Parameters:
a1
- FloatDirection; the first scalara2
- FloatDirection; the second scalar- Returns:
- FloatDirection; the minimum value of two absolute scalars
-
min
Return the minimum value of more than two absolute scalars.- Parameters:
a1
- FloatDirection; the first scalara2
- FloatDirection; the second scalaran
- FloatDirection...; the other scalars- Returns:
- FloatDirection; the minimum value of more than two absolute scalars
-
valueOf
Returns a FloatDirection 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
- String; the textual representation to parse into a FloatDirection- Returns:
- FloatDirection; the Scalar representation of the value in its unit
- Throws:
IllegalArgumentException
- when the text cannot be parsedNullPointerException
- when the text argument is null
-
of
Returns a FloatDirection based on a value and the textual representation of the unit, which can be localized.- Parameters:
value
- double; the value to useunitString
- String; the textual representation of the unit- Returns:
- FloatDirection; the Scalar representation of the value in its unit
- Throws:
IllegalArgumentException
- when the unit cannot be parsed or is incorrectNullPointerException
- when the unitString argument is null
-