io.jbotsim.core

Class ClockManager

java.lang.Object

io.jbotsim.core.ClockManager

public class ClockManager
extends Object

The ClockManager is used by the Topology object to implement its clock mechanism.

Method Summary

Modifier and Type	Method and Description
void	addClockListener(ClockListener listener) Registers the specified listener to every pulse of the clock.
void	addClockListener(ClockListener listener, int period) Registers the specified listener to the events of the clock.
int	currentTime() Returns the current round number.
Clock	getClock() Returns a reference to the Clock.
Class<? extends Clock>	getClockModel() Returns the clock model currently in use.
int	getTimeUnit() Returns the time unit of the clock, in milliseconds.
boolean	isRunning() Indicates whether the clock is currently running or paused.
void	onClock()
void	pause() Pauses the clock (or increments the pause counter).
void	removeClockListener(ClockListener listener) Unregisters the specified listener.
void	reset() Sets the clock time back to 0.
void	resume() Resumes the clock (or decrements the pause counter).
void	setClockModel(Class<? extends Clock> clockModel) Sets the clock model (to be instantiated automatically).
void	setTimeUnit(int timeUnit) Sets the time unit of the clock to the specified value in millisecond.
void	start() Starts the clock (if no model is set, DefaultClock is used).

Methods inherited from class java.lang.Object

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

Method Detail

onClock

public void onClock()

getClock

public Clock getClock()

Returns a reference to the Clock.

Returns:

a reference to the Clock.

getClockModel

public Class<? extends Clock> getClockModel()

Returns the clock model currently in use.

Returns:

the current clock model.

setClockModel

public void setClockModel(Class<? extends Clock> clockModel)

Sets the clock model (to be instantiated automatically).

Parameters:

clockModel - A class that extends JBotSim's abstract Clock

addClockListener

public void addClockListener(ClockListener listener,
                             int period)

Registers the specified listener to the events of the clock.

Parameters:

listener - The listener to register.

period - The desired period between consecutive onClock() events, in time units.

addClockListener

public void addClockListener(ClockListener listener)

Registers the specified listener to every pulse of the clock.

Parameters:

listener - The listener to register.

removeClockListener

public void removeClockListener(ClockListener listener)

Unregisters the specified listener. (The onClock() method of this listener will not longer be called.)

Parameters:

listener - The listener to unregister.

getTimeUnit

public int getTimeUnit()

Returns the time unit of the clock, in milliseconds. The time unit is the duration of a round.

Returns:

the time unit of the clock, in milliseconds.

setTimeUnit

public void setTimeUnit(int timeUnit)

Sets the time unit of the clock to the specified value in millisecond.

Parameters:

timeUnit - The desired time unit

currentTime

public int currentTime()

Returns the current round number.

Returns:

the current time.

start

public void start()

Starts the clock (if no model is set, DefaultClock is used).

isRunning

public boolean isRunning()

Indicates whether the clock is currently running or paused.

Returns:

true if running, false if paused or not started.

pause

public void pause()

Pauses the clock (or increments the pause counter).

resume

public void resume()

Resumes the clock (or decrements the pause counter).

reset

public void reset()

Sets the clock time back to 0.