com.anylogic.engine

Enum FlowRateUnits

java.lang.Object

java.lang.Enum<FlowRateUnits>

com.anylogic.engine.FlowRateUnits

All Implemented Interfaces:

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

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

Standard AnyLogic flow rate 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_PER_SECOND Cubic meter per second
KILOGRAM_PER_SECOND Kilogram per second
LITER_PER_SECOND Liter per second
OIL_BARREL_PER_SECOND Oil barrel per second
TON_PER_SECOND Ton 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, FlowRateUnits units) Converts the given value from this units to the given units
AmountType	getAmountType()
AmountUnits	getAmountUnits()
java.lang.String	getName() Returns human-readable name (e.g.
TimeUnits	getTimeUnits()
double	modifier(FlowRateUnits units)
static FlowRateUnits	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FlowRateUnits[]	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_PER_SECOND

public static final FlowRateUnits LITER_PER_SECOND

Liter per second

OIL_BARREL_PER_SECOND

public static final FlowRateUnits OIL_BARREL_PER_SECOND

Oil barrel per second

CUBIC_METER_PER_SECOND

public static final FlowRateUnits CUBIC_METER_PER_SECOND

Cubic meter per second

KILOGRAM_PER_SECOND

public static final FlowRateUnits KILOGRAM_PER_SECOND

Kilogram per second

TON_PER_SECOND

public static final FlowRateUnits TON_PER_SECOND

Ton per second

Method Detail

values

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

Returns:

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

valueOf

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

getAmountUnits

public AmountUnits getAmountUnits()

getAmountType

public AmountType getAmountType()

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

modifier

public double modifier(FlowRateUnits units)

Specified by:

modifier in interface IUnits<FlowRateUnits>

convertTo

public double convertTo(double value,
                        FlowRateUnits units)

Description copied from interface: IUnits

Converts the given value from this units to the given units

Specified by:

convertTo in interface IUnits<FlowRateUnits>

Parameters:

value - the value, measured in this units

units - units to convert the value to

Returns:

the value, measured in the given units