org.djunits.unit.scale

Class OffsetLinearScale

java.lang.Object

org.djunits.unit.scale.OffsetLinearScale

All Implemented Interfaces:

Scale

public class OffsetLinearScale
extends Object
implements Scale

A Scale for linear transformations with an offset that has to be applied first when converting to the standard (SI) unit, before the scaling takes place, e.g. for Temperature. As an example, transform from Degrees Fahrenheit to Kelvin (SI). The conversion is K = (F + 459.67) × 5⁄9, and F = K × 9⁄5 − 459.67.

Copyright (c) 2013-2016 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 Oct 11, 2015

Author:

Alexander Verbraeck, Peter Knoppers

Constructor Summary

Constructors

Constructor and Description
OffsetLinearScale(double conversionFactorToStandardUnit, double offsetToStandardUnit) Construct a Scale for linear transformations with an offset, e.g.

Method Summary

Modifier and Type	Method and Description
double	fromStandardUnit(double value) Convert a value from an SI value to a value in the unit that uses this scale.
double	getConversionFactorToStandardUnit()
double	getOffsetToStandardUnit()
double	toStandardUnit(double value) Convert a value to an SI value using this scale.

Methods inherited from class java.lang.Object

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

Constructor Detail

OffsetLinearScale

public OffsetLinearScale(double conversionFactorToStandardUnit,
                         double offsetToStandardUnit)

Construct a Scale for linear transformations with an offset, e.g. for Temperature.

Parameters:

conversionFactorToStandardUnit - the conversion factor by which this number has to be multiplied to convert it to the standard (e.g., SI) unit.

offsetToStandardUnit - the offset that has to be taken into account for conversions; when converting to a standard unit, the offset is applied first.

Method Detail

toStandardUnit

public final double toStandardUnit(double value)

Convert a value to an SI value using this scale.

Specified by:

toStandardUnit in interface Scale

Parameters:

value - the value to convert

Returns:

the corresponding SI value

fromStandardUnit

public final double fromStandardUnit(double value)

Convert a value from an SI value to a value in the unit that uses this scale.

Specified by:

fromStandardUnit in interface Scale

Parameters:

value - the value to convert

Returns:

the corresponding value in the given unit

getConversionFactorToStandardUnit

public final double getConversionFactorToStandardUnit()

Returns:

conversionFactorToStandardUnit

getOffsetToStandardUnit

public final double getOffsetToStandardUnit()

Returns:

offsetToStandardUnit