jadex.bdi.runtime

Class Plan

java.lang.Object

jadex.bdi.runtime.impl.AbstractPlan

jadex.bdi.runtime.Plan

All Implemented Interfaces:

ISuspendable, Serializable

Direct Known Subclasses:

AbstractInitiatorPlan, AbstractReceiverPlan, AnswerPingPlan, CMApproveCancelPlan, CMHandlerPlan, CMInitiatorPlan, CMSCreateComponentPlan, CMSDestroyComponentPlan, CMSLocalCreateComponentPlan, CMSLocalDestroyComponentPlan, CMSLocalGetExternalAccessPlan, CMSLocalResumeComponentPlan, CMSLocalSearchComponentsPlan, CMSLocalShutdownPlatformPlan, CMSLocalSuspendComponentPlan, CMSLocalUpdateComponentsPlan, CMSRemoteCreateComponentPlan, CMSRemoteDestroyComponentPlan, CMSRemoteResumeComponentPlan, CMSRemoteSearchComponentsPlan, CMSRemoteShutdownPlatformPlan, CMSRemoteSuspendComponentPlan, CMSResumeComponentPlan, CMSSearchComponentsPlan, CMSShutdownPlatformPlan, CMSSuspendComponentPlan, CNPEvaluateProposalsPlan, CNPQueryNextroundInfoPlan, DFDeregisterPlan, DFLocalDeregisterPlan, DFLocalModifyPlan, DFLocalRegisterPlan, DFLocalSearchPlan, DFModifyPlan, DFRegisterPlan, DFRemoteDeregisterPlan, DFRemoteModifyPlan, DFRemoteRegisterPlan, DFRemoteSearchPlan, DFSearchPlan, DoPingPlan, FinishedPlan, InteractionGoalCreationPlan, NotifyAdminPlan, NotUnderstoodPlan, ObserveAgentPlan, ParallelActivationPlan, PingingPlan, SendEmailPlan, SendICQPlan, SendXMPPPlan, SequentialActivationPlan, SPHandleUpdatePlan, SPInitiationPlan, SPReceptionPlan, SPSubmitUpdatePlan, StartAndMonitorProcessPlan

public abstract class Plan
extends AbstractPlan
implements ISuspendable

A plan (in our context more a plan body) contains actions e.g. for accomplishing a target state.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Plan.SyncResultListener Listener that uses the suspend/resume capability of threaded plans.

Field Summary

Fields inherited from class jadex.bdi.runtime.impl.AbstractPlan

planinit

Fields inherited from interface jadex.commons.future.ISuspendable

SUSPENDABLE

Constructor Summary

Constructors

Constructor and Description
Plan()

Method Summary

Methods

Modifier and Type	Method and Description
void	aborted() The plan was aborted (because of conditional goal success or termination from outside).
abstract void	body() The body method is called on the instantiated plan instance from the scheduler.
IWaitAbstraction	createWaitAbstraction() Create a new wait abstraction.
void	dispatchSubgoalAndWait(IGoal subgoal) A shortcut for dispatching a goal as subgoal of the active goal,, and waiting for the subgoal to be finished (without timout).
void	dispatchSubgoalAndWait(IGoal subgoal, long timeout) A shortcut for dispatching a goal as subgoal of the active goal and waiting for the subgoal to be finished.
void	failed() The failed method is called on plan failure/abort.
Object	getMonitor() Get the monitor for waiting.
boolean	isEventRegisteredInWaitqueue(Object rmevent) Test if a message event has been registered at the waitqueue.
void	passed() The passed method is called on plan success.
void	resume(Future<?> future) Resume the execution of the plan.
IMessageEvent	sendMessageAndWait(IMessageEvent me) Send a message and wait for the answer.
IMessageEvent	sendMessageAndWait(IMessageEvent me, long timeout) Send a message and wait for the answer.
IMessageEvent	sendMessageAndWait(IMessageEvent me, long timeout, byte[] codecids) Send a message and wait for the answer.
void	suspend(Future<?> future, long timeout) Suspend the execution of the plan.
void	waitFor(long duration) Wait for a some time.
void	waitForCondition(String condition) Wait for a condition to be satisfied.
void	waitForCondition(String condition, long timeout) Wait for a condition to be satisfied.
void	waitForEver() Halt the plan.
void	waitForExternalCondition(IExternalCondition condition) Wait for an external condition
void	waitForExternalCondition(IExternalCondition condition, long timeout) Wait for an external condition
Object	waitForFactAdded(String beliefset) Wait for a belief set fact addition.
Object	waitForFactAdded(String beliefset, long timeout) Wait for a belief (set) fact change.
Object	waitForFactAddedOrRemoved(String beliefset) Wait for a belief set fact addition or removal.
Object	waitForFactAddedOrRemoved(String beliefset, long timeout) Wait for a belief (set) fact addition or removal.
Object	waitForFactChanged(String belief) Wait for a belief (set) fact change.
Object	waitForFactChanged(String belief, long timeout) Wait for a belief (set) fact change.
Object	waitForFactRemoved(String beliefset) Wait for a belief set fact removal.
Object	waitForFactRemoved(String beliefset, long timeout) Wait for a belief (set) fact change.
void	waitForGoal(IGoal goal) Wait for a goal.
void	waitForGoal(IGoal goal, long timeout) Wait for a goal.
IGoal	waitForGoal(String type) Wait for a goal.
IGoal	waitForGoal(String type, long timeout) Wait for a goal.
IInternalEvent	waitForInternalEvent(String type) Wait for an internal event.
IInternalEvent	waitForInternalEvent(String type, long timeout) Wait for an internal event.
IMessageEvent	waitForMessageEvent(String type) Wait for a message event.
IMessageEvent	waitForMessageEvent(String type, long timeout) Wait for a message event.
IMessageEvent	waitForReply(IMessageEvent msgevent) Wait for a message.
IMessageEvent	waitForReply(IMessageEvent msgevent, long timeout) Wait for a message.
void	waitForTick() Wait for a clock tick.
void	waitForWaitAbstraction(IWaitAbstraction waitabs) Wait for a wait abstraction.
Object	waitForWaitAbstraction(IWaitAbstraction waitabs, long timeout) Wait for a wait abstraction.

