bdi4jade.plan

Class AbstractPlanBody

java.lang.Object

jade.core.behaviours.Behaviour

bdi4jade.plan.AbstractPlanBody

All Implemented Interfaces:

GoalListener, PlanBody, java.io.Serializable, java.util.EventListener

Direct Known Subclasses:

BeliefGoalPlanBody, ParallelGoalPlanBody, SequentialGoalPlanBody

public abstract class AbstractPlanBody
extends jade.core.behaviours.Behaviour
implements PlanBody

This class represents a plan that has been instantiated to be executed.

Author:

ingrid

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class jade.core.behaviours.Behaviour

jade.core.behaviours.Behaviour.RunnableChangedEvent

Field Summary

Fields inherited from class jade.core.behaviours.Behaviour

myAgent, myEvent, NOTIFY_DOWN, NOTIFY_UP, parent, STATE_BLOCKED, STATE_READY, STATE_RUNNING

Constructor Summary

Constructors

Constructor and Description
AbstractPlanBody() Creates a new plan body instance.

Method Summary

Modifier and Type	Method and Description
void	dispatchGoal(Goal goal) Dispatches a goal to be achieved.
void	dispatchProtectedGoal(Goal goal) Dispatches a goal to be achieved, using the capability (or its children capabilities) associated with the plan.
void	dispatchProtectedSubgoal(Goal subgoal) Dispatches a subgoal to be achieved, using the capability (or its children capabilities) associated with the plan.
void	dispatchProtectedSubgoalAndListen(Goal subgoal) Dispatches a subgoal to be achieved, using the capability (or its children capabilities) associated with the plan, and registers itself as a listener to receive a notification of the end of execution of the goal.
void	dispatchSubgoal(Goal subgoal) Dispatches a subgoal to be achieved.
void	dispatchSubgoalAndListen(Goal subgoal) Dispatches a subgoal to be achieved and registers itself as a listener to receive a notification of the end of execution of the goal.
boolean	done()
BeliefBase	getBeliefBase() Returns the belief base of the capability.
Plan.EndState	getEndState() Returns the end state of plan.
Goal	getGoal() Returns the goal to be achieved by this plan instance.
GoalEvent	getGoalEvent() Returns a goal event from the queue.
GoalEvent	getGoalEvent(boolean block) Returns a goal event from the queue.
GoalEvent	getGoalEvent(long ms) Returns a goal event from the queue.
Plan	getPlan() Returns the Plan that is associated with this plan instance.
void	goalPerformed(GoalEvent event) Notifies the listener that a goal that was performed.
void	init(Plan plan, Intention intention) Initializes this plan body.
protected void	setEndState(Plan.EndState endState)
void	start() Starts the plan body, a Behaviour, associated with this plan.
void	stop() Stops the plan body, a Behaviour, associated with this plan.

Methods inherited from class jade.core.behaviours.Behaviour

action, actionWrapper, block, block, getAgent, getBehaviourName, getDataStore, getExecutionState, getParent, getRestartCounter, handle, handleBlockEvent, handleRestartEvent, isRunnable, onEnd, onStart, reset, restart, root, setAgent, setBehaviourName, setDataStore, setExecutionState

Methods inherited from class java.lang.Object

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

Methods inherited from interface bdi4jade.plan.PlanBody

onEnd, onStart, reset, restart

Constructor Detail

AbstractPlanBody

public AbstractPlanBody()

Creates a new plan body instance.

Method Detail

dispatchGoal

public void dispatchGoal(Goal goal)

Dispatches a goal to be achieved.

Specified by:

dispatchGoal in interface PlanBody

Parameters:

goal - the goal to be dispatched.

dispatchProtectedGoal

public void dispatchProtectedGoal(Goal goal)

Dispatches a goal to be achieved, using the capability (or its children capabilities) associated with the plan.

Specified by:

dispatchProtectedGoal in interface PlanBody

Parameters:

goal - the goal to be dispatched.

dispatchProtectedSubgoal

public void dispatchProtectedSubgoal(Goal subgoal)

Dispatches a subgoal to be achieved, using the capability (or its children capabilities) associated with the plan.

Specified by:

dispatchProtectedSubgoal in interface PlanBody

Parameters:

subgoal - the subgoal to be dispatched.

dispatchProtectedSubgoalAndListen

