jadex.platform.service.clock

Class ClockService

java.lang.Object

jadex.bridge.service.BasicService

jadex.platform.service.clock.ClockService

All Implemented Interfaces:

jadex.bridge.service.IInternalService, jadex.bridge.service.IService, jadex.bridge.service.types.clock.IClockService, jadex.commons.IPropertiesProvider

public class ClockService
extends jadex.bridge.service.BasicService
implements jadex.bridge.service.types.clock.IClockService, jadex.commons.IPropertiesProvider

A clock service abstracts away from clock implementations. The clock service is meant to be kept constant during runtime.

Field Summary

Fields

Modifier and Type	Field and Description
protected ClockCreationInfo	cinfo The clock type.
protected jadex.bridge.service.types.clock.IClock	clock The clock.
protected jadex.bridge.IInternalAccess	component The component.
protected java.util.List	listeners The clock listeners.
protected java.lang.Boolean	simulation Was simulation set via argument?
protected jadex.bridge.service.types.threadpool.IThreadPoolService	threadpool The threadpool.
protected java.util.Timer	timer The realtime timer.

Fields inherited from class jadex.bridge.service.BasicService

idcnt, impltype, internalaccess, providerid, shutdowned, sid, started, type

Fields inherited from interface jadex.bridge.service.types.clock.IClockService

TYPE

Fields inherited from interface jadex.bridge.service.IService

EMPTY_SERVICES

Constructor Summary

Constructors

Constructor and Description
ClockService(ClockCreationInfo cinfo, jadex.bridge.IInternalAccess component, java.lang.Boolean simulation) Create a new clock service.
ClockService(ClockCreationInfo cinfo, jadex.bridge.IInternalAccess component, java.util.Map properties, java.lang.Boolean simulation) Create a new clock service.

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(jadex.commons.IChangeListener listener) Add a change listener.
boolean	advanceEvent() Advance one event.
static jadex.bridge.service.types.clock.IClock	createClock(ClockCreationInfo cinfo, jadex.commons.concurrent.IThreadPool tp) Create a clock.
java.util.TimerTask	createRealtimeTimer(long time, jadex.bridge.service.types.clock.ITimedObject to) Create a new realtime timer.
jadex.bridge.service.types.clock.ITimer	createTickTimer(jadex.bridge.service.types.clock.ITimedObject to) Create a new tick timer.
jadex.bridge.service.types.clock.ITimer	createTimer(long time, jadex.bridge.service.types.clock.ITimedObject to) Create a new timer.
java.lang.String	getClockType() Get the clock type.
long	getDelta() Get the clock delta.
double	getDilation() Get the clocks dilation.
jadex.bridge.service.types.clock.ITimer	getNextTimer() Get the next timer.
jadex.commons.future.IFuture<jadex.commons.Properties>	getProperties() Write current state into properties.
long	getStarttime() Get the clocks start time.
java.lang.String	getState() Get the clock state.
double	getTick() Get the current tick.
long	getTime() Get the current time.
jadex.bridge.service.types.clock.ITimer[]	getTimers() Get all active timers.
void	removeChangeListener(jadex.commons.IChangeListener listener) Remove a change listener.
void	setClock(java.lang.String type, jadex.commons.concurrent.IThreadPool tp) Set the clock.
void	setDelta(long delta) Set the clock delta.
void	setDilation(double dilation) Set the clocks dilation.
jadex.commons.future.IFuture<java.lang.Void>	setProperties(jadex.commons.Properties props) Update from given properties.
void	setTime(long time) Set the current time.
jadex.commons.future.IFuture<java.lang.Void>	shutdownService() Shutdown the service.
void	start() Start the clock.
jadex.commons.future.IFuture<java.lang.Void>	startService() Start the service.
void	stop() Stop the clock.

Methods inherited from class jadex.bridge.service.BasicService

createServiceIdentifier, createServiceIdentifier, equals, generateServiceName, getInterfaceType, getInternalAccess, getMethodTimeout, getPropertyMap, getProviderId, getServiceIdentifier, hashCode, initNFProperties, isValid, setComponentAccess, setPropertyMap, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jadex.bridge.service.IService

getPropertyMap, getServiceIdentifier, isValid

Field Detail

clock

protected jadex.bridge.service.types.clock.IClock clock

The clock.

threadpool

protected jadex.bridge.service.types.threadpool.IThreadPoolService threadpool

The threadpool.

listeners

protected java.util.List listeners

The clock listeners.

component

protected jadex.bridge.IInternalAccess component

The component.

cinfo

protected ClockCreationInfo cinfo

The clock type.

simulation

protected java.lang.Boolean simulation

Was simulation set via argument?

timer

protected java.util.Timer timer

The realtime timer.

Constructor Detail

ClockService

public ClockService(ClockCreationInfo cinfo,
                    jadex.bridge.IInternalAccess component,
                    java.lang.Boolean simulation)

Create a new clock service.

ClockService

public ClockService(ClockCreationInfo cinfo,
                    jadex.bridge.IInternalAccess component,
                    java.util.Map properties,
                    java.lang.Boolean simulation)

Create a new clock service.

Method Detail

getTime

public long getTime()

Get the current time.

Specified by:

getTime in interface jadex.bridge.service.types.clock.IClockService

Returns:

The current time.

setTime

public void setTime(long time)

Set the current time.

Parameters:

