Package com.anylogic.engine
- java.lang.Object
- java.lang.Enum<TimeUnits>
- com.anylogic.engine.TimeUnits
- All Implemented Interfaces:
IUnits<TimeUnits>
,Serializable
,Comparable<TimeUnits>
,Constable
public enum TimeUnits extends Enum<TimeUnits> implements IUnits<TimeUnits>
Standard AnyLogic time units, should be used in specific functions and parameters which work with units.
- Author:
- AnyLogic North America, LLC https://anylogic.com
Enum.EnumDesc<E extends Enum<E>>
Modifier and Type | Method | Description |
---|---|---|
double | convertTo |
Converts the given value from this units to the given
units |
static TimeUnits | fromCalendarConstant |
This method is internal and shouldn't be called by user.
it may be removed/renamed in future. |
int | getCalendarConstant() |
This method is internal and shouldn't be called by user.
it may be removed/renamed in future. |
String | getName() |
Returns human-readable name (e.g.
|
boolean | isFixedLength() |
This method is internal and shouldn't be called by user.
it may be removed/renamed in future. |
double | modifier | |
long | toMilliseconds() | |
static TimeUnits | valueOf |
Returns the enum constant of this class with the specified name.
|
static TimeUnits[] | values() |
Returns an array containing the constants of this enum class, in
the order they are declared.
|
public static TimeUnits[] values()
Returns an array containing the constants of this enum class, in
the order they are declared.
- Returns:
- an array containing the constants of this enum class, in the order they are declared
public static TimeUnits valueOf(String name)
Returns the enum constant of this class with the specified name.
The string must match exactly an identifier used to declare an
enum constant in this class. (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:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
public String getName()
Description copied from interface:
IUnits
Returns human-readable name (e.g. "meters per second")
public double modifier(TimeUnits units)
public double convertTo(double value, TimeUnits units)
Description copied from interface:
IUnits
Converts the given value from this units to the given
units
@AnyLogicLegacyAPI public long toMilliseconds()
@AnyLogicLegacyAPI @AnyLogicInternalAPI public int getCalendarConstant()
This method is internal and shouldn't be called by user.
it may be removed/renamed in future.
it may be removed/renamed in future.
@AnyLogicInternalAPI public boolean isFixedLength()
This method is internal and shouldn't be called by user.
it may be removed/renamed in future.
it may be removed/renamed in future.
@AnyLogicLegacyAPI @AnyLogicInternalAPI public static TimeUnits fromCalendarConstant(int timeUnit)
This method is internal and shouldn't be called by user.
it may be removed/renamed in future.
it may be removed/renamed in future.