public void dispatchProtectedSubgoalAndListen(Goal subgoal)

Dispatches a subgoal to be achieved, using the capability (or its children capabilities) associated with the plan, and registers itself as a listener to receive a notification of the end of execution of the goal.

Specified by:

dispatchProtectedSubgoalAndListen in interface PlanBody

Parameters:

subgoal - the subgoal to be dispatched.

dispatchSubgoal

public void dispatchSubgoal(Goal subgoal)

Dispatches a subgoal to be achieved.

Specified by:

dispatchSubgoal in interface PlanBody

Parameters:

subgoal - the subgoal to be dispatched.

dispatchSubgoalAndListen

public void dispatchSubgoalAndListen(Goal subgoal)

Dispatches a subgoal to be achieved and registers itself as a listener to receive a notification of the end of execution of the goal.

Specified by:

dispatchSubgoalAndListen in interface PlanBody

Parameters:

subgoal - the subgoal to be dispatched.

done

public final boolean done()

Specified by:

done in class jade.core.behaviours.Behaviour

getBeliefBase

public BeliefBase getBeliefBase()

Returns the belief base of the capability.

Specified by:

getBeliefBase in interface PlanBody

Returns:

the belief base containing the beliefs.

getEndState

public Plan.EndState getEndState()

Returns the end state of plan. A null value means that the plan is still in execution. If the plan body has come to an end state, it invokes the method to set the output parameters of the goal, in case the plan body implements the OutputPlanBody interface (this is invoked only once). If the plan body has come to an end state, it sets all of its subgoals as no longer desired, in case they are still trying to be achieved.

Specified by:

getEndState in interface PlanBody

Returns:

the end state of the plan.

getGoal

public final Goal getGoal()

Returns the goal to be achieved by this plan instance.

Specified by:

getGoal in interface PlanBody

Returns:

the goal.

getGoalEvent

public GoalEvent getGoalEvent()

Returns a goal event from the queue. If the queue is empty, the behavior associated with this plan instance is blocked.

Specified by:

getGoalEvent in interface PlanBody

Returns:

the goal event or null if the queue is empty.

getGoalEvent

public GoalEvent getGoalEvent(boolean block)

Returns a goal event from the queue. If the queue is empty, the behavior associated with this plan instance is going to be blocked if the parameter passed to this method is true.

Specified by:

getGoalEvent in interface PlanBody

Parameters:

block - true if the behavior must be blocked if the queue is empty.

Returns:

the goal event or null if the queue is empty.

getGoalEvent

public GoalEvent getGoalEvent(long ms)

Returns a goal event from the queue. If the queue is empty, the behavior associated with this plan instance is going to be blocked for the specified milliseconds.

Specified by:

getGoalEvent in interface PlanBody

Parameters:

ms - the maximum amount of time that the behavior must be blocked.

Returns:

the goal event or null if the queue is empty.

getPlan

public final Plan getPlan()

Returns the Plan that is associated with this plan instance.

Specified by:

getPlan in interface PlanBody

Returns:

the plan.

goalPerformed

public void goalPerformed(GoalEvent event)

Description copied from interface: GoalListener

Notifies the listener that a goal that was performed.

Specified by:

goalPerformed in interface GoalListener

Parameters:

event - the goal event that occurred.

See Also:

GoalListener.goalPerformed(bdi4jade.event.GoalEvent)

init

public final void init(Plan plan,
                       Intention intention)
                throws PlanInstantiationException

Initializes this plan body. It associates this plan body with a plan definition (Plan) and an Intention. If this plan body has already been initialized, this method throws a PlanInstantiationException. It also sets up the plan input parameters based on the goal input parameters.

Specified by:

init in interface PlanBody

Parameters:

plan - the plan associated this this plan body.

intention - the intention that this plan instance have to achieve.

Throws:

PlanBodyInstantiationException - if this plan body has already been initialized.

PlanInstantiationException

setEndState

protected final void setEndState(Plan.EndState endState)

Parameters:

endState - the endState to set

start

public final void start()

Starts the plan body, a Behaviour, associated with this plan.

Specified by:

start in interface PlanBody

stop

public final void stop()

Stops the plan body, a Behaviour, associated with this plan. If the body implements the DisposablePlanBody, it invokes the method to about the plan body, so it can perform finalizations.

Specified by:

stop in interface PlanBody