io.sarl.core

Capacity Time

All Superinterfaces:

Capacity

public interface Time
extends Capacity

Gives access to the time in the agent application. Time management is application-dependent. This capacity does not make any assumption on neither time evolution nor time refresh rate.

Nested Class Summary

Nested classes/interfaces inherited from interface io.sarl.lang.core.Capacity

Capacity.ContextAwareCapacityWrapper<C extends Capacity>

Method Summary

Modifier and Type	Method and Description
double	fromOSDuration(timeDuration : double) Convert the given duration from the operating system time scale to the time scale of this builtin capacity.
double	fromOSTime(timeValue : double) Convert the given time from the operating system time scale to the time scale of this builtin capacity.
double	getOSTimeFactor() Replies the scaling factor between the agent time and the operating system time.
double	getTime([timeUnit : TimeUnit]) Replies the current time.
double	toOSDuration(timeDuration : double) Convert the given duration from the time scale of this builtin capacity to the operating system time scale.
double	toOSTime(timeValue : double) Convert the given time from the time scale of this builtin capacity to the operating system time scale.

Method Detail

getTime

@Pure
def getTime([timeUnit : TimeUnit]) : double 

Description copied from interface: Time

Replies the current time.

Parameters:

timeUnit - if present, specifies the time unit of the value to reply. By default is it seconds.

Returns:

the current time.

getOSTimeFactor

@Pure
def getOSTimeFactor() : double 

Description copied from interface: Time

Replies the scaling factor between the agent time and the operating system time.

Consider time in the agent application. It may evolves at a different rate than the operating system time. The value that is replied by this function permits to determine the proportionally between the agent application time and the operating system time. A typical equation for representing this relation is: os time = OSTimeFactor * agent time.

Returns:

the factor between agent time and operating system time.

toOSTime

@Pure
def toOSTime(timeValue : double) : double 

Description copied from interface: Time

Convert the given time from the time scale of this builtin capacity to the operating system time scale. It means that the "SRE" milliseconds are converted to operating system milliseconds.

Parameters:

timeValue - the value to convert.

Returns:

the number of milleseconds in the OS that correspond to the given number in the SRE.

Since:

0.9

fromOSTime

def fromOSTime(timeValue : double) : double 

Description copied from interface: Time

Convert the given time from the operating system time scale to the time scale of this builtin capacity. It means that the operating system milliseconds are converted to "SRE" milliseconds.

Parameters:

timeValue - the value to convert.

Returns:

the number of milleseconds in the SRE that correspond to the given number in the OS.

Since:

0.9

toOSDuration

@Pure
def toOSDuration(timeDuration : double) : double 

Description copied from interface: Time

Convert the given duration from the time scale of this builtin capacity to the operating system time scale. It means that the "SRE" milliseconds are converted to operating system milliseconds.

Parameters:

timeDuration - the value to convert.

Returns:

the number of milleseconds in the OS that correspond to the given number in the SRE.

Since:

0.9

fromOSDuration

def fromOSDuration(timeDuration : double) : double 

Description copied from interface: Time

Convert the given duration from the operating system time scale to the time scale of this builtin capacity. It means that the operating system milliseconds are converted to "SRE" milliseconds.

Parameters:

timeDuration - the value to convert.

Returns:

the number of milleseconds in the SRE that correspond to the given number in the OS.

Since:

0.9