OptionGenerationFunction.html

225 lines | 8.409 kB Blame History Raw Download
<!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:40 BRST 2014 -->
<title>OptionGenerationFunction</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="OptionGenerationFunction";
    }
//-->
</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/OptionGenerationFunction.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/reasoning/DeliberationFunction.html" title="interface in bdi4jade.reasoning"><span class="strong">Prev Class</span></a></li>
<li><a href="../../bdi4jade/reasoning/PlanSelectionStrategy.html" title="interface in bdi4jade.reasoning"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/reasoning/OptionGenerationFunction.html" target="_top">Frames</a></li>
<li><a href="OptionGenerationFunction.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.reasoning</div>
<h2 title="Interface OptionGenerationFunction" class="title">Interface OptionGenerationFunction</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/reasoning/DefaultOptionGenerationFunction.html" title="class in bdi4jade.util.reasoning">DefaultOptionGenerationFunction</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">OptionGenerationFunction</span></pre>
<div class="block">This interface defines the option generation functions to be used in the
 BDI-interpreter. This strategy is used for creating new goals or to drop
 existing ones.</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">&nbsp;</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>java.util.Set&lt;<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../bdi4jade/reasoning/OptionGenerationFunction.html#generateGoals(java.util.Map)">generateGoals</a></strong>(java.util.Map&lt;<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>,<a href="../../bdi4jade/goal/GoalStatus.html" title="enum in bdi4jade.goal">GoalStatus</a>&gt;&nbsp;goals)</code>
<div class="block">The goals parameter is a map of all goals of the agent (that might be
 intentions) with their corresponding status.</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="generateGoals(java.util.Map)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>generateGoals</h4>
<pre>java.util.Set&lt;<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>&gt;&nbsp;generateGoals(java.util.Map&lt;<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>,<a href="../../bdi4jade/goal/GoalStatus.html" title="enum in bdi4jade.goal">GoalStatus</a>&gt;&nbsp;goals)</pre>
<div class="block">The goals parameter is a map of all goals of the agent (that might be
 intentions) with their corresponding status. A set is returned of this
 function indicating the creating of new goals and the ones that continue
 to be goals. The non-selected goals will be no longer desired.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>goals</code> - the current goals with their status.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the list of selected goals.</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/OptionGenerationFunction.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/reasoning/DeliberationFunction.html" title="interface in bdi4jade.reasoning"><span class="strong">Prev Class</span></a></li>
<li><a href="../../bdi4jade/reasoning/PlanSelectionStrategy.html" title="interface in bdi4jade.reasoning"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/reasoning/OptionGenerationFunction.html" target="_top">Frames</a></li>
<li><a href="OptionGenerationFunction.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>