org.jactr.tools.goalfeeder.timedevents

Class GatingTimedEvent

java.lang.Object

org.jactr.core.queue.timedevents.AbstractTimedEvent

org.jactr.tools.goalfeeder.timedevents.GatingTimedEvent

All Implemented Interfaces:

ITimedEvent

public class GatingTimedEvent
extends AbstractTimedEvent

Author:

harrison

Field Summary

Fields inherited from class org.jactr.core.queue.timedevents.AbstractTimedEvent

_endTime, _hasAborted, _hasFired, _startTime, _toString

Constructor Summary

Constructors

Constructor and Description
GatingTimedEvent(double start, double end)
GatingTimedEvent(double start, double end, java.lang.Object creator)
GatingTimedEvent(double start, double end, java.lang.Object creator, java.lang.Runnable onBlock)

Method Summary

Modifier and Type	Method and Description
void	abort() called when the event is to be aborted
void	fire(double now) called when this event should be fired..
java.lang.Object	getCreator()
boolean	isBlocked() is there currently a model blocked?
boolean	isExternalWaiting()
void	release() release the gate.
java.lang.String	toString() Description of the Method
void	waitForModel() wait until either release is called, or the model reaches fire.
boolean	willBlock() will a model reaching the fire method block?

Methods inherited from class org.jactr.core.queue.timedevents.AbstractTimedEvent

getEndTime, getStartTime, hasAborted, hasFired, setTimes, shouldWarnOnTimeSlips

Methods inherited from class java.lang.Object

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

Constructor Detail

GatingTimedEvent

public GatingTimedEvent(double start,
                        double end)

GatingTimedEvent

public GatingTimedEvent(double start,
                        double end,
                        java.lang.Object creator)

GatingTimedEvent

public GatingTimedEvent(double start,
                        double end,
                        java.lang.Object creator,
                        java.lang.Runnable onBlock)

Method Detail

getCreator

public java.lang.Object getCreator()

abort

public void abort()

Description copied from class: AbstractTimedEvent

called when the event is to be aborted

Specified by:

abort in interface ITimedEvent

Overrides:

abort in class AbstractTimedEvent

fire

public void fire(double now)

Description copied from class: AbstractTimedEvent

called when this event should be fired..

Specified by:

fire in interface ITimedEvent

Overrides:

fire in class AbstractTimedEvent

Parameters:

now - Description of the Parameter

waitForModel

public void waitForModel()
                  throws java.lang.InterruptedException

wait until either release is called, or the model reaches fire.

Throws:

java.lang.InterruptedException

isExternalWaiting

public boolean isExternalWaiting()

isBlocked

public boolean isBlocked()

is there currently a model blocked?

Returns:

willBlock

public boolean willBlock()

will a model reaching the fire method block?

Returns:

release

public void release()

release the gate. if the model is currently blocked, it will be signaled and permitted to run on. if it isnt blocked, when the model makes it to fire, it will pass over the blocking.

toString

public java.lang.String toString()

Description copied from class: AbstractTimedEvent

Description of the Method

Overrides:

toString in class AbstractTimedEvent

Returns:

Description of the Return Value