DoubleScalarUtil.java

package org.djunits.value.vdouble.scalar;

import org.djunits.unit.AbsoluteTemperatureUnit;
import org.djunits.unit.AccelerationUnit;
import org.djunits.unit.AngleSolidUnit;
import org.djunits.unit.AngleUnit;
import org.djunits.unit.AreaUnit;
import org.djunits.unit.DensityUnit;
import org.djunits.unit.DimensionlessUnit;
import org.djunits.unit.DirectionUnit;
import org.djunits.unit.DurationUnit;
import org.djunits.unit.ElectricalChargeUnit;
import org.djunits.unit.ElectricalCurrentUnit;
import org.djunits.unit.ElectricalPotentialUnit;
import org.djunits.unit.ElectricalResistanceUnit;
import org.djunits.unit.EnergyUnit;
import org.djunits.unit.FlowMassUnit;
import org.djunits.unit.FlowVolumeUnit;
import org.djunits.unit.ForceUnit;
import org.djunits.unit.FrequencyUnit;
import org.djunits.unit.LengthUnit;
import org.djunits.unit.LinearDensityUnit;
import org.djunits.unit.MassUnit;
import org.djunits.unit.MoneyPerAreaUnit;
import org.djunits.unit.MoneyPerDurationUnit;
import org.djunits.unit.MoneyPerEnergyUnit;
import org.djunits.unit.MoneyPerLengthUnit;
import org.djunits.unit.MoneyPerMassUnit;
import org.djunits.unit.MoneyPerVolumeUnit;
import org.djunits.unit.MoneyUnit;
import org.djunits.unit.PositionUnit;
import org.djunits.unit.PowerUnit;
import org.djunits.unit.PressureUnit;
import org.djunits.unit.SpeedUnit;
import org.djunits.unit.TemperatureUnit;
import org.djunits.unit.TimeUnit;
import org.djunits.unit.TorqueUnit;
import org.djunits.unit.Unit;
import org.djunits.unit.UnitException;
import org.djunits.unit.VolumeUnit;

/**
 * Class to instantiate any DoubleScalar based on the provided unit.
 * <p>
 * Copyright (c) 2013-2017 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
 * BSD-style license. See <a href="http://opentrafficsim.org/docs/current/license.html">OpenTrafficSim License</a>.
 * </p>
 * $LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $,
 * initial version Aug 11, 2018 <br>
 * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
 * @author <a href="http://www.tudelft.nl/pknoppers">Peter Knoppers</a>
 * @author <a href="http://www.transport.citg.tudelft.nl">Wouter Schakel</a>
 */
public final class DoubleScalarUtil
{
    /** */
    private DoubleScalarUtil()
    {
        // Utility class.
    }