Methods inherited from class jadex.bdi.runtime.impl.AbstractPlan

createExpression, createExpression, createGoal, createInternalEvent, createMessageEvent, createResultListener, createResultListener, dispatchInternalEvent, dispatchSubgoal, dispatchTopLevelGoal, endAtomic, fail, fail, fail, getBeliefbase, getBody, getClock, getComponentDescription, getComponentIdentifier, getComponentName, getDispatchedElement, getEventbase, getException, getExpression, getExpressionbase, getExternalAccess, getGoalbase, getInterpreter, getLifecycleState, getLogger, getParameter, getParameters, getParameterSet, getParameterSets, getPlanbase, getPlanElement, getReason, getScope, getServiceContainer, getState, getTime, getType, getWaitqueue, hasParameter, hasParameterSet, killAgent, sendMessage, sendMessage, startAtomic, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Plan

public Plan()

Method Detail

body

public abstract void body()

The body method is called on the instantiated plan instance from the scheduler.

passed

public void passed()

The passed method is called on plan success.

failed

public void failed()

The failed method is called on plan failure/abort.

aborted

public void aborted()

The plan was aborted (because of conditional goal success or termination from outside).

createWaitAbstraction

public IWaitAbstraction createWaitAbstraction()

Create a new wait abstraction.

Returns:

The wait abstraction.

waitFor

public void waitFor(long duration)

Wait for a some time.

Parameters:

duration - The duration.

waitForWaitAbstraction

public void waitForWaitAbstraction(IWaitAbstraction waitabs)

Wait for a wait abstraction.

waitForEver

public void waitForEver()

Halt the plan. The plan will remain in the agent until it is aborted.

waitForTick

public void waitForTick()

Wait for a clock tick. todo: @param num The number of ticks?

waitForCondition

public void waitForCondition(String condition)

Wait for a condition to be satisfied.

Parameters:

condition - The condition.

waitForCondition

public void waitForCondition(String condition,
                    long timeout)

Wait for a condition to be satisfied.

Parameters:

condition - The condition.

dispatchSubgoalAndWait

public void dispatchSubgoalAndWait(IGoal subgoal)

A shortcut for dispatching a goal as subgoal of the active goal,, and waiting for the subgoal to be finished (without timout).

Parameters:

subgoal - The new subgoal.

Throws:

GoalFailureException - when the goal fails.

dispatchSubgoalAndWait

public void dispatchSubgoalAndWait(IGoal subgoal,
                          long timeout)

A shortcut for dispatching a goal as subgoal of the active goal and waiting for the subgoal to be finished. Additionally the subgoal will be dropped when finished. This differs from the dispatchSubgoal implementation.

Parameters:

subgoal - The new subgoal.

timeout - The timeout.

Throws:

GoalFailureException - when the goal fails.

waitForInternalEvent

public IInternalEvent waitForInternalEvent(String type)

Wait for an internal event.

Parameters:

type - The internal event type.

waitForInternalEvent

public IInternalEvent waitForInternalEvent(String type,
                                  long timeout)

Wait for an internal event.

Parameters:

type - The internal event type.

timeout - The timeout.

sendMessageAndWait

public IMessageEvent sendMessageAndWait(IMessageEvent me)

Send a message and wait for the answer.

Parameters:

me - The message event.

Returns:

The result event.

sendMessageAndWait

