io.jbotsim.core

Class DefaultClock

java.lang.Object

io.jbotsim.core.Clock

io.jbotsim.core.DefaultClock

All Implemented Interfaces:

Runnable

public class DefaultClock
extends Clock
implements Runnable

The DefaultClock is JBotSim default implementation of the Clock.

Implementation remarks:

• It uses a Thread to perform the clock.
• The Thread will sleep for the specified time between each round.
• The Thread will keep the application alive until it is interrupted or the application is killed.

Field Summary

Fields inherited from class io.jbotsim.core.Clock

manager

Constructor Summary

Constructors

Constructor and Description
DefaultClock(ClockManager manager)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultClock

public DefaultClock(ClockManager manager)

Method Detail

getTimeUnit

public int getTimeUnit()

Description copied from class: Clock

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

Specified by:

getTimeUnit in class Clock

Returns:

the time unit of the clock, in milliseconds.

setTimeUnit

public void setTimeUnit(int delay)

Description copied from class: Clock

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

Specified by:

setTimeUnit in class Clock

Parameters:

delay - The desired time unit

isRunning

public boolean isRunning()

Description copied from class: Clock

Indicates whether the clock is currently running or paused.

Specified by:

isRunning in class Clock

Returns:

true if running, false if paused.

start

public void start()

Description copied from class: Clock

Starts the clock.

Specified by:

start in class Clock

pause

public void pause()

Description copied from class: Clock

Pauses the clock.

Specified by:

pause in class Clock

resume

public void resume()

Description copied from class: Clock

Resumes the clock if it was paused.

Specified by:

resume in class Clock

run

public void run()

Specified by:

run in interface Runnable