io.jbotsim.core

Class Clock

java.lang.Object

io.jbotsim.core.Clock

Direct Known Subclasses:

DefaultClock, JClock

public abstract class Clock
extends Object

The abstract class Clock is used by the ClockManager to provide JBotSim with a clock mechanism.

A DefaultClock is provided, but each platform/implementation is able to use its own clock by subclassiong the Clock class.

Field Summary

Fields

Modifier and Type	Field and Description
protected ClockManager	manager

Constructor Summary

Constructors

Constructor and Description
Clock(ClockManager manager)

Method Summary

Modifier and Type	Method and Description
abstract int	getTimeUnit() Returns the time unit of the clock, in milliseconds.
abstract boolean	isRunning() Indicates whether the clock is currently running or paused.
abstract void	pause() Pauses the clock.
abstract void	resume() Resumes the clock if it was paused.
abstract void	setTimeUnit(int timeUnit) Sets the time unit of the clock to the specified value in millisecond.
abstract void	start() Starts the clock.

Methods inherited from class java.lang.Object

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

Field Detail

manager

protected ClockManager manager

Constructor Detail

Clock

public Clock(ClockManager manager)

Method Detail

getTimeUnit

public abstract 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 abstract void setTimeUnit(int timeUnit)

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

Parameters:

timeUnit - The desired time unit

isRunning

public abstract boolean isRunning()

Indicates whether the clock is currently running or paused.

Returns:

true if running, false if paused.

start

public abstract void start()

Starts the clock.

pause

public abstract void pause()

Pauses the clock.

resume

public abstract void resume()

Resumes the clock if it was paused.