<!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_20) on Mon Sep 22 12:55:55 BRT 2014 -->
<title>TopLevelPlanBody</title>
<meta name="date" content="2014-09-22">
<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="TopLevelPlanBody";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/TopLevelPlanBody.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/examples/blocksworld/plan/PerformMovePlanBody.html" title="class in bdi4jade.examples.blocksworld.plan"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?bdi4jade/examples/blocksworld/plan/TopLevelPlanBody.html" target="_top">Frames</a></li>
<li><a href="TopLevelPlanBody.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><a href="#nested.classes.inherited.from.class.jade.core.behaviours.Behaviour">Nested</a> | </li>
<li><a href="#fields.inherited.from.class.jade.core.behaviours.Behaviour">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </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.examples.blocksworld.plan</div>
<h2 title="Class TopLevelPlanBody" class="title">Class TopLevelPlanBody</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>jade.core.behaviours.Behaviour</li>
<li>
<ul class="inheritance">
<li><a href="../../../../bdi4jade/plan/planbody/AbstractPlanBody.html" title="class in bdi4jade.plan.planbody">bdi4jade.plan.planbody.AbstractPlanBody</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../bdi4jade/plan/planbody/BeliefGoalPlanBody.html" title="class in bdi4jade.plan.planbody">bdi4jade.plan.planbody.BeliefGoalPlanBody</a></li>
<li>
<ul class="inheritance">
<li>bdi4jade.examples.blocksworld.plan.TopLevelPlanBody</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../bdi4jade/event/GoalListener.html" title="interface in bdi4jade.event">GoalListener</a>, <a href="../../../../bdi4jade/plan/planbody/PlanBody.html" title="interface in bdi4jade.plan.planbody">PlanBody</a>, java.io.Serializable, java.util.EventListener</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">TopLevelPlanBody</span>
extends <a href="../../../../bdi4jade/plan/planbody/BeliefGoalPlanBody.html" title="class in bdi4jade.plan.planbody">BeliefGoalPlanBody</a></pre>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Ingrid Nunes</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../serialized-form.html#bdi4jade.examples.blocksworld.plan.TopLevelPlanBody">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.jade.core.behaviours.Behaviour">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class jade.core.behaviours.Behaviour</h3>
<code>jade.core.behaviours.Behaviour.RunnableChangedEvent</code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.jade.core.behaviours.Behaviour">
<!-- -->
</a>
<h3>Fields inherited from class jade.core.behaviours.Behaviour</h3>
<code>myAgent, myEvent, NOTIFY_DOWN, NOTIFY_UP, parent, STATE_BLOCKED, STATE_READY, STATE_RUNNING</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../bdi4jade/examples/blocksworld/plan/TopLevelPlanBody.html#TopLevelPlanBody--">TopLevelPlanBody</a></span>()</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../bdi4jade/examples/blocksworld/plan/TopLevelPlanBody.html#execute--">execute</a></span>()</code>
<div class="block">This method is a placeholder for subclasses that should implement the set
of steps needed to achieve this plan body goal.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../bdi4jade/examples/blocksworld/plan/TopLevelPlanBody.html#init--">init</a></span>()</code>
<div class="block">This method is a placeholder for subclasses.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../bdi4jade/examples/blocksworld/plan/TopLevelPlanBody.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="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../bdi4jade/examples/blocksworld/plan/TopLevelPlanBody.html#setValue-java.util.Set-">setValue</a></span>(java.util.Set<<a href="../../../../bdi4jade/examples/blocksworld/domain/On.html" title="class in bdi4jade.examples.blocksworld.domain">On</a>> target)</code>
<div class="block">This method sets the target block configuration to be achieved.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.bdi4jade.plan.planbody.BeliefGoalPlanBody">
<!-- -->
</a>
<h3>Methods inherited from class bdi4jade.plan.planbody.<a href="../../../../bdi4jade/plan/planbody/BeliefGoalPlanBody.html" title="class in bdi4jade.plan.planbody">BeliefGoalPlanBody</a></h3>
<code><a href="../../../../bdi4jade/plan/planbody/BeliefGoalPlanBody.html#action--">action</a>, <a href="../../../../bdi4jade/plan/planbody/BeliefGoalPlanBody.html#getOutputBelief--">getOutputBelief</a>, <a href="../../../../bdi4jade/plan/planbody/BeliefGoalPlanBody.html#isGoalAchieved--">isGoalAchieved</a>, <a href="../../../../bdi4jade/plan/planbody/BeliefGoalPlanBody.html#onStart--">onStart</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.bdi4jade.plan.planbody.AbstractPlanBody">
<!-- -->
</a>
<h3>Methods inherited from class bdi4jade.plan.planbody.<a href="../../../../bdi4jade/plan/planbody/AbstractPlanBody.html" title="class in bdi4jade.plan.planbody">AbstractPlanBody</a></h3>
<code><a href="../../../../bdi4jade/plan/planbody/AbstractPlanBody.html#dispatchGoal-bdi4jade.goal.Goal-">dispatchGoal</a>, <a href="../../../../bdi4jade/plan/planbody/AbstractPlanBody.html#dispatchSubgoal-bdi4jade.goal.Goal-">dispatchSubgoal</a>, <a href="../../../../bdi4jade/plan/planbody/AbstractPlanBody.html#dispatchSubgoalAndListen-bdi4jade.goal.Goal-">dispatchSubgoalAndListen</a>, <a href="../../../../bdi4jade/plan/planbody/AbstractPlanBody.html#done--">done</a>, <a href="../../../../bdi4jade/plan/planbody/AbstractPlanBody.html#getBeliefBase--">getBeliefBase</a>, <a href="../../../../bdi4jade/plan/planbody/AbstractPlanBody.html#getCapability--">getCapability</a>, <a href="../../../../bdi4jade/plan/planbody/AbstractPlanBody.html#getEndState--">getEndState</a>, <a href="../../../../bdi4jade/plan/planbody/AbstractPlanBody.html#getGoal--">getGoal</a>, <a href="../../../../bdi4jade/plan/planbody/AbstractPlanBody.html#getGoalEvent--">getGoalEvent</a>, <a href="../../../../bdi4jade/plan/planbody/AbstractPlanBody.html#getGoalEvent-boolean-">getGoalEvent</a>, <a href="../../../../bdi4jade/plan/planbody/AbstractPlanBody.html#getGoalEvent-long-">getGoalEvent</a>, <a href="../../../../bdi4jade/plan/planbody/AbstractPlanBody.html#getPlan--">getPlan</a>, <a href="../../../../bdi4jade/plan/planbody/AbstractPlanBody.html#goalPerformed-bdi4jade.event.GoalEvent-">goalPerformed</a>, <a href="../../../../bdi4jade/plan/planbody/AbstractPlanBody.html#init-bdi4jade.plan.Plan-bdi4jade.core.Intention-">init</a>, <a href="../../../../bdi4jade/plan/planbody/AbstractPlanBody.html#setEndState-bdi4jade.plan.Plan.EndState-">setEndState</a>, <a href="../../../../bdi4jade/plan/planbody/AbstractPlanBody.html#start--">start</a>, <a href="../../../../bdi4jade/plan/planbody/AbstractPlanBody.html#stop--">stop</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jade.core.behaviours.Behaviour">
<!-- -->
</a>
<h3>Methods inherited from class jade.core.behaviours.Behaviour</h3>
<code>actionWrapper, block, block, getAgent, getBehaviourName, getDataStore, getExecutionState, getParent, getRestartCounter, handle, handleBlockEvent, handleRestartEvent, isRunnable, reset, restart, root, setAgent, setBehaviourName, setDataStore, setExecutionState</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.bdi4jade.plan.planbody.PlanBody">
<!-- -->
</a>
<h3>Methods inherited from interface bdi4jade.plan.planbody.<a href="../../../../bdi4jade/plan/planbody/PlanBody.html" title="interface in bdi4jade.plan.planbody">PlanBody</a></h3>
<code><a href="../../../../bdi4jade/plan/planbody/PlanBody.html#block--">block</a>, <a href="../../../../bdi4jade/plan/planbody/PlanBody.html#reset--">reset</a>, <a href="../../../../bdi4jade/plan/planbody/PlanBody.html#restart--">restart</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="TopLevelPlanBody--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TopLevelPlanBody</h4>
<pre>public TopLevelPlanBody()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="execute--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre>public void execute()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../bdi4jade/plan/planbody/BeliefGoalPlanBody.html#execute--">BeliefGoalPlanBody</a></code></span></div>
<div class="block">This method is a placeholder for subclasses that should implement the set
of steps needed to achieve this plan body goal.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../bdi4jade/plan/planbody/BeliefGoalPlanBody.html#execute--">execute</a></code> in class <code><a href="../../../../bdi4jade/plan/planbody/BeliefGoalPlanBody.html" title="class in bdi4jade.plan.planbody">BeliefGoalPlanBody</a></code></dd>
</dl>
</li>
</ul>
<a name="onEnd--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onEnd</h4>
<pre>public int onEnd()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../bdi4jade/plan/planbody/PlanBody.html#onEnd--">PlanBody</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../bdi4jade/plan/planbody/PlanBody.html#onEnd--">onEnd</a></code> in interface <code><a href="../../../../bdi4jade/plan/planbody/PlanBody.html" title="interface in bdi4jade.plan.planbody">PlanBody</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>onEnd</code> in class <code>jade.core.behaviours.Behaviour</code></dd>
<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></dd>
</dl>
</li>
</ul>
<a name="init--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public void init()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../bdi4jade/plan/planbody/BeliefGoalPlanBody.html#init--">BeliefGoalPlanBody</a></code></span></div>
<div class="block">This method is a placeholder for subclasses. It is invoked by the
<a href="../../../../bdi4jade/plan/planbody/BeliefGoalPlanBody.html#onStart--"><code>BeliefGoalPlanBody.onStart()</code></a> method, after it performs some pre-processing.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../bdi4jade/plan/planbody/BeliefGoalPlanBody.html#init--">init</a></code> in class <code><a href="../../../../bdi4jade/plan/planbody/BeliefGoalPlanBody.html" title="class in bdi4jade.plan.planbody">BeliefGoalPlanBody</a></code></dd>
</dl>
</li>
</ul>
<a name="setValue-java.util.Set-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setValue</h4>
<pre><a href="../../../../bdi4jade/annotation/Parameter.html" title="annotation in bdi4jade.annotation">@Parameter</a>(<a href="../../../../bdi4jade/annotation/Parameter.html#direction--">direction</a>=<a href="../../../../bdi4jade/annotation/Parameter.Direction.html#IN">IN</a>,
<a href="../../../../bdi4jade/annotation/Parameter.html#mandatory--">mandatory</a>=true)
public void setValue(java.util.Set<<a href="../../../../bdi4jade/examples/blocksworld/domain/On.html" title="class in bdi4jade.examples.blocksworld.domain">On</a>> target)</pre>
<div class="block">This method sets the target block configuration to be achieved. It is
given in the form of a set of <a href="../../../../bdi4jade/examples/blocksworld/domain/On.html" title="class in bdi4jade.examples.blocksworld.domain"><code>On</code></a> values, and the method organize
these values in the order in which they should be stacked, from table to
top. This organized configuration is set in the target array of this plan
body.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>target</code> - the target to set.</dd>
</dl>
</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/TopLevelPlanBody.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/examples/blocksworld/plan/PerformMovePlanBody.html" title="class in bdi4jade.examples.blocksworld.plan"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?bdi4jade/examples/blocksworld/plan/TopLevelPlanBody.html" target="_top">Frames</a></li>
<li><a href="TopLevelPlanBody.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><a href="#nested.classes.inherited.from.class.jade.core.behaviours.Behaviour">Nested</a> | </li>
<li><a href="#fields.inherited.from.class.jade.core.behaviours.Behaviour">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>