vona.time

Class PeriodicThread

java.lang.Object

java.lang.Thread

vona.time.PeriodicThread

All Implemented Interfaces:

java.lang.Runnable

public abstract class PeriodicThread
extends java.lang.Thread

Vona's utils: a periodic thread.

A daemon thread that calls update(double, double) at period no greater than updateTime.

Copyright (C) 2004 Marsette A. Vona, III

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Author:

Marsette (Marty) A. Vona, III

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected Clock	clock The timebase.
protected boolean	continueOnInterrupt Whether this thread should continue looping if it's interrupt()ed.
(package private) static java.lang.String	cvsid CVS id.
protected boolean	forceOngoing Whether a forceUpdate() is ongoing.
protected boolean	killOngoing Whether a kill() is ongoing.
protected double	lastTime The last time we updated, or when we were constructed if we haven't updated yet.
protected boolean	running Whether this PeriodicThread is currently running.
protected double	updateTime The update time in accelseconds.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
PeriodicThread(Clock clock, double updateTime) Create a new PeriodicThread, not started.

Method Summary

Methods

Modifier and Type	Method and Description
void	forceUpdate() Force an update.
double	getUpdateTime() Get update time in seconds.
void	interrupt() Extends default impl to behave even if called while an update is being forced.
boolean	isContinueOnInterrupt() Whether to continue if this thread is interrupted.
void	kill() Kill this thread.
void	run() Update repeatedly at period no greater than updateTime.
void	setContinueOnInterrupt(boolean continueOnInterrupt) Set whether to continue if this thread is interrupted.
void	setUpdateTime(double updateTime) Set update time in seconds.
abstract void	update(double time, double dt) Will be called at period no greater than the update frequency .

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Field Detail

cvsid

static final java.lang.String cvsid

CVS id.

See Also:

Constant Field Values

clock

protected Clock clock

The timebase.

updateTime

protected double updateTime

The update time in accelseconds.

lastTime

protected double lastTime

The last time we updated, or when we were constructed if we haven't updated yet.

forceOngoing

protected boolean forceOngoing

Whether a forceUpdate() is ongoing.

killOngoing

protected boolean killOngoing

Whether a kill() is ongoing.

running

protected boolean running

Whether this PeriodicThread is currently running.

continueOnInterrupt

protected boolean continueOnInterrupt

Whether this thread should continue looping if it's interrupt()ed.

Constructor Detail

PeriodicThread

public PeriodicThread(Clock clock,
              double updateTime)

Create a new PeriodicThread, not started.

Parameters:

clock - the timebase to use

updateTime - update time in seconds, non-negative

Method Detail

update

public abstract void update(double time,
          double dt)

Will be called at period no greater than the update frequency .

Parameters:

time - the time at call

dt - the time since last call (on first call, since construction)

isContinueOnInterrupt

public boolean isContinueOnInterrupt()

Whether to continue if this thread is interrupted.

Returns:

true iff this thread should continue if interrupted

setContinueOnInterrupt

public void setContinueOnInterrupt(boolean continueOnInterrupt)

Set whether to continue if this thread is interrupted.

Parameters:

continueOnInterrupt - whether this thread should continue if interrupted

setUpdateTime

public void setUpdateTime(double updateTime)

Set update time in seconds.

Parameters:

updateTime - update time in seconds, non-negative

getUpdateTime

public double getUpdateTime()

Get update time in seconds.

Returns:

update time in seconds

forceUpdate

public void forceUpdate()

Force an update.

Does nothing if this PeriodicThread is not currently running.

interrupt

public void interrupt()

Extends default impl to behave even if called while an update is being forced.

Overrides:

interrupt in class java.lang.Thread

kill

public void kill()

Kill this thread.

Does nothing if this PeriodicThread is not currently running.

run

public void run()

Update repeatedly at period no greater than updateTime.

Based entirely on Clock.getCurrentTime().

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread