Package org.djunits.value.vdouble.scalar
Class Direction
java.lang.Object
java.lang.Number
org.djunits.value.base.Scalar<U,S>
org.djunits.value.vdouble.scalar.base.DoubleScalar<AU,A>
org.djunits.value.vdouble.scalar.base.DoubleScalarAbs<DirectionUnit,Direction,AngleUnit,Angle>
org.djunits.value.vdouble.scalar.Direction
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<Direction>
,Absolute<DirectionUnit,
,Direction, AngleUnit, Angle> Value<DirectionUnit,
Direction>
@Generated(value="org.djunits.generator.GenerateDJUNIT",
date="2023-07-23T14:06:38.224104100Z")
public class Direction
extends DoubleScalarAbs<DirectionUnit,Direction,AngleUnit,Angle>
Easy access methods for the Absolute Direction DoubleScalar.
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.vdouble.scalar.base.DoubleScalar
si
-
Constructor Summary
ConstructorDescriptionDirection
(double value, DirectionUnit unit) Construct Direction scalar.Construct Direction scalar. -
Method Summary
Modifier and TypeMethodDescriptionfinal Direction
instantiateAbs
(double value, DirectionUnit unit) Construct a new Absolute Immutable DoubleScalar of the right type.final Angle
instantiateRel
(double value, AngleUnit unit) Construct a new Relative Immutable DoubleScalar of the right type.static final Direction
instantiateSI
(double value) Construct Direction scalar.static Direction
interpolate
(Direction zero, Direction one, double ratio) Interpolate between two values.static Direction
Return the maximum value of two absolute scalars.static Direction
Return the maximum value of more than two absolute scalars.static Direction
Return the minimum value of two absolute scalars.static Direction
Return the minimum value of more than two absolute scalars.static Direction
Returns a Direction based on a value and the textual representation of the unit, which can be localized.static Direction
Returns a Direction representation of a textual representation of a value with a unit.Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalarAbs
abs, ceil, floor, minus, minus, neg, plus, rint
Methods inherited from class org.djunits.value.vdouble.scalar.base.DoubleScalar
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
-
Direction
Construct Direction scalar.- Parameters:
value
- double; valueunit
- DirectionUnit; unit for the double value
-
Direction
Construct Direction scalar.- Parameters:
value
- Direction; Scalar from which to construct this instance
-
-
Method Details
-
instantiateAbs
Description copied from class:DoubleScalarAbs
Construct a new Absolute Immutable DoubleScalar of the right type. Each extending class must implement this method.- Specified by:
instantiateAbs
in classDoubleScalarAbs<DirectionUnit,
Direction, AngleUnit, Angle> - Parameters:
value
- double; the double valueunit
- AU; the absolute unit- Returns:
- A a new absolute instance of the DoubleScalar of the right type
-
instantiateRel
Description copied from class:DoubleScalarAbs
Construct a new Relative Immutable DoubleScalar of the right type. Each extending class must implement this method.- Specified by:
instantiateRel
in classDoubleScalarAbs<DirectionUnit,
Direction, AngleUnit, Angle> - Parameters:
value
- double; the double valueunit
- RU; the unit- Returns:
- R a new relative instance of the DoubleScalar of the right type
-
instantiateSI
Construct Direction scalar.- Parameters:
value
- double; value in SI units- Returns:
- Direction; the new scalar with the SI value
-
interpolate
Interpolate between two values.- Parameters:
zero
- Direction; the low valueone
- Direction; the high valueratio
- double; the ratio between 0 and 1, inclusive- Returns:
- Direction; a Scalar at the ratio between
-
max
Return the maximum value of two absolute scalars.- Parameters:
a1
- Direction; the first scalara2
- Direction; the second scalar- Returns:
- Direction; the maximum value of two absolute scalars
-
max
Return the maximum value of more than two absolute scalars.- Parameters:
a1
- Direction; the first scalara2
- Direction; the second scalaran
- Direction...; the other scalars- Returns:
- the maximum value of more than two absolute scalars
-
min
Return the minimum value of two absolute scalars.- Parameters:
a1
- Direction; the first scalara2
- Direction; the second scalar- Returns:
- the minimum value of two absolute scalars
-
min
Return the minimum value of more than two absolute scalars.- Parameters:
a1
- Direction; the first scalara2
- Direction; the second scalaran
- Direction...; the other scalars- Returns:
- the minimum value of more than two absolute scalars
-
valueOf
Returns a Direction 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 Direction- Returns:
- Direction; 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 Direction 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:
- Direction; 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
-