org.djunits.unit.scale

Interface Scale

All Superinterfaces:

Serializable

All Known Implementing Classes:

GradeScale, LinearScale, OffsetLinearScale, StandardScale

public interface Scale
extends Serializable

Scales for unit conversion, offers functions to and from SI units. E.g., LinearScale for Length, Area, etc. LinearOffsetScale for Temperature. PercentScale for Angle. LogarithmicScale for Sound.

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

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.

Method Detail

toStandardUnit

double toStandardUnit(double value)

Convert a value to an SI value using this scale.

Parameters:

value - double; the value to convert

Returns:

the corresponding SI value

fromStandardUnit

double fromStandardUnit(double value)

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

Parameters:

value - double; the value to convert

Returns:

the corresponding value in the given unit

isBaseSIScale

boolean isBaseSIScale()

Return whether this is a base (SI) scale.

Returns:

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