GoalUpdateSet.html

438 lines | 18.359 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 (1.8.0_20) on Mon Sep 22 13:06:34 BRT 2014 -->
<title>GoalUpdateSet</title>
<meta name="date" content="2014-09-22">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="GoalUpdateSet";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!--   -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/GoalUpdateSet.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/Capability.html" title="class in bdi4jade.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../bdi4jade/core/GoalUpdateSet.GoalDescription.html" title="class in bdi4jade.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/core/GoalUpdateSet.html" target="_top">Frames</a></li>
<li><a href="GoalUpdateSet.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;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><a href="#nested.class.summary">Nested</a>&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.core</div>
<h2 title="Class GoalUpdateSet" class="title">Class GoalUpdateSet</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>bdi4jade.core.GoalUpdateSet</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">GoalUpdateSet</span>
extends java.lang.Object</pre>
<div class="block">This class is a data structure to used to specify updates on goals. In a
 certain agent state, it has a set of current goals. During the agent
 reasoning cycle, some of these goals may be dropped, and new goals may be
 generated. This class has the set with current goals, and allows informing
 which goals should be dropped, and which should be generated. Current goals
 may contain goals dispatched by a single capability.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Ingrid Nunes</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!--   -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/core/GoalUpdateSet.GoalDescription.html" title="class in bdi4jade.core">GoalUpdateSet.GoalDescription</a></span></code>
<div class="block">This class is a data structure to describe a goal.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/core/GoalUpdateSet.html#dropGoal-bdi4jade.core.GoalUpdateSet.GoalDescription-">dropGoal</a></span>(<a href="../../bdi4jade/core/GoalUpdateSet.GoalDescription.html" title="class in bdi4jade.core">GoalUpdateSet.GoalDescription</a>&nbsp;goal)</code>
<div class="block">Indicates that a goal should be dropped.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/core/GoalUpdateSet.html#generateGoal-bdi4jade.goal.Goal-">generateGoal</a></span>(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>&nbsp;goal)</code>
<div class="block">Indicates that a goal should be added to the agent.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/core/GoalUpdateSet.html#generateGoal-bdi4jade.goal.Goal-bdi4jade.core.Capability-">generateGoal</a></span>(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>&nbsp;goal,
            <a href="../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a>&nbsp;dispatcher)</code>
<div class="block">Indicates that a goal should be added to the agent, with the capability
 that dispatched the goal.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/core/GoalUpdateSet.html#generateGoal-bdi4jade.goal.Goal-bdi4jade.core.Capability-bdi4jade.event.GoalListener-">generateGoal</a></span>(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>&nbsp;goal,
            <a href="../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a>&nbsp;dispatcher,
            <a href="../../bdi4jade/event/GoalListener.html" title="interface in bdi4jade.event">GoalListener</a>&nbsp;listener)</code>
<div class="block">Indicates that a goal should be added to the agent, with the capability
 that dispatched the goal and provided listener.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/core/GoalUpdateSet.html#generateGoal-bdi4jade.goal.Goal-bdi4jade.event.GoalListener-">generateGoal</a></span>(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>&nbsp;goal,
            <a href="../../bdi4jade/event/GoalListener.html" title="interface in bdi4jade.event">GoalListener</a>&nbsp;listener)</code>
<div class="block">Indicates that a goal should be added to the agent, with the provided
 listener.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;<a href="../../bdi4jade/core/GoalUpdateSet.GoalDescription.html" title="class in bdi4jade.core">GoalUpdateSet.GoalDescription</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/core/GoalUpdateSet.html#getCurrentGoals--">getCurrentGoals</a></span>()</code>
<div class="block">Returns the set of current agent goals.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.Set&lt;<a href="../../bdi4jade/core/GoalUpdateSet.GoalDescription.html" title="class in bdi4jade.core">GoalUpdateSet.GoalDescription</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/core/GoalUpdateSet.html#getDroppedGoals--">getDroppedGoals</a></span>()</code>
<div class="block">Returns the set of dropped goals.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>java.util.Set&lt;<a href="../../bdi4jade/core/GoalUpdateSet.GoalDescription.html" title="class in bdi4jade.core">GoalUpdateSet.GoalDescription</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/core/GoalUpdateSet.html#getGeneratedGoals--">getGeneratedGoals</a></span>()</code>
<div class="block">Returns the set of generated goals.</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&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, 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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="dropGoal-bdi4jade.core.GoalUpdateSet.GoalDescription-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dropGoal</h4>
<pre>public&nbsp;void&nbsp;dropGoal(<a href="../../bdi4jade/core/GoalUpdateSet.GoalDescription.html" title="class in bdi4jade.core">GoalUpdateSet.GoalDescription</a>&nbsp;goal)</pre>
<div class="block">Indicates that a goal should be dropped. The goal is added to the set of
 dropped goals.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>goal</code> - the goal to be dropped.</dd>
