com.anylogic.engine

Enum TimeUnits

java.lang.Object

java.lang.Enum<TimeUnits>

com.anylogic.engine.TimeUnits

All Implemented Interfaces:

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

public enum TimeUnits
extends java.lang.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 Constant Summary

Enum Constants

Enum Constant and Description
DAY Day
HOUR Hour
MILLISECOND Millisecond
MINUTE Minute
MONTH Month
SECOND Second
WEEK Week
YEAR Year

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

MILLISECOND

public static final TimeUnits MILLISECOND

Millisecond

SECOND

public static final TimeUnits SECOND

Second

MINUTE

public static final TimeUnits MINUTE

Minute

HOUR

public static final TimeUnits HOUR

Hour

DAY

public static final TimeUnits DAY

Day

WEEK

public static final TimeUnits WEEK

Week

MONTH

public static final TimeUnits MONTH

Month

YEAR

public static final TimeUnits YEAR

Year

Method Detail

values

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

Returns:

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

valueOf

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

modifier

public double modifier(TimeUnits units)

Specified by:

modifier in interface IUnits<TimeUnits>

convertTo

public double convertTo(double value,
                        TimeUnits units)

Description copied from interface: IUnits

Converts the given value from this units to the given units

Specified by:

convertTo in interface IUnits<TimeUnits>

Parameters:

value - the value, measured in this units

units - units to convert the value to

Returns:

the value, measured in the given units

toMilliseconds

@AnyLogicLegacyAPI
public long toMilliseconds()