com.anylogic.engine

Enum AmountUnits

java.lang.Object

java.lang.Enum<AmountUnits>

com.anylogic.engine.AmountUnits

All Implemented Interfaces:

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

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

Standard AnyLogic amount 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
CUBIC_METER Cubic meter
KILOGRAM Kilogram
LITER Liter
OIL_BARREL Oil barrel
TON Ton

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, AmountUnits units) Converts the given value from this units to the given units
AmountType	getAmountType()
java.lang.String	getName() Returns human-readable name (e.g.
double	modifier(AmountUnits units)
static AmountUnits	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AmountUnits[]	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

LITER

public static final AmountUnits LITER

Liter

OIL_BARREL

public static final AmountUnits OIL_BARREL

Oil barrel

CUBIC_METER

public static final AmountUnits CUBIC_METER

Cubic meter

KILOGRAM

public static final AmountUnits KILOGRAM

Kilogram

TON

public static final AmountUnits TON

Ton

Method Detail

values

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

Returns:

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

valueOf

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

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

modifier

public double modifier(AmountUnits units)

Specified by:

modifier in interface IUnits<AmountUnits>

convertTo

public double convertTo(double value,
                        AmountUnits units)

Description copied from interface: IUnits

Converts the given value from this units to the given units

Specified by:

convertTo in interface IUnits<AmountUnits>

Parameters:

value - the value, measured in this units

units - units to convert the value to

Returns:

the value, measured in the given units

getAmountType

@AnyLogicInternalAPI
public AmountType getAmountType()