org.djunits.value.vfloat.scalar

Class FloatDirection

java.lang.Object

java.lang.Number

org.djunits.value.Scalar<U>

org.djunits.value.vfloat.scalar.AbstractFloatScalar<AU,A>

org.djunits.value.vfloat.scalar.AbstractFloatScalarAbs<DirectionUnit,FloatDirection,AngleUnit,FloatAngle>

org.djunits.value.vfloat.scalar.FloatDirection

All Implemented Interfaces:

Serializable, Comparable<FloatDirection>, Absolute, MathFunctionsAbs<FloatDirection>, Value<DirectionUnit>, FloatMathFunctions<FloatDirection>, FloatScalarInterface

public class FloatDirection
extends AbstractFloatScalarAbs<DirectionUnit,FloatDirection,AngleUnit,FloatAngle>

Easy access methods for the Direction FloatScalar. Instead of:

 FloatScalar.Abs<DirectionUnit> value = new FloatScalar.Abs<DirectionUnit>(100.0, DirectionUnit.SI);
 

we can now write:

 FloatDirection value = new FloatDirection(100.0, DirectionUnit.SI);
 

The compiler will automatically recognize which units belong to which quantity, and whether the quantity type and the unit used are compatible.

Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands.
All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2017-01-30 14:23:11 +0100 (Mon, 30 Jan 2017) $, @version $Revision: 234 $, by $Author: averbraeck $, initial version Sep 1, 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static FloatDirection	ZERO constant with value zero.

Fields inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar

si

Fields inherited from interface org.djunits.value.vfloat.FloatMathFunctions

ABS, ACOS, ASIN, ATAN, CBRT, CEIL, COS, COSH, EXP, EXPM1, FLOOR, INV, LOG, LOG10, LOG1P, NEG, RINT, ROUND, SIGNUM, SIN, SINH, SQRT, TAN, TANH, TO_DEGREES, TO_RADIANS

Constructor Summary

Constructors

Constructor and Description
FloatDirection(double value, DirectionUnit unit) Construct FloatDirection scalar using a double value.
FloatDirection(FloatDirection value) Construct FloatDirection scalar.
FloatDirection(float value, DirectionUnit unit) Construct FloatDirection scalar.

Method Summary

Modifier and Type	Method and Description
static FloatDirection	createSI(float value) Construct FloatDirection scalar.
FloatDirection	instantiateAbs(float value, DirectionUnit unit) Construct a new Absolute Immutable FloatScalar of the right type.
FloatAngle	instantiateRel(float value, AngleUnit unit) Construct a new Relative Immutable FloatScalar of the right type.
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.

Methods inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalarAbs

ceil, divideBy, floor, minus, minus, multiplyBy, plus, rint, round

Methods inherited from class org.djunits.value.vfloat.scalar.AbstractFloatScalar

compareTo, doubleValue, eq, eq0, equals, floatValue, ge, ge0, getInUnit, getInUnit, getSI, gt, gt0, hashCode, intValue, le, le0, longValue, lt, lt0, ne, ne0, toString, toString, toString, toString

Methods inherited from class org.djunits.value.Scalar

expressAsSIUnit, expressAsSpecifiedUnit, getUnit, isAbsolute, isRelative, 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.vfloat.FloatMathFunctions

DIV, MULT, POW

Field Detail

ZERO

public static final FloatDirection ZERO

constant with value zero.

Constructor Detail

FloatDirection

public FloatDirection(float value,
                      DirectionUnit unit)

Construct FloatDirection scalar.

Parameters:

value - float value

unit - unit for the float value

FloatDirection

public FloatDirection(double value,
                      DirectionUnit unit)

Construct FloatDirection scalar using a double value.

Parameters:

value - double value

unit - unit for the resulting float value

FloatDirection

public FloatDirection(FloatDirection value)

Construct FloatDirection scalar.

Parameters:

value - Scalar from which to construct this instance

Method Detail

instantiateAbs

public final FloatDirection instantiateAbs(float value,
                                           DirectionUnit unit)

Construct a new Absolute Immutable FloatScalar of the right type. Each extending class must implement this method.

Specified by:

instantiateAbs in class AbstractFloatScalarAbs<DirectionUnit,FloatDirection,AngleUnit,FloatAngle>

Parameters:

value - the float value

unit - the unit

Returns:

A a new absolute instance of the FloatScalar of the right type

instantiateRel

public final FloatAngle instantiateRel(float value,
                                       AngleUnit unit)

Construct a new Relative Immutable FloatScalar of the right type. Each extending class must implement this method.

Specified by:

instantiateRel in class AbstractFloatScalarAbs<DirectionUnit,FloatDirection,AngleUnit,FloatAngle>

Parameters:

value - the float value

unit - the unit

Returns:

R a new relative instance of the FloatScalar of the right type

createSI

public static final FloatDirection createSI(float value)

Construct FloatDirection scalar.

Parameters:

value - float value in BASE units

Returns:

the new scalar with the BASE value

interpolate

public static FloatDirection interpolate(FloatDirection zero,
                                         FloatDirection one,
                                         float ratio)

Interpolate between two values.

Parameters:

zero - the low value

one - the high value

ratio - the ratio between 0 and 1, inclusive

Returns:

a Scalar at the ratio between

max

public static FloatDirection max(FloatDirection a1,
                                 FloatDirection a2)

Return the maximum value of two absolute scalars.

Parameters:

a1 - the first scalar

a2 - the second scalar

Returns:

the maximum value of two absolute scalars

max

public static FloatDirection max(FloatDirection a1,
                                 FloatDirection a2,
                                 FloatDirection... an)

Return the maximum value of more than two absolute scalars.

Parameters:

a1 - the first scalar

a2 - the second scalar

an - the other scalars

Returns:

the maximum value of more than two absolute scalars

min

public static FloatDirection min(FloatDirection a1,
                                 FloatDirection a2)

Return the minimum value of two absolute scalars.

Parameters:

a1 - the first scalar

a2 - the second scalar

Returns:

the minimum value of two absolute scalars

min

public static FloatDirection min(FloatDirection a1,
                                 FloatDirection a2,
                                 FloatDirection... an)

Return the minimum value of more than two absolute scalars.

Parameters:

a1 - the first scalar

a2 - the second scalar

an - the other scalars

Returns:

the minimum value of more than two absolute scalars