com.anylogic.engine

Enum SpeedUnits

java.lang.Object

java.lang.Enum<SpeedUnits>

com.anylogic.engine.SpeedUnits

All Implemented Interfaces:

IUnits<SpeedUnits>, java.io.Serializable, java.lang.Comparable<SpeedUnits>

public enum SpeedUnits
extends java.lang.Enum<SpeedUnits>
implements IUnits<SpeedUnits>

Standard AnyLogic speed units, should be used in specific functions and parameters which work with units.

Author:

AnyLogic North America, LLC https://anylogic.com

Enum Constant Summary

Enum Constants

Enum Constant and Description
FPM Feet per minute
FPS Feet per second
KN Knots
KPH Kilometers per hour
MPH Miles per hour
MPS Meters per second

Field Summary

Fields inherited from interface com.anylogic.engine.IUnits

ALL_UNIT_TYPES

Method Summary

Modifier and Type	Method and Description
double	convertTo(double value, SpeedUnits units) Converts the given value from this units to the given units
LengthUnits	getLengthUnits()
java.lang.String	getName() Returns human-readable name (e.g.
TimeUnits	getTimeUnits()
double	modifier(SpeedUnits units)
static SpeedUnits	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SpeedUnits[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.anylogic.engine.IUnits

name

Enum Constant Detail

MPS

public static final SpeedUnits MPS

Meters per second

KPH

public static final SpeedUnits KPH

Kilometers per hour

FPS

public static final SpeedUnits FPS

Feet per second

FPM

public static final SpeedUnits FPM

Feet per minute

MPH

public static final SpeedUnits MPH

Miles per hour

KN

public static final SpeedUnits KN

Knots

Method Detail

values

public static SpeedUnits[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SpeedUnits c : SpeedUnits.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SpeedUnits valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getLengthUnits

public LengthUnits getLengthUnits()

getTimeUnits

public TimeUnits getTimeUnits()

getName

public java.lang.String getName()

Description copied from interface: IUnits

Returns human-readable name (e.g. "meters per second")

Specified by:

getName in interface IUnits<SpeedUnits>

modifier

public double modifier(SpeedUnits units)

Specified by:

modifier in interface IUnits<SpeedUnits>

convertTo

public double convertTo(double value,
                        SpeedUnits units)

Description copied from interface: IUnits

Converts the given value from this units to the given units

Specified by:

convertTo in interface IUnits<SpeedUnits>

Parameters:

value - the value, measured in this units

units - units to convert the value to

Returns:

the value, measured in the given units