io.sarl.sre.services.time

Class JreTimeService

java.lang.Object

com.google.common.util.concurrent.AbstractService

io.sarl.sre.services.AbstractSreService

io.sarl.sre.services.time.AbstractTimeService

io.sarl.sre.services.time.JreTimeService

All Implemented Interfaces:

com.google.common.util.concurrent.Service, TimeService

@Singleton
public class JreTimeService
extends AbstractTimeService

Time service based on the JRE standard time.

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

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

Constructor Summary

Constructors

Constructor and Description
JreTimeService(listeners : SmartListenerCollection<TimeListener>) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	evolveTimeIfPossible([timeDelta : double]) Do a time evolution if the underlying service allows this action.
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.
boolean	setTimeIfPossible(time : double) Change the time.

Methods inherited from class io.sarl.sre.services.time.AbstractTimeService

addTimeListener, fireTimeChanged, fromOSDuration, fromOSTime, removeTimeListener, toOSDuration, toOSTime

Methods inherited from class io.sarl.sre.services.AbstractSreService

doStart, doStop, onStart, onStop

Methods inherited from class com.google.common.util.concurrent.AbstractService

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, doCancelStart, failureCause, isRunning, notifyFailed, notifyStarted, notifyStopped, startAsync, state, stopAsync, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

Constructor Detail

JreTimeService

@Inject
public new(listeners : SmartListenerCollection<TimeListener>)

Constructor.

Parameters:

listeners - the empty collection of listeners that must be used by this service.

Method Detail

getOSCurrentTime

@Pure
public def getOSCurrentTime() : long 

Description copied from interface: TimeService

Replies the OS current time.

Specified by:

getOSCurrentTime in interface TimeService

Overrides:

getOSCurrentTime in class AbstractTimeService

Returns:

the OS current time in ms.

getTimePrecision

@Pure
public 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.

getTime

@Pure
public 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.

getOSTimeFactor

@Pure
public 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.

evolveTimeIfPossible

public 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

public 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.