Package com.anylogic.engine
- java.lang.Object
-
- java.lang.Enum<RateUnits>
-
- com.anylogic.engine.RateUnits
- All Implemented Interfaces:
IUnits<RateUnits>
,java.io.Serializable
,java.lang.Comparable<RateUnits>
public enum RateUnits extends java.lang.Enum<RateUnits> implements IUnits<RateUnits>
Standard AnyLogic rate units, should be used in specific functions and parameters which work with units.
- Author:
- AnyLogic North America, LLC https://anylogic.com
PER_DAY |
Per day
|
PER_HOUR |
Per hour
|
PER_MILLISECOND |
Per millisecond
|
PER_MINUTE |
Per minute
|
PER_MONTH |
Per month
|
PER_SECOND |
Per second
|
PER_WEEK |
Per week
|
PER_YEAR |
Per year
|
Enum Constant | Description |
---|
ALL_UNIT_TYPES
double |
convertTo(double value,
RateUnits units) |
Converts the given value from this units to the given
units |
java.lang.String |
getName() |
Returns human-readable name (e.g.
|
TimeUnits |
getTimeUnits() |
Returns the base time unit of this rate unit
|
double |
modifier(RateUnits units) |
|
static RateUnits |
valueOf(java.lang.String name) |
Returns the enum constant of this type with the specified name.
|
static RateUnits[] |
values() |
Returns an array containing the constants of this enum type, in
the order they are declared.
|
Modifier and Type | Method | Description |
---|
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
getClass, notify, notifyAll, wait, wait, wait
name
public static final RateUnits PER_MILLISECOND
Per millisecond
public static final RateUnits PER_SECOND
Per second
public static final RateUnits PER_MINUTE
Per minute
public static final RateUnits PER_HOUR
Per hour
public static final RateUnits PER_DAY
Per day
public static final RateUnits PER_WEEK
Per week
public static final RateUnits PER_MONTH
Per month
public static final RateUnits PER_YEAR
Per year
public static RateUnits[] 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 (RateUnits c : RateUnits.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
public static RateUnits 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 namejava.lang.NullPointerException
- if the argument is null
public java.lang.String getName()
Description copied from interface:
IUnits
Returns human-readable name (e.g. "meters per second")
public double modifier(RateUnits units)
public double convertTo(double value, RateUnits units)
Description copied from interface:
IUnits
Converts the given value from this units to the given
units
- Specified by:
convertTo
in interfaceIUnits<RateUnits>
- Parameters:
value
- the value, measured in this unitsunits
- units to convert the value to- Returns:
- the value, measured in the given
units
@AnyLogicInternalAPI public TimeUnits getTimeUnits()
Returns the base time unit of this rate unit
-
How can we improve this article?
-