at.borkowski.spicej.ticks

Interface TickSource

All Known Implementing Classes:

AbstractTickSource, SimulationTickSource

public interface TickSource

An interface for tick sources, ie. objects generating tick events. Ticks sent to TickListener objects are guaranteed to not overlap each other, ie. no two threads will enter the same object's TickListener.tick(long) at the same time.

Method Summary

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

Method Detail

reset

void reset()

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.

addListener

void addListener(TickListener listener)

Adds a listener to fire tick events to.

Parameters:

listener - the listener to add

removeListener

void removeListener(TickListener listener)

Removes a tick listener.

Parameters:

listener - the listener to remove

getCurrentTick

long getCurrentTick()

Returns the current tick.

Returns:

the current tick