at.borkowski.spicej.impl

Class AbstractTickSource

java.lang.Object

at.borkowski.spicej.impl.AbstractTickSource

All Implemented Interfaces:

TickSource

Direct Known Subclasses:

SimulationTickSource

public abstract class AbstractTickSource
extends Object
implements TickSource

An abstract tick source keeping track of its listeners. The tick source is in a non-initialized state until the first call to doTick().

Field Summary

Fields

Modifier and Type	Field and Description
protected Queue<TickListener>	listeners

Constructor Summary

Constructors

Constructor and Description
AbstractTickSource()

Method Summary

Modifier and Type	Method and Description
void	addListener(TickListener listener) Adds a listener to fire tick events to.
protected void	doTick() Distributes a tick event to its listeners.
long	getCurrentTick() Returns the current tick.
void	removeListener(TickListener listener) Removes a tick listener.
void	reset() Resets the tick source to its initial state.

Methods inherited from class java.lang.Object

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

Field Detail

listeners

protected final Queue<TickListener> listeners

Constructor Detail

AbstractTickSource

public AbstractTickSource()

Method Detail

addListener

public void addListener(TickListener listener)

Description copied from interface: TickSource

Adds a listener to fire tick events to.

Specified by:

addListener in interface TickSource

Parameters:

listener - the listener to add

removeListener

public void removeListener(TickListener listener)

Description copied from interface: TickSource

Removes a tick listener.

Specified by:

removeListener in interface TickSource

Parameters:

listener - the listener to remove

doTick

protected void doTick()

Distributes a tick event to its listeners.

getCurrentTick

public long getCurrentTick()

Description copied from interface: TickSource

Returns the current tick.

Specified by:

getCurrentTick in interface TickSource

Returns:

the current tick

reset

public void reset()

Description copied from interface: TickSource

Resets the tick source to its initial state. The exact outcome is not defined and may be either inside the first tick or in an uninitialized tick state.

Specified by:

reset in interface TickSource