java.lang.Object
- java.lang.Enum<LengthUnits>
- - com.anylogic.engine.LengthUnits

All Implemented Interfaces:: IUnits<LengthUnits>, java.io.Serializable, java.lang.Comparable<LengthUnits>

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

Standard AnyLogic length 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	Description
`CENTIMETER`	Centimeter
`FOOT`	Foot
`INCH`	Inch
`KILOMETER`	Kilometer
`METER`	Meter
`MILE`	Mile
`MILLIMETER`	Millimeter
`NAUTICAL_MILE`	Nautical mile
`YARD`	Yard

Field Summary

Fields inherited from interface com.anylogic.engine.IUnits

ALL_UNIT_TYPES

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`convertTo(double value, LengthUnits units)`	Converts the given value from this units to the given `units`
`java.lang.String`	`formatName(boolean fullName)`
`java.lang.String`	`getName()`	Returns human-readable name (e.g.
`double`	`modifier(LengthUnits units)`
`static LengthUnits`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static LengthUnits[]`	`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

MILLIMETER

public static final LengthUnits MILLIMETER

Millimeter

CENTIMETER

public static final LengthUnits CENTIMETER

Centimeter

METER

public static final LengthUnits METER

Meter

KILOMETER

public static final LengthUnits KILOMETER

Kilometer

INCH

public static final LengthUnits INCH

Inch

FOOT

public static final LengthUnits FOOT

Foot

YARD

public static final LengthUnits YARD

Yard

MILE

public static final LengthUnits MILE

Mile

NAUTICAL_MILE

public static final LengthUnits NAUTICAL_MILE

Nautical mile

Method Detail

values

public static LengthUnits[] 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 (LengthUnits c : LengthUnits.values())
    System.out.println(c);

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

valueOf

public static LengthUnits 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

formatName

public java.lang.String formatName(boolean fullName)

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

modifier

public double modifier(LengthUnits units)

Specified by:: modifier in interface IUnits<LengthUnits>

convertTo

public double convertTo(double value,
                        LengthUnits units)