public IMessageEvent sendMessageAndWait(IMessageEvent me,
                               long timeout)

Send a message and wait for the answer. Adds a reply_with entry if not present, for tracking the conversation.

Parameters:

me - The message event.

timeout - The timeout.

Returns:

The result event.

sendMessageAndWait

public IMessageEvent sendMessageAndWait(IMessageEvent me,
                               long timeout,
                               byte[] codecids)

Send a message and wait for the answer. Adds a reply_with entry if not present, for tracking the conversation.

Parameters:

me - The message event.

timeout - The timeout.

Returns:

The result event.

waitForMessageEvent

public IMessageEvent waitForMessageEvent(String type)

Wait for a message event.

Parameters:

type - The message event type.

waitForMessageEvent

public IMessageEvent waitForMessageEvent(String type,
                                long timeout)

Wait for a message event.

Parameters:

type - The message event type.

timeout - The timeout.

waitForReply

public IMessageEvent waitForReply(IMessageEvent msgevent)

Wait for a message.

Parameters:

msgevent - The message event.

waitForReply

public IMessageEvent waitForReply(IMessageEvent msgevent,
                         long timeout)

Wait for a message.

Parameters:

msgevent - The message event.

waitForGoal

public IGoal waitForGoal(String type)

Wait for a goal.

Parameters:

type - The goal type.

waitForGoal

public IGoal waitForGoal(String type,
                long timeout)

Wait for a goal.

Parameters:

type - The goal type.

timeout - The timeout.

waitForGoal

public void waitForGoal(IGoal goal)

Wait for a goal.

Parameters:

goal - The goal.

waitForGoal

public void waitForGoal(IGoal goal,
               long timeout)

Wait for a goal.

Parameters:

goal - The goal.

timeout - The timeout.

waitForFactChanged

public Object waitForFactChanged(String belief)

Wait for a belief (set) fact change.

Parameters:

belief - The belief (set) type.

Returns:

The changed fact value.

waitForFactChanged

public Object waitForFactChanged(String belief,
                        long timeout)

Wait for a belief (set) fact change.

Parameters:

belief - The belief (set) type.

timeout - The timeout.

Returns:

The changed fact.

waitForFactAdded

public Object waitForFactAdded(String beliefset)

Wait for a belief set fact addition.

Parameters:

beliefset - The belief set type.

Returns:

The added fact value.

waitForFactAdded

public Object waitForFactAdded(String beliefset,
                      long timeout)

Wait for a belief (set) fact change.

Parameters:

beliefset - The belief (set) type.

timeout - The timeout.

Returns:

The changed fact.

waitForFactRemoved

public Object waitForFactRemoved(String beliefset)

Wait for a belief set fact removal.

Parameters:

beliefset - The belief set type.

Returns:

The added fact value.

waitForFactRemoved

public Object waitForFactRemoved(String beliefset,
                        long timeout)

Wait for a belief (set) fact change.

Parameters:

beliefset - The belief (set) type.

timeout - The timeout.

Returns:

The changed fact.

waitForFactAddedOrRemoved

public Object waitForFactAddedOrRemoved(String beliefset)

Wait for a belief set fact addition or removal.

Parameters:

beliefset - The belief set type.

Returns:

The added fact value.

waitForFactAddedOrRemoved

public Object waitForFactAddedOrRemoved(String beliefset,
                               long timeout)

Wait for a belief (set) fact addition or removal.

Parameters:

beliefset - The belief (set) type.

timeout - The timeout.

Returns:

The changed fact.

waitForExternalCondition

public void waitForExternalCondition(IExternalCondition condition)

Wait for an external condition

Parameters:

condition - The external condition.

waitForExternalCondition

public void waitForExternalCondition(IExternalCondition condition,
                            long timeout)

Wait for an external condition

Parameters:

condition - The external condition.

timeout - The timeout.

isEventRegisteredInWaitqueue

public boolean isEventRegisteredInWaitqueue(Object rmevent)

Test if a message event has been registered at the waitqueue.

Parameters:

msgevent - The message event.

Returns:

True, if is registered.

waitForWaitAbstraction

public Object waitForWaitAbstraction(IWaitAbstraction waitabs,
                            long timeout)

Wait for a wait abstraction.

Returns:

The dispatched element.

suspend

public void suspend(Future<?> future,
           long timeout)

Suspend the execution of the plan.

Specified by:

suspend in interface ISuspendable

Parameters:

timeout - The timeout.

future - The future to wait for.

resume

public void resume(Future<?> future)

Resume the execution of the plan.

Specified by:

resume in interface ISuspendable

Parameters:

future - The future that issues the resume.

getMonitor

public Object getMonitor()

Get the monitor for waiting.

Specified by:

getMonitor in interface ISuspendable

Returns:

The monitor.