com.corajr.loom.time

Class Scheduler

java.lang.Object

com.corajr.loom.time.Scheduler

Direct Known Subclasses:

NonRealTimeScheduler, RealTimeScheduler

public abstract class Scheduler
extends Object

The base class for schedulers in Loom.

Author:

corajr

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Scheduler.State The state of the scheduler.

Field Summary

Fields

Modifier and Type	Field and Description
static BigFraction	DEFAULT_RESOLUTION One millisecond at standard playback speed.

Constructor Summary

Constructors

Constructor and Description
Scheduler()

Method Summary

Modifier and Type	Method and Description
Interval	getCurrentInterval() Retrieves an Interval that extends before and after the current instant by half the minimum resolution.
abstract long	getElapsedMillis() Implementations of the Scheduler class must provide the present time when queried.
BigFraction	getHalfMinimum()
BigFraction	getMinimumResolution()
BigFraction	getNow() Returns the current time in milliseconds divided by the period.
PatternCollection	getPatternsWithActiveMappings() Retrieve the patterns that we must query for callbacks.
long	getPeriod()
void	pause() Pause playback.
void	play() Start playback.
void	setPatterns(PatternCollection patterns) Sets the PatternCollection associated with this scheduler, needs for active mappings.
void	setPeriod(long periodMillis) Sets the period of the scheduler.
void	stop() Stop playback.
void	update() Runs all callbacks associated with the current interval.
void	updateFor(Interval interval) Runs all callbacks for a given interval.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RESOLUTION

public static final BigFraction DEFAULT_RESOLUTION

One millisecond at standard playback speed.

Constructor Detail

Scheduler

public Scheduler()

Method Detail

getElapsedMillis

public abstract long getElapsedMillis()

Implementations of the Scheduler class must provide the present time when queried.

Returns:

the number of milliseconds elapsed

getNow

public BigFraction getNow()

Returns the current time in milliseconds divided by the period.

Returns:

the present moment as a fraction of a cycle

getCurrentInterval

public Interval getCurrentInterval()

Retrieves an Interval that extends before and after the current instant by half the minimum resolution.

Returns:

an interval

play

public void play()

Start playback. Must be called before querying the scheduler!

pause

public void pause()

Pause playback.

stop

public void stop()

Stop playback. Additional queries to the scheduler will throw an exception until play() is called again.

getPeriod

public long getPeriod()

getMinimumResolution

public BigFraction getMinimumResolution()

getHalfMinimum

public BigFraction getHalfMinimum()

setPeriod

public void setPeriod(long periodMillis)

Sets the period of the scheduler.

Parameters:

periodMillis - the new period

update

public void update()

Runs all callbacks associated with the current interval.

updateFor

public void updateFor(Interval interval)

Runs all callbacks for a given interval. If a pattern is made of discrete events, the callback for each event will be called individually. For a continuous pattern, only one callback will be called.

Parameters:

interval - the interval over which to run callbacks

getPatternsWithActiveMappings

public PatternCollection getPatternsWithActiveMappings()

Retrieve the patterns that we must query for callbacks.

Returns:

the patterns that have external mappings

setPatterns

public void setPatterns(PatternCollection patterns)

Sets the PatternCollection associated with this scheduler, needs for active mappings.

Parameters:

patterns - the patterns to manage with this scheduler