org.djunits.value.vdouble.scalar

Class DoubleScalarUtil

java.lang.Object

org.djunits.value.vdouble.scalar.DoubleScalarUtil

public final class DoubleScalarUtil
extends Object

Class to instantiate any DoubleScalar based on the provided unit.

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

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Aug 11, 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Method Summary

Modifier and Type	Method and Description
static <U extends Unit<U>,S extends AbstractDoubleScalar<U,S>> S	instantiate(double value, U unit) Instantiate the DoubleScalar based on its unit.
static <S extends AbstractDoubleScalar<?,S>> S	instantiateAnonymous(double value, Unit<?> unit) Instantiate the DoubleScalar based on its unit.
static <S extends AbstractDoubleScalar<?,S>> S	instantiateAnonymousSI(double si, Unit<?> displayUnit) Instantiate the DoubleScalar based on its unit.
static <U extends Unit<U>,S extends AbstractDoubleScalar<U,S>> S	instantiateSI(double si, U displayUnit) Instantiate the DoubleScalar based on its unit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

instantiate

public static <U extends Unit<U>,S extends AbstractDoubleScalar<U,S>> S instantiate(double value,
                                                                                    U unit)

Instantiate the DoubleScalar based on its unit. Rigid check on types for the compiler.

Type Parameters:

U - the unit

S - the return type

Parameters:

value - the value

unit - the unit in which the value is expressed

Returns:

an instantiated DoubleScalar with the value expressed in the unit

instantiateAnonymous

public static <S extends AbstractDoubleScalar<?,S>> S instantiateAnonymous(double value,
                                                                           Unit<?> unit)

Instantiate the DoubleScalar based on its unit. Loose check for types on the compiler. This allows the unit to be specified as a Unit<?> type.
Note that it is possible to make mistakes with anonymous units. The following does compile:

 MoneyPerLengthUnit mlu = new MoneyPerLengthUnit(MoneyUnit.USD, LengthUnit.METER, "$/m", "$/m");
 
 MoneyPerArea mpa = DoubleScalarUtil.instantiateAnonymous(10.0, mlu);
 

Type Parameters:

S - the return type

Parameters:

value - the value

unit - the unit in which the value is expressed

Returns:

an instantiated DoubleScalar with the value expressed in the unit

instantiateSI

public static <U extends Unit<U>,S extends AbstractDoubleScalar<U,S>> S instantiateSI(double si,
                                                                                      U displayUnit)

Instantiate the DoubleScalar based on its unit.

Type Parameters:

U - the unit

S - the return type

Parameters:

si - the value in SI units

displayUnit - the unit in which the value is expressed

Returns:

an instantiated DoubleScalar with the value expressed in the unit

instantiateAnonymousSI

public static <S extends AbstractDoubleScalar<?,S>> S instantiateAnonymousSI(double si,
                                                                             Unit<?> displayUnit)

Instantiate the DoubleScalar based on its unit. Loose check for types on the compiler. This allows the unit to be specified as a Unit<?> type.
Note that it is possible to make mistakes with anonymous units. The following does compile:

 MoneyPerLengthUnit mlu = new MoneyPerLengthUnit(MoneyUnit.USD, LengthUnit.METER, "$/m", "$/m");
 
 MoneyPerArea mpa = DoubleScalarUtil.instantiateAnonymousSI(10.0, mlu);
 

Type Parameters:

S - the return type

Parameters:

si - the value in SI units

displayUnit - the unit in which the value is expressed

Returns:

an instantiated DoubleScalar with the value expressed in the unit