io.sarl.sre.services.time

Class AbstractTimeService

java.lang.Object

com.google.common.util.concurrent.AbstractService

io.sarl.sre.services.AbstractSreService

io.sarl.sre.services.time.AbstractTimeService

All Implemented Interfaces:

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

public abstract class AbstractTimeService
extends AbstractSreService
implements TimeService

Time service based on the JRE standard time.

Since:

0.10.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
AbstractTimeService(listeners : SmartListenerCollection<TimeListener>) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addTimeListener(listener : TimeListener) Add listener on time changes.
protected void	fireTimeChanged() Notifies about time changes.
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.
void	removeTimeListener(listener : TimeListener) Remove listener on time changes.
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 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 io.sarl.sre.services.time.TimeService

evolveTimeIfPossible, getOSTimeFactor, getTime, getTimePrecision, setTimeIfPossible

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

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

Constructor Detail

AbstractTimeService

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

Returns:

the OS current time in ms.

fromOSDuration

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

Specified by:

fromOSDuration in interface TimeService

Parameters:

timeDuration - the duration for the operating system.

Returns:

the duration for the agent system.

fromOSTime

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

Specified by:

fromOSTime in interface TimeService

Parameters:

timeValue - the time for the operating system.

Returns:

the time for the agent system.

toOSDuration

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

Specified by:

toOSDuration in interface TimeService

Parameters:

timeDuration - the duration for the agent system.

Returns:

the duration for the operating system.

toOSTime

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

Specified by:

toOSTime in interface TimeService

Parameters:

timeValue - the time for the agent system.

Returns:

the time for the operating system.

fireTimeChanged

protected def fireTimeChanged() : void 

Description copied from class: AbstractTimeService

Notifies about time changes.

addTimeListener

public def addTimeListener(listener : TimeListener) : void 

Description copied from interface: TimeService

Add listener on time changes.

Specified by:

addTimeListener in interface TimeService

Parameters:

listener - the listener.

removeTimeListener

public def removeTimeListener(listener : TimeListener) : void 

Description copied from interface: TimeService

Remove listener on time changes.

Specified by:

removeTimeListener in interface TimeService

Parameters:

listener - the listener.