</dl>
</li>
</ul>
<a name="generateGoal-bdi4jade.goal.Goal-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateGoal</h4>
<pre>public&nbsp;void&nbsp;generateGoal(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>&nbsp;goal)</pre>
<div class="block">Indicates that a goal should be added to the agent. The goal is added to
 the set of generated goals.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>goal</code> - the goal to be added.</dd>
</dl>
</li>
</ul>
<a name="generateGoal-bdi4jade.goal.Goal-bdi4jade.core.Capability-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateGoal</h4>
<pre>public&nbsp;void&nbsp;generateGoal(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>&nbsp;goal,
                         <a href="../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a>&nbsp;dispatcher)</pre>
<div class="block">Indicates that a goal should be added to the agent, with the capability
 that dispatched the goal. The goal is added to the set of generated
 goals.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>goal</code> - the goal to be added.</dd>
<dd><code>dispatcher</code> - the capability that dispatched the goal.</dd>
</dl>
</li>
</ul>
<a name="generateGoal-bdi4jade.goal.Goal-bdi4jade.core.Capability-bdi4jade.event.GoalListener-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateGoal</h4>
<pre>public&nbsp;void&nbsp;generateGoal(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>&nbsp;goal,
                         <a href="../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a>&nbsp;dispatcher,
                         <a href="../../bdi4jade/event/GoalListener.html" title="interface in bdi4jade.event">GoalListener</a>&nbsp;listener)</pre>
<div class="block">Indicates that a goal should be added to the agent, with the capability
 that dispatched the goal and provided listener. The goal is added to the
 set of generated goals.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>goal</code> - the goal to be added.</dd>
<dd><code>dispatcher</code> - the capability that dispatched the goal.</dd>
<dd><code>listener</code> - a goal listener.</dd>
</dl>
</li>
</ul>
<a name="generateGoal-bdi4jade.goal.Goal-bdi4jade.event.GoalListener-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateGoal</h4>
<pre>public&nbsp;void&nbsp;generateGoal(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>&nbsp;goal,
                         <a href="../../bdi4jade/event/GoalListener.html" title="interface in bdi4jade.event">GoalListener</a>&nbsp;listener)</pre>
<div class="block">Indicates that a goal should be added to the agent, with the provided
 listener. The goal is added to the set of generated goals.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>goal</code> - the goal to be added.</dd>
<dd><code>listener</code> - a goal listener.</dd>
</dl>
</li>
</ul>
<a name="getCurrentGoals--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentGoals</h4>
<pre>public&nbsp;java.util.Set&lt;<a href="../../bdi4jade/core/GoalUpdateSet.GoalDescription.html" title="class in bdi4jade.core">GoalUpdateSet.GoalDescription</a>&gt;&nbsp;getCurrentGoals()</pre>
<div class="block">Returns the set of current agent goals.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the set of current goals.</dd>
</dl>
</li>
</ul>
<a name="getDroppedGoals--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDroppedGoals</h4>
<pre>public&nbsp;java.util.Set&lt;<a href="../../bdi4jade/core/GoalUpdateSet.GoalDescription.html" title="class in bdi4jade.core">GoalUpdateSet.GoalDescription</a>&gt;&nbsp;getDroppedGoals()</pre>
<div class="block">Returns the set of dropped goals.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the set of dropped goals.</dd>
</dl>
</li>
</ul>
<a name="getGeneratedGoals--">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getGeneratedGoals</h4>
<pre>public&nbsp;java.util.Set&lt;<a href="../../bdi4jade/core/GoalUpdateSet.GoalDescription.html" title="class in bdi4jade.core">GoalUpdateSet.GoalDescription</a>&gt;&nbsp;getGeneratedGoals()</pre>
<div class="block">Returns the set of generated goals.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the set of generated 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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/GoalUpdateSet.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/Capability.html" title="class in bdi4jade.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../bdi4jade/core/GoalUpdateSet.GoalDescription.html" title="class in bdi4jade.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/core/GoalUpdateSet.html" target="_top">Frames</a></li>
<li><a href="GoalUpdateSet.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;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><a href="#nested.class.summary">Nested</a>&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>