io.sarl.sre.services.time

Interface TimeService

All Superinterfaces:

com.google.common.util.concurrent.Service

All Known Implementing Classes:

AbstractTimeService, AbstractTimeService, JreTimeService

public interface TimeService
extends com.google.common.util.concurrent.Service

This class enables to have access to the time manager of the platform.

Since:

0.6.0

Version:

io.janusproject.plugin 0.12.0 20210527-171007

Author:

Stéphane Galland

Maven Group Id:

io.janusproject.sre

Maven Artifact Id:

io.janusproject.plugin

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Method Summary

Modifier and Type	Method and Description
void	addTimeListener(listener : TimeListener) Add listener on time changes.
boolean	evolveTimeIfPossible([timeDelta : double]) Do a time evolution if the underlying service allows this action.
double	fromOSDuration(timeDuration : double) Convert the given duration from the operating system time scale to the agent system time scale.
double	fromOSTime(timeValue : double) Convert the given time from the operating system time scale to the agent system time scale.
long	getOSCurrentTime() Replies the OS current time.
double	getOSTimeFactor() Replies the scaling factor between the agent time and the operating system time.
double	getTime(timeUnit : TimeUnit) Replies the current time.
TimeUnit	getTimePrecision() Replies the precision of the time that is assumed by this manager.
void	removeTimeListener(listener : TimeListener) Remove listener on time changes.
boolean	setTimeIfPossible(time : double) Change the time.
double	toOSDuration(timeDuration : double) Convert the given duration from the agent system time scale to the operating system time scale.
double	toOSTime(timeValue : double) Convert the given time from the agent system time scale to the operating system time scale.

Methods inherited from interface com.google.common.util.concurrent.Service

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync

Method Detail

getTime

@Pure
def getTime(timeUnit : TimeUnit) : double 

Description copied from interface: TimeService

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.

getOSCurrentTime

@Pure
def getOSCurrentTime() : long 

Description copied from interface: TimeService

Replies the OS current time.

Returns:

the OS current time in ms.

getOSTimeFactor

@Pure
def getOSTimeFactor() : double 

Description copied from interface: TimeService

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.

fromOSDuration

def fromOSDuration(timeDuration : double) : double 

Description copied from interface: TimeService

Convert the given duration from the operating system time scale to the agent system time scale. This function uses TimeService.getOSTimeFactor() for converting the duration.

Parameters:

timeDuration - the duration for the operating system.

Returns:

the duration for the agent system.

Since:

0.9

fromOSTime

def fromOSTime(timeValue : double) : double 

Description copied from interface: TimeService

Convert the given time from the operating system time scale to the agent system time scale. This function uses TimeService.getOSTimeFactor() for converting the duration.

Parameters:

timeValue - the time for the operating system.

Returns:

the time for the agent system.

Since:

0.9

toOSDuration

@Pure
def toOSDuration(timeDuration : double) : double 

Description copied from interface: TimeService

Convert the given duration from the agent system time scale to the operating system time scale. This function uses TimeService.getOSTimeFactor() for converting the duration.

Parameters:

timeDuration - the duration for the agent system.

Returns:

the duration for the operating system.

Since:

0.9

toOSTime

@Pure
def toOSTime(timeValue : double) : double 

Description copied from interface: TimeService

Convert the given time from the agent system time scale to the operating system time scale. This function uses TimeService.getOSTimeFactor() for converting the time.

Parameters:

timeValue - the time for the agent system.

Returns:

the time for the operating system.

Since:

0.9

getTimePrecision

@Pure
def getTimePrecision() : TimeUnit 

Description copied from interface: TimeService

Replies the precision of the time that is assumed by this manager.

Any duration that is below the time precision is ignored.

Returns:

the time precision, never null.

evolveTimeIfPossible

def evolveTimeIfPossible([timeDelta : double]) : boolean 

Description copied from interface: TimeService

Do a time evolution if the underlying service allows this action.

Parameters:

timeDelta - is the amount of time to consider for the evolution. If it is negative or zero, a default amount will be selected by the time service.

Returns:

true if time has evolved. Otherwise false.

setTimeIfPossible

def setTimeIfPossible(time : double) : boolean 

Description copied from interface: TimeService

Change the time.

Parameters:

time - the new time.

Returns:

true if time has evolved. Otherwise false.

addTimeListener

def addTimeListener(listener : TimeListener) : void 

Description copied from interface: TimeService

Add listener on time changes.

Parameters:

listener - the listener.

removeTimeListener

def removeTimeListener(listener : TimeListener) : void 

Description copied from interface: TimeService

Remove listener on time changes.

Parameters:

listener - the listener.