time - The current time.

getTick

public double getTick()

Get the current tick.

Specified by:

getTick in interface jadex.bridge.service.types.clock.IClockService

Returns:

The current tick.

getStarttime

public long getStarttime()

Get the clocks start time.

Specified by:

getStarttime in interface jadex.bridge.service.types.clock.IClockService

Returns:

The start time.

getDelta

public long getDelta()

Get the clock delta.

Specified by:

getDelta in interface jadex.bridge.service.types.clock.IClockService

Returns:

The clock delta.

setDelta

public void setDelta(long delta)

Set the clock delta. param delta The new clock delta.

Specified by:

setDelta in interface jadex.bridge.service.types.clock.IClockService

getState

public java.lang.String getState()

Get the clock state.

Specified by:

getState in interface jadex.bridge.service.types.clock.IClockService

Returns:

The clock state.

getDilation

public double getDilation()

Get the clocks dilation.

Specified by:

getDilation in interface jadex.bridge.service.types.clock.IClockService

Returns:

The clocks dilation. // Hack!!! only for continuous clock.

setDilation

public void setDilation(double dilation)

Set the clocks dilation.

Specified by:

setDilation in interface jadex.bridge.service.types.clock.IClockService

Parameters:

dilation - The clocks dilation. // Hack. Remove? only for continuous

getClockType

public java.lang.String getClockType()

Get the clock type.

Specified by:

getClockType in interface jadex.bridge.service.types.clock.IClockService

Returns:

The clock type.

createTimer

public jadex.bridge.service.types.clock.ITimer createTimer(long time,
                                                           jadex.bridge.service.types.clock.ITimedObject to)

Create a new timer. The unit of the timespan value depends on the clock implementation. For system clocks, the time value should adhere to the time representation as used by System.currentTimeMillis().

Specified by:

createTimer in interface jadex.bridge.service.types.clock.IClockService

Parameters:

timespan - The relative timespan after which the timed object should be notified.

to - The timed object.

createTickTimer

public jadex.bridge.service.types.clock.ITimer createTickTimer(jadex.bridge.service.types.clock.ITimedObject to)

Create a new tick timer. todo: @param tickcount The number of ticks.

Specified by:

createTickTimer in interface jadex.bridge.service.types.clock.IClockService

Parameters:

to - The timed object.

createRealtimeTimer

public java.util.TimerTask createRealtimeTimer(long time,
                                               jadex.bridge.service.types.clock.ITimedObject to)

Create a new realtime timer.

Specified by:

createRealtimeTimer in interface jadex.bridge.service.types.clock.IClockService

Parameters:

timespan - The relative timespan after which the timed object should be notified.

to - The timed object.

getNextTimer

public jadex.bridge.service.types.clock.ITimer getNextTimer()

Get the next timer.

Specified by:

getNextTimer in interface jadex.bridge.service.types.clock.IClockService

Returns:

The next timer.

getTimers

public jadex.bridge.service.types.clock.ITimer[] getTimers()

Get all active timers.

Specified by:

getTimers in interface jadex.bridge.service.types.clock.IClockService

Returns:

The active timers.

addChangeListener

public void addChangeListener(jadex.commons.IChangeListener listener)

Add a change listener.

Specified by:

addChangeListener in interface jadex.bridge.service.types.clock.IClockService

Parameters:

listener - The change listener.

removeChangeListener

public void removeChangeListener(jadex.commons.IChangeListener listener)

Remove a change listener.

Specified by:

removeChangeListener in interface jadex.bridge.service.types.clock.IClockService

Parameters:

listener - The change listener.

advanceEvent

public boolean advanceEvent()

Advance one event.

Specified by:

advanceEvent in interface jadex.bridge.service.types.clock.IClockService

Returns:

True, if clock could be advanced.

start

public void start()

Start the clock.

Specified by:

start in interface jadex.bridge.service.types.clock.IClockService

stop

public void stop()

Stop the clock.

Specified by:

stop in interface jadex.bridge.service.types.clock.IClockService

startService

public jadex.commons.future.IFuture<java.lang.Void> startService()

Start the service.

Specified by:

startService in interface jadex.bridge.service.IInternalService

Overrides:

startService in class jadex.bridge.service.BasicService

shutdownService

public jadex.commons.future.IFuture<java.lang.Void> shutdownService()

Shutdown the service.

Specified by:

shutdownService in interface jadex.bridge.service.IInternalService

Overrides:

shutdownService in class jadex.bridge.service.BasicService

Parameters:

listener - The listener.

setClock

public void setClock(java.lang.String type,
                     jadex.commons.concurrent.IThreadPool tp)

Set the clock.

Specified by:

setClock in interface jadex.bridge.service.types.clock.IClockService

Parameters:

clock - The new clock.

createClock

public static jadex.bridge.service.types.clock.IClock createClock(ClockCreationInfo cinfo,
                                                                  jadex.commons.concurrent.IThreadPool tp)

Create a clock.

setProperties

public jadex.commons.future.IFuture<java.lang.Void> setProperties(jadex.commons.Properties props)

Update from given properties.

Specified by:

setProperties in interface jadex.commons.IPropertiesProvider

getProperties

public jadex.commons.future.IFuture<jadex.commons.Properties> getProperties()

Write current state into properties.

Specified by:

getProperties in interface jadex.commons.IPropertiesProvider