PlanLibrary.html
Home
/
bdi-jade /
doc /
bdi4jade /
core /
PlanLibrary.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:38 BRST 2014 -->
<title>PlanLibrary</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="PlanLibrary";
}
//-->
</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/PlanLibrary.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/core/Intention.html" title="class in bdi4jade.core"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/core/PlanLibrary.html" target="_top">Frames</a></li>
<li><a href="PlanLibrary.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><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.core</div>
<h2 title="Class PlanLibrary" class="title">Class PlanLibrary</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>bdi4jade.core.PlanLibrary</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">PlanLibrary</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<div class="block">This class represents the plan library of a capability. It aggregates the
plans that can be used to achieve goals.</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.core.PlanLibrary">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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/core/PlanLibrary.html#PlanLibrary()">PlanLibrary</a></strong>()</code>
<div class="block">Creates a plan library.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../bdi4jade/core/PlanLibrary.html#PlanLibrary(java.util.Set)">PlanLibrary</a></strong>(java.util.Set<<a href="../../bdi4jade/plan/Plan.html" title="class in bdi4jade.plan">Plan</a>> plans)</code>
<div class="block">Creates a plan library base associated with a capability and adds the
plans in the provided set.</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/core/PlanLibrary.html#addPlan(bdi4jade.plan.Plan)">addPlan</a></strong>(<a href="../../bdi4jade/plan/Plan.html" title="class in bdi4jade.plan">Plan</a> plan)</code>
<div class="block">Adds a plan to the plan library.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Set<<a href="../../bdi4jade/plan/Plan.html" title="class in bdi4jade.plan">Plan</a>></code></td>
<td class="colLast"><code><strong><a href="../../bdi4jade/core/PlanLibrary.html#canAchievePlans(bdi4jade.goal.Goal)">canAchievePlans</a></strong>(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goal)</code>
<div class="block">Returns the set of plans that can achieve the given goal.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../bdi4jade/core/PlanLibrary.html#canProcessPlans(jade.lang.acl.ACLMessage)">canProcessPlans</a></strong>(jade.lang.acl.ACLMessage message)</code>
<div class="block">Returns true if there is a plan that can process the given message.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a></code></td>
<td class="colLast"><code><strong><a href="../../bdi4jade/core/PlanLibrary.html#getCapability()">getCapability</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Set<<a href="../../bdi4jade/plan/Plan.html" title="class in bdi4jade.plan">Plan</a>></code></td>
<td class="colLast"><code><strong><a href="../../bdi4jade/core/PlanLibrary.html#getPlans()">getPlans</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../bdi4jade/core/PlanLibrary.html#hasPlan(bdi4jade.plan.Plan)">hasPlan</a></strong>(<a href="../../bdi4jade/plan/Plan.html" title="class in bdi4jade.plan">Plan</a> plan)</code>
<div class="block">Checks if a plan is part of the plan library.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../bdi4jade/core/PlanLibrary.html#removePlan(bdi4jade.plan.Plan)">removePlan</a></strong>(<a href="../../bdi4jade/plan/Plan.html" title="class in bdi4jade.plan">Plan</a> plan)</code>
<div class="block">Removes a plan from the plan library.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../bdi4jade/core/PlanLibrary.html#setCapability(bdi4jade.core.Capability)">setCapability</a></strong>(<a href="../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a> capability)</code>
<div class="block">Sets the capability of this plan library.</div>
</td>
</tr>
</table>
<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="PlanLibrary()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PlanLibrary</h4>
<pre>public PlanLibrary()</pre>
<div class="block">Creates a plan library.</div>
</li>
</ul>
<a name="PlanLibrary(java.util.Set)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PlanLibrary</h4>
<pre>public PlanLibrary(java.util.Set<<a href="../../bdi4jade/plan/Plan.html" title="class in bdi4jade.plan">Plan</a>> plans)</pre>
<div class="block">Creates a plan library base associated with a capability and adds the
plans in the provided set.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>plans</code> - the initial plans</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addPlan(bdi4jade.plan.Plan)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPlan</h4>
<pre>public void addPlan(<a href="../../bdi4jade/plan/Plan.html" title="class in bdi4jade.plan">Plan</a> plan)</pre>
<div class="block">Adds a plan to the plan library.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>plan</code> - the plan to be added.</dd></dl>
</li>
</ul>
<a name="canAchievePlans(bdi4jade.goal.Goal)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canAchievePlans</h4>
<pre>public java.util.Set<<a href="../../bdi4jade/plan/Plan.html" title="class in bdi4jade.plan">Plan</a>> canAchievePlans(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goal)</pre>
<div class="block">Returns the set of plans that can achieve the given goal.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>goal</code> - the goal to be achieved.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the set of plans that can achieve the goal.</dd></dl>
</li>
</ul>
<a name="canProcessPlans(jade.lang.acl.ACLMessage)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canProcessPlans</h4>
<pre>public boolean canProcessPlans(jade.lang.acl.ACLMessage message)</pre>
<div class="block">Returns true if there is a plan that can process the given message.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - the message to be processed.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if a plan can process the message.</dd></dl>
</li>
</ul>
<a name="getCapability()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCapability</h4>
<pre>public <a href="../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a> getCapability()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>the capability</dd></dl>
</li>
</ul>
<a name="getPlans()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPlans</h4>
<pre>public java.util.Set<<a href="../../bdi4jade/plan/Plan.html" title="class in bdi4jade.plan">Plan</a>> getPlans()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>the plans</dd></dl>
</li>
</ul>
<a name="hasPlan(bdi4jade.plan.Plan)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasPlan</h4>
<pre>public boolean hasPlan(<a href="../../bdi4jade/plan/Plan.html" title="class in bdi4jade.plan">Plan</a> plan)</pre>
<div class="block">Checks if a plan is part of the plan library.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>plan</code> - the plan to be checked</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the plan library contains the plan.</dd></dl>
</li>
</ul>
<a name="removePlan(bdi4jade.plan.Plan)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removePlan</h4>
<pre>public boolean removePlan(<a href="../../bdi4jade/plan/Plan.html" title="class in bdi4jade.plan">Plan</a> plan)</pre>
<div class="block">Removes a plan from the plan library.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>plan</code> - the plan to be removed.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the plan was removed.</dd></dl>
</li>
</ul>
<a name="setCapability(bdi4jade.core.Capability)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setCapability</h4>
<pre>public void setCapability(<a href="../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a> capability)</pre>
<div class="block">Sets the capability of this plan library. If the capability was already
set, it throws a <code>RuntimeException</code>. After setting the capability,
the <a href="../../bdi4jade/core/PlanLibrary.html#init()"><code>init()</code></a> method is invoked.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>capability</code> - the capability 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><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/PlanLibrary.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/core/Intention.html" title="class in bdi4jade.core"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/core/PlanLibrary.html" target="_top">Frames</a></li>
<li><a href="PlanLibrary.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><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>