org.jactr.core.queue.timedevents

Class AbstractTimedEvent

java.lang.Object

org.jactr.core.queue.timedevents.AbstractTimedEvent

All Implemented Interfaces:

ITimedEvent

Direct Known Subclasses:

AbstractEfferentTimedEvent, BlockingTimedEvent, DelayedBufferInsertionTimedEvent, DelayedBufferRequestTimedEvent, DelayedIndirectBufferRequestTimedEvent, FutureChunkInsertionTimedEvent, FutureChunkPatternInsertionTimedEvent, GatingTimedEvent, ModifyAction.ModifyActionTimedEvent, MotorTimedEvent, ReencodingTimedEvent, RemoveAction.RemoveActionTimedEvent, RunnableTimedEvent, SetAction.SetActionTimedEvent, TerminationTimedEvent

public class AbstractTimedEvent
extends java.lang.Object
implements ITimedEvent

Description of the Class

Author:

harrison

Field Summary

Fields

Modifier and Type	Field and Description
protected double	_endTime Description of the Field
protected boolean	_hasAborted
protected boolean	_hasFired
protected double	_startTime Description of the Field
protected java.lang.String	_toString

Constructor Summary

Constructors

Constructor and Description
AbstractTimedEvent()
AbstractTimedEvent(double start, double end)

Method Summary

Modifier and Type	Method and Description
void	abort() called when the event is to be aborted
void	fire(double currentTime) called when this event should be fired..
double	getEndTime() When the event should be fired.
double	getStartTime() when the TimedEvent was posted in simulated time.
boolean	hasAborted() has this been aborted? aborted events will not be fired
boolean	hasFired()
void	setTimes(double start, double end) Sets the times attribute of the AbstractTimedEvent object
protected boolean	shouldWarnOnTimeSlips()
java.lang.String	toString() Description of the Method

Methods inherited from class java.lang.Object

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

Field Detail

_hasAborted

protected boolean _hasAborted

_hasFired

protected boolean _hasFired

_startTime

protected double _startTime

Description of the Field

_endTime

protected double _endTime

Description of the Field

_toString

protected java.lang.String _toString

Constructor Detail

AbstractTimedEvent

public AbstractTimedEvent()

AbstractTimedEvent

public AbstractTimedEvent(double start,
                          double end)

Method Detail

setTimes

public void setTimes(double start,
                     double end)

Sets the times attribute of the AbstractTimedEvent object

Parameters:

start - The new times value

end - The new times value

getStartTime

public double getStartTime()

when the TimedEvent was posted in simulated time.

Specified by:

getStartTime in interface ITimedEvent

Returns:

The startTime value

getEndTime

public double getEndTime()

When the event should be fired. When the model's simulated time has reached this point, the event will be fired by calling timeHasElapsed

Specified by:

getEndTime in interface ITimedEvent

Returns:

The endTime value

shouldWarnOnTimeSlips

protected boolean shouldWarnOnTimeSlips()

Returns:

fire

public void fire(double currentTime)

called when this event should be fired..

Specified by:

fire in interface ITimedEvent

Parameters:

currentTime - Description of the Parameter

hasFired

public boolean hasFired()

Specified by:

hasFired in interface ITimedEvent

abort

public void abort()

called when the event is to be aborted

Specified by:

abort in interface ITimedEvent

hasAborted

public boolean hasAborted()

Description copied from interface: ITimedEvent

has this been aborted? aborted events will not be fired

Specified by:

hasAborted in interface ITimedEvent

Returns:

toString

public java.lang.String toString()

Description of the Method

Overrides:

toString in class java.lang.Object

Returns:

Description of the Return Value