<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0) on Sat Sep 13 16:54:22 BRT 2014 -->
<title>PlanBody</title>
<meta name="date" content="2014-09-13">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PlanBody";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PlanBody.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../bdi4jade/plan/planbody/ParallelGoalPlanBody.html" title="class in bdi4jade.plan.planbody"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../bdi4jade/plan/planbody/SequentialActionPlanBody.html" title="class in bdi4jade.plan.planbody"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?bdi4jade/plan/planbody/PlanBody.html" target="_top">Frames</a></li>
<li><a href="PlanBody.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">bdi4jade.plan.planbody</div>
<h2 title="Interface PlanBody" class="title">Interface PlanBody</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>java.util.EventListener, <a href="../../../bdi4jade/event/GoalListener.html" title="interface in bdi4jade.event">GoalListener</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../bdi4jade/plan/planbody/AbstractPlanBody.html" title="class in bdi4jade.plan.planbody">AbstractPlanBody</a>, <a href="../../../bdi4jade/plan/planbody/BeliefGoalPlanBody.html" title="class in bdi4jade.plan.planbody">BeliefGoalPlanBody</a>, <a href="../../../bdi4jade/plan/planbody/FSMPlanBody.html" title="class in bdi4jade.plan.planbody">FSMPlanBody</a>, <a href="../../../bdi4jade/plan/planbody/ParallelActionPlanBody.html" title="class in bdi4jade.plan.planbody">ParallelActionPlanBody</a>, <a href="../../../bdi4jade/plan/planbody/ParallelGoalPlanBody.html" title="class in bdi4jade.plan.planbody">ParallelGoalPlanBody</a>, <a href="../../../bdi4jade/plan/planbody/SequentialActionPlanBody.html" title="class in bdi4jade.plan.planbody">SequentialActionPlanBody</a>, <a href="../../../bdi4jade/plan/planbody/SequentialGoalPlanBody.html" title="class in bdi4jade.plan.planbody">SequentialGoalPlanBody</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">PlanBody</span>
extends <a href="../../../bdi4jade/event/GoalListener.html" title="interface in bdi4jade.event">GoalListener</a></pre>
<div class="block">This interface defines a plan body, which specifies a set of steps to achieve
a goal. It is part of a <a href="../../../bdi4jade/plan/Plan.html" title="interface in bdi4jade.plan"><code>Plan</code></a>, which in turn specifies different
properties such as the goals that a plan can achieve or messages it can
process. When a plan should be executed, a plan body is instantiated and run.
A plan body is a <a href="../../../bdi4jade/event/GoalListener.html" title="interface in bdi4jade.event"><code>GoalListener</code></a> as it may dispatch goals during its
execution and be notified when it is achieved (or learn it is not possible to
achieve it).</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Ingrid Nunes</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../bdi4jade/plan/planbody/PlanBody.html#dispatchGoal-bdi4jade.goal.Goal-">dispatchGoal</a></span>(<a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goal)</code>
<div class="block">Dispatches a goal to be achieved.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../bdi4jade/plan/planbody/PlanBody.html#dispatchSubgoal-bdi4jade.goal.Goal-">dispatchSubgoal</a></span>(<a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> subgoal)</code>
<div class="block">Dispatches a subgoal to be achieved.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../bdi4jade/plan/planbody/PlanBody.html#dispatchSubgoalAndListen-bdi4jade.goal.Goal-">dispatchSubgoalAndListen</a></span>(<a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> subgoal)</code>
<div class="block">Dispatches a subgoal to be achieved and registers itself as a listener to
receive a notification of the end of execution of the goal.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../bdi4jade/belief/BeliefBase.html" title="class in bdi4jade.belief">BeliefBase</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../bdi4jade/plan/planbody/PlanBody.html#getBeliefBase--">getBeliefBase</a></span>()</code>
<div class="block">Returns the belief base of the capability associated with the plan of
this plan body.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../bdi4jade/plan/planbody/PlanBody.html#getCapability--">getCapability</a></span>()</code>
<div class="block">Returns the capability associated with the plan of this plan body.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../bdi4jade/plan/Plan.EndState.html" title="enum in bdi4jade.plan">Plan.EndState</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../bdi4jade/plan/planbody/PlanBody.html#getEndState--">getEndState</a></span>()</code>
<div class="block">Returns the end state of the execution of this plan.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../bdi4jade/plan/planbody/PlanBody.html#getGoal--">getGoal</a></span>()</code>
<div class="block">Returns the goal to be achieved by this plan body.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../bdi4jade/event/GoalEvent.html" title="class in bdi4jade.event">GoalEvent</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../bdi4jade/plan/planbody/PlanBody.html#getGoalEvent--">getGoalEvent</a></span>()</code>
<div class="block">Returns a goal event from the queue.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../bdi4jade/event/GoalEvent.html" title="class in bdi4jade.event">GoalEvent</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../bdi4jade/plan/planbody/PlanBody.html#getGoalEvent-boolean-">getGoalEvent</a></span>(boolean block)</code>
<div class="block">Returns a goal event from the queue.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../bdi4jade/event/GoalEvent.html" title="class in bdi4jade.event">GoalEvent</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../bdi4jade/plan/planbody/PlanBody.html#getGoalEvent-long-">getGoalEvent</a></span>(long ms)</code>
<div class="block">Returns a goal event from the queue.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../bdi4jade/plan/Plan.html" title="interface in bdi4jade.plan">Plan</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../bdi4jade/plan/planbody/PlanBody.html#getPlan--">getPlan</a></span>()</code>
<div class="block">Returns the <a href="../../../bdi4jade/plan/Plan.html" title="interface in bdi4jade.plan"><code>Plan</code></a> that is associated with this plan instance.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../bdi4jade/plan/planbody/PlanBody.html#init-bdi4jade.plan.Plan-bdi4jade.core.Intention-">init</a></span>(<a href="../../../bdi4jade/plan/Plan.html" title="interface in bdi4jade.plan">Plan</a> plan,
<a href="../../../bdi4jade/core/Intention.html" title="class in bdi4jade.core">Intention</a> intention)</code>
<div class="block">Initializes this plan body.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../bdi4jade/plan/planbody/PlanBody.html#onEnd--">onEnd</a></span>()</code>
<div class="block">This method is invoked just once after this behaviour has ended.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../bdi4jade/plan/planbody/PlanBody.html#onStart--">onStart</a></span>()</code>
<div class="block">This method is executed just once before starting this plan body
execution.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../bdi4jade/plan/planbody/PlanBody.html#reset--">reset</a></span>()</code>
<div class="block">Restores plan body initial state.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../bdi4jade/plan/planbody/PlanBody.html#start--">start</a></span>()</code>
<div class="block">Starts the execution of a plan body, a <code>Behaviour</code>, associated with
this plan.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../bdi4jade/plan/planbody/PlanBody.html#stop--">stop</a></span>()</code>
<div class="block">Stops the plan body, a <code>Behaviour</code>, associated with this plan.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.bdi4jade.event.GoalListener">
<!-- -->
</a>
<h3>Methods inherited from interface bdi4jade.event.<a href="../../../bdi4jade/event/GoalListener.html" title="interface in bdi4jade.event">GoalListener</a></h3>
<code><a href="../../../bdi4jade/event/GoalListener.html#goalPerformed-bdi4jade.event.GoalEvent-">goalPerformed</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="dispatchGoal-bdi4jade.goal.Goal-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dispatchGoal</h4>
<pre>boolean dispatchGoal(<a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goal)</pre>
<div class="block">Dispatches a goal to be achieved. It is added as a top level agent goal,
that is, the dispatched goal is independent of the goal that this plan
body is trying to achieve.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>goal</code> - the goal to be dispatched.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the goal could be dispatched, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="dispatchSubgoal-bdi4jade.goal.Goal-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dispatchSubgoal</h4>
<pre>boolean dispatchSubgoal(<a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> subgoal)</pre>
<div class="block">Dispatches a subgoal to be achieved. Dispatched subgoals are goals of an
agent as long as the plan body that dispatched it is being executed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>subgoal</code> - the subgoal to be dispatched.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the goal could be dispatched, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="dispatchSubgoalAndListen-bdi4jade.goal.Goal-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dispatchSubgoalAndListen</h4>
<pre>boolean dispatchSubgoalAndListen(<a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> subgoal)</pre>
<div class="block">Dispatches a subgoal to be achieved and registers itself as a listener to
receive a notification of the end of execution of the goal.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>subgoal</code> - the subgoal to be dispatched.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the goal could be dispatched, false otherwise.</dd>
</dl>
</li>
</ul>
<a name="getBeliefBase--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBeliefBase</h4>
<pre><a href="../../../bdi4jade/belief/BeliefBase.html" title="class in bdi4jade.belief">BeliefBase</a> getBeliefBase()</pre>
<div class="block">Returns the belief base of the capability associated with the plan of
this plan body.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the belief base containing the capability beliefs.</dd>
</dl>
</li>
</ul>
<a name="getCapability--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCapability</h4>
<pre><a href="../../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a> getCapability()</pre>
<div class="block">Returns the capability associated with the plan of this plan body.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the capability.</dd>
</dl>
</li>
</ul>
<a name="getEndState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEndState</h4>
<pre><a href="../../../bdi4jade/plan/Plan.EndState.html" title="enum in bdi4jade.plan">Plan.EndState</a> getEndState()</pre>
<div class="block">Returns the end state of the execution of this plan.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the end state of this plan, or null if it has not finished yet.</dd>
</dl>
</li>
</ul>
<a name="getGoal--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGoal</h4>
<pre><a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> getGoal()</pre>
<div class="block">Returns the goal to be achieved by this plan body.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the goal.</dd>
</dl>
</li>
</ul>
<a name="getGoalEvent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGoalEvent</h4>
<pre><a href="../../../bdi4jade/event/GoalEvent.html" title="class in bdi4jade.event">GoalEvent</a> getGoalEvent()</pre>
<div class="block">Returns a goal event from the queue. If the queue is empty, the behavior
associated with this plan instance is blocked.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the goal event or null if the queue is empty.</dd>
</dl>
</li>
</ul>
<a name="getGoalEvent-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGoalEvent</h4>
<pre><a href="../../../bdi4jade/event/GoalEvent.html" title="class in bdi4jade.event">GoalEvent</a> getGoalEvent(boolean block)</pre>
<div class="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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>block</code> - true if the behavior must be blocked if the queue is empty.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the goal event or null if the queue is empty.</dd>
</dl>
</li>
</ul>
<a name="getGoalEvent-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGoalEvent</h4>
<pre><a href="../../../bdi4jade/event/GoalEvent.html" title="class in bdi4jade.event">GoalEvent</a> getGoalEvent(long ms)</pre>
<div class="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 for the
specified milliseconds.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ms</code> - the maximum amount of time that the behavior must be blocked.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the goal event or null if the queue is empty.</dd>
</dl>
</li>
</ul>
<a name="getPlan--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlan</h4>
<pre><a href="../../../bdi4jade/plan/Plan.html" title="interface in bdi4jade.plan">Plan</a> getPlan()</pre>
<div class="block">Returns the <a href="../../../bdi4jade/plan/Plan.html" title="interface in bdi4jade.plan"><code>Plan</code></a> that is associated with this plan instance.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the plan.</dd>
</dl>
</li>
</ul>
<a name="init-bdi4jade.plan.Plan-bdi4jade.core.Intention-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>void init(<a href="../../../bdi4jade/plan/Plan.html" title="interface in bdi4jade.plan">Plan</a> plan,
<a href="../../../bdi4jade/core/Intention.html" title="class in bdi4jade.core">Intention</a> intention)
throws <a href="../../../bdi4jade/exception/PlanInstantiationException.html" title="class in bdi4jade.exception">PlanInstantiationException</a></pre>
<div class="block">Initializes this plan body. It associates this plan body with a plan
definition (<a href="../../../bdi4jade/plan/Plan.html" title="interface in bdi4jade.plan"><code>Plan</code></a>) and an <a href="../../../bdi4jade/core/Intention.html" title="class in bdi4jade.core"><code>Intention</code></a>. If this plan body has
already been initialized, this method throws a
<a href="../../../bdi4jade/exception/PlanInstantiationException.html" title="class in bdi4jade.exception"><code>PlanInstantiationException</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>plan</code> - the plan associated this this plan body.</dd>
<dd><code>intention</code> - the intention that this plan instance have to achieve.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../bdi4jade/exception/PlanInstantiationException.html" title="class in bdi4jade.exception">PlanInstantiationException</a></code> - if this plan body has already been initialized.</dd>
</dl>
</li>
</ul>
<a name="onEnd--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onEnd</h4>
<pre>int onEnd()</pre>
<div class="block">This method is invoked just once after this behaviour has ended.
Therefore, it acts as an epilog for the task represented by this plan
body. Note that onEnd is called after the plan body has already stopped
its execution.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an integer code representing the termination value of the
behaviour.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Behaviour.onEnd()</code>,
<code>Behaviour.onEnd()</code></dd>
</dl>
</li>
</ul>
<a name="onStart--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onStart</h4>
<pre>void onStart()</pre>
<div class="block">This method is executed just once before starting this plan body
execution. Therefore, it acts as a prolog to the task represented by this
plan body.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Behaviour.onStart()</code></dd>
</dl>
</li>
</ul>
<a name="reset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>void reset()</pre>
<div class="block">Restores plan body initial state. This method must be implemented by
concrete subclasses in such a way that calling reset() on a plan body
object is equivalent to destroying it and recreating it back.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Behaviour.reset()</code></dd>
</dl>
</li>
</ul>
<a name="start--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>void start()</pre>
<div class="block">Starts the execution of a plan body, a <code>Behaviour</code>, associated with
this plan.</div>
</li>
</ul>
<a name="stop--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>stop</h4>
<pre>void stop()</pre>
<div class="block">Stops the plan body, a <code>Behaviour</code>, associated with this plan. If
the body implements the <a href="../../../bdi4jade/plan/planbody/DisposablePlanBody.html" title="interface in bdi4jade.plan.planbody"><code>DisposablePlanBody</code></a>, it invokes the method
to about the plan body, so it can perform finalizations.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/PlanBody.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../bdi4jade/plan/planbody/ParallelGoalPlanBody.html" title="class in bdi4jade.plan.planbody"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../bdi4jade/plan/planbody/SequentialActionPlanBody.html" title="class in bdi4jade.plan.planbody"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?bdi4jade/plan/planbody/PlanBody.html" target="_top">Frames</a></li>
<li><a href="PlanBody.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>