org.jactr.tools.goalfeeder

Class GoalFeeder<T>

java.lang.Object

org.jactr.tools.goalfeeder.GoalFeeder<T>

public abstract class GoalFeeder<T>
extends java.lang.Object

The goal feeder is a support class to facilitate bridging experiments and models. This is to be used when your experiment cannot directly control the clock, or does not use common reality (which, if it did, it would have control of the clock).

It has a few elements: the goal feeder, goal constructors, goal responders, and respond action.

The goal feeder collects constructors and responders. it is responsible for inserting new goals into the model's goal buffer in response to some experimental component. The actual goal chunk is built by the goal constructor, using the experimental task.

When a model executes the respond action, the contents of the goal buffer are passed to the goal responders and one of them actually executes the specific response

The respond action expects that the goal feeder be attached to the runtime application data.

It is up to the modeler to ensure that nextGoal() is called. The idea is that the experiment will have some listener type interface, when a task is started, the listener will receive the notification and then fire nextGoal().

Where you really need to think is in the area of time control. Since the experiment does not control the clock, the model can run at break-neck speed before the experiment actually gets going. The solution to this is to use BlockingTimedEvents. These are inserted with each call to nextGoal(), the goal constructor can control how much time is permitted to elapse before the model is explicitly blocked to allow the experiment to catch up.

If your model just stops dead in its tracks, it's most likely because a goal constructor returned 0 for the maxTimeElapse when it should have returned something greater

Author:

harrison

Constructor Summary

Constructors

Constructor and Description
GoalFeeder(IModel model, boolean throwExceptionOnInvalidResponse) will call assembleConstructors, responders.

Method Summary

Modifier and Type	Method and Description
protected abstract java.util.Collection<IGoalInjector<T>>	assembleInjectors() instantiate all the constructors to be used to generate the goals
void	done() called when there is nothing left to do
IGoalInjector<T>	getInjector(T experimentTask) return the goal constructor that may be able to build a goal chunk for this task
IModel	getModel()
protected void	insertAndRelease(double maxTimeToElapse)
protected void	insertAndRelease(GatingTimedEvent gte)
IChunk	nextGoal(T experimentTask) Bug: currently will always return null until some more refactoring is done
protected void	release()
void	respond(IInstantiation instantiation) generate a response given this goal chunk
protected boolean	waitForModel() returns true if there was a gate to wait on

Methods inherited from class java.lang.Object

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

Constructor Detail

GoalFeeder

public GoalFeeder(IModel model,
                  boolean throwExceptionOnInvalidResponse)

will call assembleConstructors, responders. if block initially is true, an initial blocking timed event will be inserted to prevent the model from running beyond the first nextGoal call

Parameters:

model -

blockInitially -

Method Detail

done

public void done()

called when there is nothing left to do

getModel

public IModel getModel()

assembleInjectors

protected abstract java.util.Collection<IGoalInjector<T>> assembleInjectors()

instantiate all the constructors to be used to generate the goals

Returns:

getInjector

public IGoalInjector<T> getInjector(T experimentTask)

return the goal constructor that may be able to build a goal chunk for this task

Parameters:

experimentTask -

Returns:

can be null

nextGoal

public IChunk nextGoal(T experimentTask)

Bug: currently will always return null until some more refactoring is done

Parameters:

experimentTask -

Returns:

the goal chunk created and set or null

insertAndRelease

protected void insertAndRelease(double maxTimeToElapse)

insertAndRelease

protected void insertAndRelease(GatingTimedEvent gte)

release

protected void release()

waitForModel

protected boolean waitForModel()

returns true if there was a gate to wait on

Returns:

respond

public void respond(IInstantiation instantiation)

generate a response given this goal chunk

Parameters:

chunk -