org.djunits.unit.scale

Class GradeScale

java.lang.Object

org.djunits.unit.scale.GradeScale

All Implemented Interfaces:

Serializable, Scale

public class GradeScale
extends Object
implements Scale

A Scale for transforming a slope as a grade, where 45 degrees is 1, and 90 degrees is infinite, to radians. The formula is: angle = atan(grade). The factor that is given, is the factor by which the value is multiplied to get a grade. When a scale is constructed for e.g. ratio as a percentage (100% instead of 1), the conversionFactor to apply is 0.01.

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

Constructor Summary

Constructors

Constructor and Description
GradeScale(double conversionFactorToGrade) Construct a Scale for transforming a slope as a grade, where 45 degrees is 1, and 90 degrees is infinite, to radians.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
double	fromStandardUnit(double value) Convert a value from an SI value to a value in the unit that uses this scale.
double	getConversionFactorToGrade()
int	hashCode()
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 java.lang.Object

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

Constructor Detail

GradeScale

public GradeScale(double conversionFactorToGrade)

Construct a Scale for transforming a slope as a grade, where 45 degrees is 1, and 90 degrees is infinite, to radians.

Parameters:

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

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 - 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

Parameters:

value - double; the value to convert

Returns:

the corresponding value in the given unit

getConversionFactorToGrade

public final double getConversionFactorToGrade()

Returns:

conversionFactorToGrade

isBaseSIScale

public final boolean isBaseSIScale()

Return whether this is a base (SI) scale.

Specified by:

isBaseSIScale in interface Scale

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object