CompositeGoal.html
Home
/
bdi-jade /
doc /
bdi4jade /
util /
goal /
CompositeGoal.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:40 BRST 2014 -->
<title>CompositeGoal</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="CompositeGoal";
}
//-->
</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/CompositeGoal.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/util/goal/BeliefSetValueGoal.html" title="class in bdi4jade.util.goal"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../bdi4jade/util/goal/ParallelGoal.html" title="class in bdi4jade.util.goal"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?bdi4jade/util/goal/CompositeGoal.html" target="_top">Frames</a></li>
<li><a href="CompositeGoal.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.util.goal</div>
<h2 title="Class CompositeGoal" class="title">Class CompositeGoal</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>bdi4jade.util.goal.CompositeGoal</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>, jade.content.Concept, jade.content.ContentElement, jade.content.Term, java.io.Serializable</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../bdi4jade/util/goal/ParallelGoal.html" title="class in bdi4jade.util.goal">ParallelGoal</a>, <a href="../../../bdi4jade/util/goal/SequentialGoal.html" title="class in bdi4jade.util.goal">SequentialGoal</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">CompositeGoal</span>
extends java.lang.Object
implements <a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a></pre>
<div class="block">This class represents a goal that is a composition of other goals (subgoals).
It has two subclasses, which indicate if the goals must be achieved in a
parallel or sequential way.</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.util.goal.CompositeGoal">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/util/goal/CompositeGoal.html#CompositeGoal(java.util.Collection)">CompositeGoal</a></strong>(java.util.Collection<<a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>> goals)</code>
<div class="block">Instantiate a CompositeGoal with the provided goals.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../bdi4jade/util/goal/CompositeGoal.html#CompositeGoal(bdi4jade.goal.Goal[])">CompositeGoal</a></strong>(<a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>[] goals)</code>
<div class="block">Instantiate a CompositeGoal with the provided goals array.</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>java.util.List<<a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>></code></td>
<td class="colLast"><code><strong><a href="../../../bdi4jade/util/goal/CompositeGoal.html#getCompletedGoals()">getCompletedGoals</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../bdi4jade/event/GoalFinishedEvent.html" title="class in bdi4jade.event">GoalFinishedEvent</a></code></td>
<td class="colLast"><code><strong><a href="../../../bdi4jade/util/goal/CompositeGoal.html#getFailedGoal()">getFailedGoal</a></strong>()</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.Collection<<a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>></code></td>
<td class="colLast"><code><strong><a href="../../../bdi4jade/util/goal/CompositeGoal.html#getGoals()">getGoals</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../bdi4jade/util/goal/CompositeGoal.html#setCompletedGoals(java.util.List)">setCompletedGoals</a></strong>(java.util.List<<a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>> completedGoals)</code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../bdi4jade/util/goal/CompositeGoal.html#setFailedGoal(bdi4jade.event.GoalFinishedEvent)">setFailedGoal</a></strong>(<a href="../../../bdi4jade/event/GoalFinishedEvent.html" title="class in bdi4jade.event">GoalFinishedEvent</a> failedGoal)</code> </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="CompositeGoal(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CompositeGoal</h4>
<pre>public CompositeGoal(java.util.Collection<<a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>> goals)</pre>
<div class="block">Instantiate a CompositeGoal with the provided goals.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>goals</code> - the goals that compose this goal.</dd></dl>
</li>
</ul>
<a name="CompositeGoal(bdi4jade.goal.Goal[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CompositeGoal</h4>
<pre>public CompositeGoal(<a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>[] goals)</pre>
<div class="block">Instantiate a CompositeGoal with the provided goals array. A
<code>Collection</code> is instantiated by the method <code>#createGoals()</code>
and is initialized with the provided goals.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>goals</code> - the goals that compose this goal.</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="getCompletedGoals()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCompletedGoals</h4>
<pre>public java.util.List<<a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>> getCompletedGoals()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>the completedGoals</dd></dl>
</li>
</ul>
<a name="getFailedGoal()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFailedGoal</h4>
<pre>public <a href="../../../bdi4jade/event/GoalFinishedEvent.html" title="class in bdi4jade.event">GoalFinishedEvent</a> getFailedGoal()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>the failedGoal</dd></dl>
</li>
</ul>
<a name="getGoals()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGoals</h4>
<pre>public java.util.Collection<<a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>> getGoals()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>the goals</dd></dl>
</li>
</ul>
<a name="setCompletedGoals(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCompletedGoals</h4>
<pre>public void setCompletedGoals(java.util.List<<a href="../../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>> completedGoals)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>completedGoals</code> - the completedGoals to set</dd></dl>
</li>
</ul>
<a name="setFailedGoal(bdi4jade.event.GoalFinishedEvent)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setFailedGoal</h4>
<pre>public void setFailedGoal(<a href="../../../bdi4jade/event/GoalFinishedEvent.html" title="class in bdi4jade.event">GoalFinishedEvent</a> failedGoal)</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>failedGoal</code> - the failedGoal 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/CompositeGoal.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/util/goal/BeliefSetValueGoal.html" title="class in bdi4jade.util.goal"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../bdi4jade/util/goal/ParallelGoal.html" title="class in bdi4jade.util.goal"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?bdi4jade/util/goal/CompositeGoal.html" target="_top">Frames</a></li>
<li><a href="CompositeGoal.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>