    /**
     * Instantiate the DoubleScalar based on its unit. Rigid check on types for the compiler.
     * @param value double; the value
     * @param unit U; the unit in which the value is expressed
     * @return an instantiated DoubleScalar with the value expressed in the unit
     * @param <U> the unit
     * @param <S> the return type
     */
    public static <U extends Unit<U>, S extends AbstractDoubleScalar<U, S>> S instantiate(final double value, final U unit)
    {
        return instantiateAnonymous(value, 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&lt;?&gt; type.<br>
     * <b>Note</b> that it is possible to make mistakes with anonymous units. The following <u>does</u> compile:
     * 
     * <pre>
     * MoneyPerLengthUnit mlu = new MoneyPerLengthUnit(MoneyUnit.USD, LengthUnit.METER, "$/m", "$/m");
     * 
     * MoneyPerArea mpa = DoubleScalarUtil.instantiateAnonymous(10.0, mlu);
     * </pre>
     * 
     * @param value double; the value
     * @param unit Unit&lt;?&gt;; the unit in which the value is expressed
     * @return an instantiated DoubleScalar with the value expressed in the unit
     * @param <S> the return type
     */
    @SuppressWarnings({ "unchecked", "checkstyle:needbraces" })
    public static <S extends AbstractDoubleScalar<?, S>> S instantiateAnonymous(final double value, final Unit<?> unit)
    {
        if (unit instanceof DimensionlessUnit)
            return (S) new Dimensionless(value, (DimensionlessUnit) unit);
        else if (unit instanceof AccelerationUnit)
            return (S) new Acceleration(value, (AccelerationUnit) unit);
        else if (unit instanceof AngleSolidUnit)
            return (S) new AngleSolid(value, (AngleSolidUnit) unit);
        else if (unit instanceof AngleUnit)
            return (S) new Angle(value, (AngleUnit) unit);
        else if (unit instanceof DirectionUnit)
            return (S) new Direction(value, (DirectionUnit) unit);
        else if (unit instanceof AreaUnit)
            return (S) new Area(value, (AreaUnit) unit);
        else if (unit instanceof DensityUnit)
            return (S) new Density(value, (DensityUnit) unit);
        else if (unit instanceof ElectricalChargeUnit)
            return (S) new ElectricalCharge(value, (ElectricalChargeUnit) unit);
        else if (unit instanceof ElectricalCurrentUnit)
            return (S) new ElectricalCurrent(value, (ElectricalCurrentUnit) unit);
        else if (unit instanceof ElectricalPotentialUnit)
            return (S) new ElectricalPotential(value, (ElectricalPotentialUnit) unit);
        else if (unit instanceof ElectricalResistanceUnit)
            return (S) new ElectricalResistance(value, (ElectricalResistanceUnit) unit);
        else if (unit instanceof EnergyUnit)
            return (S) new Energy(value, (EnergyUnit) unit);
        else if (unit instanceof FlowMassUnit)
            return (S) new FlowMass(value, (FlowMassUnit) unit);
        else if (unit instanceof FlowVolumeUnit)
            return (S) new FlowVolume(value, (FlowVolumeUnit) unit);
        else if (unit instanceof ForceUnit)
            return (S) new Force(value, (ForceUnit) unit);
        else if (unit instanceof FrequencyUnit)
            return (S) new Frequency(value, (FrequencyUnit) unit);
        else if (unit instanceof LengthUnit)
            return (S) new Length(value, (LengthUnit) unit);
        else if (unit instanceof PositionUnit)
            return (S) new Position(value, (PositionUnit) unit);
        else if (unit instanceof LinearDensityUnit)
            return (S) new LinearDensity(value, (LinearDensityUnit) unit);
        else if (unit instanceof MassUnit)
            return (S) new Mass(value, (MassUnit) unit);
        else if (unit instanceof PowerUnit)
            return (S) new Power(value, (PowerUnit) unit);
        else if (unit instanceof PressureUnit)
            return (S) new Pressure(value, (PressureUnit) unit);
        else if (unit instanceof SpeedUnit)
            return (S) new Speed(value, (SpeedUnit) unit);
        else if (unit instanceof TemperatureUnit)
            return (S) new Temperature(value, (TemperatureUnit) unit);
        else if (unit instanceof AbsoluteTemperatureUnit)
            return (S) new AbsoluteTemperature(value, (AbsoluteTemperatureUnit) unit);
        else if (unit instanceof DurationUnit)
            return (S) new Duration(value, (DurationUnit) unit);
        else if (unit instanceof TimeUnit)
            return (S) new Time(value, (TimeUnit) unit);
        else if (unit instanceof TorqueUnit)
            return (S) new Torque(value, (TorqueUnit) unit);
        else if (unit instanceof VolumeUnit)
            return (S) new Volume(value, (VolumeUnit) unit);
        else if (unit instanceof MoneyUnit)
            return (S) new Money(value, (MoneyUnit) unit);
        else if (unit instanceof MoneyPerAreaUnit)
            return (S) new MoneyPerArea(value, (MoneyPerAreaUnit) unit);
        else if (unit instanceof MoneyPerEnergyUnit)
            return (S) new MoneyPerEnergy(value, (MoneyPerEnergyUnit) unit);
        else if (unit instanceof MoneyPerLengthUnit)
            return (S) new MoneyPerLength(value, (MoneyPerLengthUnit) unit);
        else if (unit instanceof MoneyPerMassUnit)
            return (S) new MoneyPerMass(value, (MoneyPerMassUnit) unit);
        else if (unit instanceof MoneyPerDurationUnit)
            return (S) new MoneyPerDuration(value, (MoneyPerDurationUnit) unit);
        else if (unit instanceof MoneyPerVolumeUnit)
            return (S) new MoneyPerVolume(value, (MoneyPerVolumeUnit) unit);
        else
            throw new RuntimeException(new UnitException("Cannot instantiate AbstractScalar of unit " + unit.toString()));
    }

    /**
     * Instantiate the DoubleScalar based on its unit.
     * @param si double; the value in SI units
     * @param displayUnit U; the unit in which the value is expressed
     * @return an instantiated DoubleScalar with the value expressed in the unit
     * @param <U> the unit
     * @param <S> the return type
     */
    public static <U extends Unit<U>, S extends AbstractDoubleScalar<U, S>> S instantiateSI(final double si,
            final U displayUnit)
    {
        return instantiateAnonymousSI(si, 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&lt;?&gt; type.<br>
     * <b>Note</b> that it is possible to make mistakes with anonymous units. The following <u>does</u> compile:
     * 
     * <pre>
     * MoneyPerLengthUnit mlu = new MoneyPerLengthUnit(MoneyUnit.USD, LengthUnit.METER, "$/m", "$/m");
     * 
     * MoneyPerArea mpa = DoubleScalarUtil.instantiateAnonymousSI(10.0, mlu);
     * </pre>
     * 
     * @param si double; the value in SI units
     * @param displayUnit Unit&lt;?&gt;; the unit in which the value is expressed
     * @return an instantiated DoubleScalar with the value expressed in the unit
     * @param <S> the return type
     */
    @SuppressWarnings({ "unchecked", "checkstyle:needbraces", "cast", "rawtypes" })
    public static <S extends AbstractDoubleScalar<?, S>> S instantiateAnonymousSI(final double si, final Unit<?> displayUnit)
    {
        S value;
        if (displayUnit instanceof MoneyPerAreaUnit)
            value = (S) new MoneyPerArea(si / ((MoneyPerAreaUnit) displayUnit).getScaleFactor(),
                    (MoneyPerAreaUnit) displayUnit);
        else if (displayUnit instanceof MoneyPerEnergyUnit)
            value = (S) new MoneyPerEnergy(si / ((MoneyPerEnergyUnit) displayUnit).getScaleFactor(),
                    (MoneyPerEnergyUnit) displayUnit);
        else if (displayUnit instanceof MoneyPerLengthUnit)
            value = (S) new MoneyPerLength(si / ((MoneyPerLengthUnit) displayUnit).getScaleFactor(),
                    (MoneyPerLengthUnit) displayUnit);
        else if (displayUnit instanceof MoneyPerMassUnit)
            value = (S) new MoneyPerMass(si / ((MoneyPerMassUnit) displayUnit).getScaleFactor(),
                    (MoneyPerMassUnit) displayUnit);
        else if (displayUnit instanceof MoneyPerDurationUnit)
            value = (S) new MoneyPerDuration(si / ((MoneyPerDurationUnit) displayUnit).getScaleFactor(),
                    (MoneyPerDurationUnit) displayUnit);
        else if (displayUnit instanceof MoneyPerVolumeUnit)
            value = (S) new MoneyPerVolume(si / ((MoneyPerVolumeUnit) displayUnit).getScaleFactor(),
                    (MoneyPerVolumeUnit) displayUnit);
        else
            value = (S) instantiateAnonymous(si, displayUnit.getStandardUnit());
        ((AbstractDoubleScalar) value).setDisplayUnit((Unit) displayUnit);
        return value;
    }
}