org.djunits.unit.scale

Class StandardScale

java.lang.Object

org.djunits.unit.scale.LinearScale

org.djunits.unit.scale.StandardScale

All Implemented Interfaces:

Serializable, Scale

public class StandardScale
extends LinearScale

A Scale for standard, e.g. SI, units. Values in these units need no conversion.

Copyright (c) 2013-2019 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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static StandardScale	SCALE a ready-to-use instance of the standard scale (they are all the same...).

Constructor Summary

Constructors

Constructor and Description
StandardScale() Construct a standard Scale without a transformation.

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.
boolean	isBaseSIScale() Return whether this is a base (SI) scale.
double	toStandardUnit(double value) Convert a value to an SI value using this scale.

Methods inherited from class org.djunits.unit.scale.LinearScale

equals, getConversionFactorToStandardUnit, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

SCALE

public static final StandardScale SCALE

a ready-to-use instance of the standard scale (they are all the same...).

Constructor Detail

StandardScale

public StandardScale()

Construct a standard Scale without a transformation.

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

Overrides:

toStandardUnit in class LinearScale

Parameters:

value - double; 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

Overrides:

fromStandardUnit in class LinearScale

Parameters:

value - double; the value to convert

Returns:

the corresponding value in the given unit

isBaseSIScale

public final boolean isBaseSIScale()

Return whether this is a base (SI) scale.

Specified by:

isBaseSIScale in interface Scale

Overrides:

isBaseSIScale in class LinearScale

Returns:

boolean; whether this is a base (SI) scale or not