OrPlanGoalDependency.html
Home
/
bdi-jade /
doc /
bdi4jade /
plan /
OrPlanGoalDependency.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>OrPlanGoalDependency</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="OrPlanGoalDependency";
}
//-->
</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/OrPlanGoalDependency.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/DisposablePlanBody.html" title="interface in bdi4jade.plan"><span class="strong">Prev Class</span></a></li>
<li><a href="../../bdi4jade/plan/OutputPlanBody.html" title="interface in bdi4jade.plan"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/plan/OrPlanGoalDependency.html" target="_top">Frames</a></li>
<li><a href="OrPlanGoalDependency.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.plan</div>
<h2 title="Class OrPlanGoalDependency" class="title">Class OrPlanGoalDependency</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../bdi4jade/plan/PlanGoalDependency.html" title="class in bdi4jade.plan">bdi4jade.plan.PlanGoalDependency</a></li>
<li>
<ul class="inheritance">
<li>bdi4jade.plan.OrPlanGoalDependency</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">OrPlanGoalDependency</span>
extends <a href="../../bdi4jade/plan/PlanGoalDependency.html" title="class in bdi4jade.plan">PlanGoalDependency</a></pre>
<div class="block">This class represents an OR dependency between a plan and a set of goals. It
means that this plan needs that one of these goals that it depends on must be
achieved so that the plan can be completed. As solely one of the goals must
be achieved, this class stores the probability of each particular goal to be
achieved during the plan execution.</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">
<!-- ======== 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/plan/OrPlanGoalDependency.html#OrPlanGoalDependency(bdi4jade.plan.Plan)">OrPlanGoalDependency</a></strong>(<a href="../../bdi4jade/plan/Plan.html" title="class in bdi4jade.plan">Plan</a> root)</code> </td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../bdi4jade/plan/OrPlanGoalDependency.html#OrPlanGoalDependency(bdi4jade.plan.Plan, java.util.Map)">OrPlanGoalDependency</a></strong>(<a href="../../bdi4jade/plan/Plan.html" title="class in bdi4jade.plan">Plan</a> root,
java.util.Map<<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>,java.lang.Double> goals)</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="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/plan/OrPlanGoalDependency.html#addGoal(bdi4jade.goal.Goal, java.lang.Double)">addGoal</a></strong>(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goal,
java.lang.Double probability)</code>
<div class="block">Adds a goal to this dependency, indicating that the root plan depends on
it, with a certain probability.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Map<<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>,java.lang.Double></code></td>
<td class="colLast"><code><strong><a href="../../bdi4jade/plan/OrPlanGoalDependency.html#getGoals()">getGoals</a></strong>()</code>
<div class="block">Returns the map of goals with their probabilities that the root plan
depends on.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../bdi4jade/plan/OrPlanGoalDependency.html#removeGoal(bdi4jade.goal.Goal)">removeGoal</a></strong>(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goal)</code>
<div class="block">Remove a goal from this dependency.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_bdi4jade.plan.PlanGoalDependency">
<!-- -->
</a>
<h3>Methods inherited from class bdi4jade.plan.<a href="../../bdi4jade/plan/PlanGoalDependency.html" title="class in bdi4jade.plan">PlanGoalDependency</a></h3>
<code><a href="../../bdi4jade/plan/PlanGoalDependency.html#getRoot()">getRoot</a></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="OrPlanGoalDependency(bdi4jade.plan.Plan)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OrPlanGoalDependency</h4>
<pre>public OrPlanGoalDependency(<a href="../../bdi4jade/plan/Plan.html" title="class in bdi4jade.plan">Plan</a> root)</pre>
</li>
</ul>
<a name="OrPlanGoalDependency(bdi4jade.plan.Plan, java.util.Map)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>OrPlanGoalDependency</h4>
<pre>public OrPlanGoalDependency(<a href="../../bdi4jade/plan/Plan.html" title="class in bdi4jade.plan">Plan</a> root,
java.util.Map<<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>,java.lang.Double> goals)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addGoal(bdi4jade.goal.Goal, java.lang.Double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addGoal</h4>
<pre>public void addGoal(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goal,
java.lang.Double probability)</pre>
<div class="block">Adds a goal to this dependency, indicating that the root plan depends on
it, with a certain probability.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>goal</code> - a goal that the root plan depends on.</dd><dd><code>probability</code> - the probability of the goal</dd></dl>
</li>
</ul>
<a name="getGoals()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGoals</h4>
<pre>public java.util.Map<<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>,java.lang.Double> getGoals()</pre>
<div class="block">Returns the map of goals with their probabilities that the root plan
depends on.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the goals the goal that the root plan depends on.</dd></dl>
</li>
</ul>
<a name="removeGoal(bdi4jade.goal.Goal)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeGoal</h4>
<pre>public void removeGoal(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goal)</pre>
<div class="block">Remove a goal from this dependency.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>goal</code> - the goal to be removed.</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/OrPlanGoalDependency.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/DisposablePlanBody.html" title="interface in bdi4jade.plan"><span class="strong">Prev Class</span></a></li>
<li><a href="../../bdi4jade/plan/OutputPlanBody.html" title="interface in bdi4jade.plan"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/plan/OrPlanGoalDependency.html" target="_top">Frames</a></li>
<li><a href="OrPlanGoalDependency.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>