SequentialGoalPlanBody.html
Home
/
bdi-jade /
doc /
bdi4jade /
util /
plan /
SequentialGoalPlanBody.html
<!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 (version 1.7.0_25) on Thu Jan 09 01:28:39 BRST 2014 -->
<title>SequentialGoalPlanBody</title>
<meta name="date" content="2014-01-09">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SequentialGoalPlanBody";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/SequentialGoalPlanBody.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/util/plan/ParallelGoalPlanBody.html" title="class in bdi4jade.util.plan"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../bdi4jade/util/plan/SimplePlan.html" title="class in bdi4jade.util.plan"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?bdi4jade/util/plan/SequentialGoalPlanBody.html" target="_top">Frames</a></li>
<li><a href="SequentialGoalPlanBody.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><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.util.plan</div>
<h2 title="Class SequentialGoalPlanBody" class="title">Class SequentialGoalPlanBody</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>bdi4jade.util.plan.SequentialGoalPlanBody</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/plan/OutputPlanBody.html" title="interface in bdi4jade.plan">OutputPlanBody</a>, <a href="../../../bdi4jade/plan/PlanBody.html" title="interface in bdi4jade.plan">PlanBody</a>, java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">SequentialGoalPlanBody</span>
extends jade.core.behaviours.Behaviour
implements <a href="../../../bdi4jade/plan/PlanBody.html" title="interface in bdi4jade.plan">PlanBody</a>, <a href="../../../bdi4jade/plan/OutputPlanBody.html" title="interface in bdi4jade.plan">OutputPlanBody</a></pre>
<div class="block">This plan</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>ingrid</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../serialized-form.html#bdi4jade.util.plan.SequentialGoalPlanBody">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== 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>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="overviewSummary" 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><strong><a href="../../../bdi4jade/util/plan/SequentialGoalPlanBody.html#SequentialGoalPlanBody()">SequentialGoalPlanBody</a></strong>()</code>
<div class="block">Created a new SequentialGoalPlan.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../bdi4jade/util/plan/SequentialGoalPlanBody.html#action()">action</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../bdi4jade/util/plan/SequentialGoalPlanBody.html#done()">done</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../bdi4jade/plan/PlanInstance.EndState.html" title="enum in bdi4jade.plan">PlanInstance.EndState</a></code></td>
<td class="colLast"><code><strong><a href="../../../bdi4jade/util/plan/SequentialGoalPlanBody.html#getEndState()">getEndState</a></strong>()</code>
<div class="block">Returns the end state of the execution of this plan.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../bdi4jade/util/plan/SequentialGoalPlanBody.html#init(bdi4jade.plan.PlanInstance)">init</a></strong>(<a href="../../../bdi4jade/plan/PlanInstance.html" title="class in bdi4jade.plan">PlanInstance</a> planInstance)</code>
<div class="block">Initializes this plan.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../bdi4jade/util/plan/SequentialGoalPlanBody.html#setGoalOutput(bdi4jade.goal.Goal)">setGoalOutput</a></strong>(<a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goal)</code>
<div class="block">Sets the output parameters in the goal.</div>
</td>
</tr>
</table>
<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, getBehaviourName, getDataStore, getExecutionState, getRestartCounter, handleRestartEvent, isRunnable, onEnd, onStart, 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>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="SequentialGoalPlanBody()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SequentialGoalPlanBody</h4>
<pre>public SequentialGoalPlanBody()</pre>
<div class="block">Created a new SequentialGoalPlan.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="action()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>action</h4>
<pre>public void action()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>action</code> in class <code>jade.core.behaviours.Behaviour</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>Behaviour.action()</code></dd></dl>
</li>
</ul>
<a name="done()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>done</h4>
<pre>public boolean done()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>done</code> in class <code>jade.core.behaviours.Behaviour</code></dd>
<dt><span class="strong">See Also:</span></dt><dd><code>Behaviour.done()</code></dd></dl>
</li>
</ul>
<a name="getEndState()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEndState</h4>
<pre>public <a href="../../../bdi4jade/plan/PlanInstance.EndState.html" title="enum in bdi4jade.plan">PlanInstance.EndState</a> getEndState()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../bdi4jade/plan/PlanBody.html#getEndState()">PlanBody</a></code></strong></div>
<div class="block">Returns the end state of the execution of this plan.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../bdi4jade/plan/PlanBody.html#getEndState()">getEndState</a></code> in interface <code><a href="../../../bdi4jade/plan/PlanBody.html" title="interface in bdi4jade.plan">PlanBody</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the end state of this plan, or null if it has not finished yet.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../bdi4jade/plan/PlanBody.html#getEndState()"><code>PlanBody.getEndState()</code></a></dd></dl>
</li>
</ul>
<a name="init(bdi4jade.plan.PlanInstance)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public void init(<a href="../../../bdi4jade/plan/PlanInstance.html" title="class in bdi4jade.plan">PlanInstance</a> planInstance)</pre>
<div class="block">Initializes this plan. Starts the goals iterator.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../bdi4jade/plan/PlanBody.html#init(bdi4jade.plan.PlanInstance)">init</a></code> in interface <code><a href="../../../bdi4jade/plan/PlanBody.html" title="interface in bdi4jade.plan">PlanBody</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>planInstance</code> - the plan instance associated with this plan.</dd></dl>
</li>
</ul>
<a name="setGoalOutput(bdi4jade.goal.Goal)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setGoalOutput</h4>
<pre>public void setGoalOutput(<a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goal)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../bdi4jade/plan/OutputPlanBody.html#setGoalOutput(bdi4jade.goal.Goal)">OutputPlanBody</a></code></strong></div>
<div class="block">Sets the output parameters in the goal.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../bdi4jade/plan/OutputPlanBody.html#setGoalOutput(bdi4jade.goal.Goal)">setGoalOutput</a></code> in interface <code><a href="../../../bdi4jade/plan/OutputPlanBody.html" title="interface in bdi4jade.plan">OutputPlanBody</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>goal</code> - the goal whose output parameters are to be set.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../bdi4jade/plan/OutputPlanBody.html#setGoalOutput(bdi4jade.goal.Goal)"><code>OutputPlanBody.setGoalOutput(bdi4jade.goal.Goal)</code></a></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/SequentialGoalPlanBody.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/util/plan/ParallelGoalPlanBody.html" title="class in bdi4jade.util.plan"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../bdi4jade/util/plan/SimplePlan.html" title="class in bdi4jade.util.plan"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?bdi4jade/util/plan/SequentialGoalPlanBody.html" target="_top">Frames</a></li>
<li><a href="SequentialGoalPlanBody.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><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>