PlanBody.html
Home
/
bdi-jade /
doc /
bdi4jade /
plan /
PlanBody.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>PlanBody</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="PlanBody";
}
//-->
</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/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/Plan.DefaultMetadata.html" title="enum in bdi4jade.plan"><span class="strong">Prev Class</span></a></li>
<li><a href="../../bdi4jade/plan/PlanContribution.html" title="class in bdi4jade.plan"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/plan/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</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 Known Implementing Classes:</dt>
<dd><a href="../../bdi4jade/util/plan/ParallelGoalPlanBody.html" title="class in bdi4jade.util.plan">ParallelGoalPlanBody</a>, <a href="../../bdi4jade/util/plan/SequentialGoalPlanBody.html" title="class in bdi4jade.util.plan">SequentialGoalPlanBody</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">PlanBody</span></pre>
<div class="block">This interface defines a PlanBody. Plans are executed as behaviors (
<code>Behaviour</code>), but executed in the BDI context, these behaviors should
also implement this interface.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>ingrid</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="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><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/plan/PlanBody.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/plan/PlanBody.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 the PlanBody.</div>
</td>
</tr>
</table>
</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="getEndState()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEndState</h4>
<pre><a href="../../bdi4jade/plan/PlanInstance.EndState.html" title="enum in bdi4jade.plan">PlanInstance.EndState</a> getEndState()</pre>
<div class="block">Returns the end state of the execution of this plan.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the end state of this plan, or null if it has not finished yet.</dd></dl>
</li>
</ul>
<a name="init(bdi4jade.plan.PlanInstance)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>init</h4>
<pre>void init(<a href="../../bdi4jade/plan/PlanInstance.html" title="class in bdi4jade.plan">PlanInstance</a> planInstance)</pre>
<div class="block">Initializes the PlanBody. It is invoked just after its instantiation.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>planInstance</code> - the plan instance that contains contextual information for
this plan body.</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/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/Plan.DefaultMetadata.html" title="enum in bdi4jade.plan"><span class="strong">Prev Class</span></a></li>
<li><a href="../../bdi4jade/plan/PlanContribution.html" title="class in bdi4jade.plan"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/plan/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>