CompositeGoal.html
Home
/
bdi-jade /
doc /
bdi4jade /
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 (1.8.0_20) on Mon Sep 22 13:06:34 BRT 2014 -->
<title>CompositeGoal</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="CompositeGoal";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/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/goal/BeliefValueGoal.html" title="class in bdi4jade.goal"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.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.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/goal/ParallelGoal.html" title="class in bdi4jade.goal">ParallelGoal</a>, <a href="../../bdi4jade/goal/SequentialGoal.html" title="class in bdi4jade.goal">SequentialGoal</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">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 main subclasses, which indicate if the goals must be achieved in a
parallel or sequential way.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Ingrid Nunes</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../serialized-form.html#bdi4jade.goal.CompositeGoal">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.List<<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/goal/CompositeGoal.html#completedGoals">completedGoals</a></span></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../bdi4jade/event/GoalEvent.html" title="class in bdi4jade.event">GoalEvent</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/goal/CompositeGoal.html#failedGoal">failedGoal</a></span></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Collection<<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/goal/CompositeGoal.html#goals">goals</a></span></code> </td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" 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><span class="memberNameLink"><a href="../../bdi4jade/goal/CompositeGoal.html#CompositeGoal-java.util.Collection-">CompositeGoal</a></span>(java.util.Collection<<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>> goals)</code>
<div class="block">Instantiates a CompositeGoal with the provided goals.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../bdi4jade/goal/CompositeGoal.html#CompositeGoal-bdi4jade.goal.Goal:A-">CompositeGoal</a></span>(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>[] goals)</code>
<div class="block">Instantiates 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="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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>protected abstract java.util.Collection<<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/goal/CompositeGoal.html#createGoals-int-">createGoals</a></span>(int size)</code>
<div class="block">Creates an instance of the collection that holds the goals of this
composite goal.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<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><span class="memberNameLink"><a href="../../bdi4jade/goal/CompositeGoal.html#getCompletedGoals--">getCompletedGoals</a></span>()</code>
<div class="block">Returns the goals of this composite goal that successfully finished.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../bdi4jade/event/GoalEvent.html" title="class in bdi4jade.event">GoalEvent</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/goal/CompositeGoal.html#getFailedGoal--">getFailedGoal</a></span>()</code>
<div class="block">Returns the goal event associated with a goal that could not be achieved,
if any.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<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><span class="memberNameLink"><a href="../../bdi4jade/goal/CompositeGoal.html#getGoals--">getGoals</a></span>()</code>
<div class="block">Returns the goals associated with this composite goal.</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/goal/CompositeGoal.html#setCompletedGoals-java.util.List-">setCompletedGoals</a></span>(java.util.List<<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>> completedGoals)</code>
<div class="block">Sets the list of completed goals.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/goal/CompositeGoal.html#setFailedGoal-bdi4jade.event.GoalEvent-">setFailedGoal</a></span>(<a href="../../bdi4jade/event/GoalEvent.html" title="class in bdi4jade.event">GoalEvent</a> failedGoal)</code>
<div class="block">Sets the goal event associated with the goal that failed.</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>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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="completedGoals">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>completedGoals</h4>
<pre>protected java.util.List<<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>> completedGoals</pre>
</li>
</ul>
<a name="failedGoal">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>failedGoal</h4>
<pre>protected <a href="../../bdi4jade/event/GoalEvent.html" title="class in bdi4jade.event">GoalEvent</a> failedGoal</pre>
</li>
</ul>
<a name="goals">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>goals</h4>
<pre>protected final java.util.Collection<<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>> goals</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= 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">Instantiates a CompositeGoal with the provided goals.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>goals</code> - the goals that compose this goal.</dd>
</dl>
</li>
</ul>
<a name="CompositeGoal-bdi4jade.goal.Goal:A-">
<!-- -->
</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">Instantiates a CompositeGoal with the provided goals array. A
<code>Collection</code> is instantiated by the method
<a href="../../bdi4jade/goal/CompositeGoal.html#createGoals-int-"><code>createGoals(int)</code></a> and is initialized with the provided goals.</div>
<dl>
<dt><span class="paramLabel">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="createGoals-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createGoals</h4>
<pre>protected abstract java.util.Collection<<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>> createGoals(int size)</pre>
<div class="block">Creates an instance of the collection that holds the goals of this
composite goal.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>size</code> - the size of the collection.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the collection.</dd>
</dl>
</li>
</ul>
<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>
<div class="block">Returns the goals of this composite goal that successfully finished.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the completedGoals the goals that were achieved.</dd>
</dl>
</li>
</ul>
<a name="getFailedGoal--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFailedGoal</h4>
<pre>public <a href="../../bdi4jade/event/GoalEvent.html" title="class in bdi4jade.event">GoalEvent</a> getFailedGoal()</pre>
<div class="block">Returns the goal event associated with a goal that could not be achieved,
if any. If it is not possible to achieve one of the goals, the remaining
goals that were not completed yet will not be achieved. If there are
goals part of this composite goal that are being tried to be achieved,
they become no longer desired.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the goal that failed.</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>
<div class="block">Returns the goals associated with this composite goal.</div>
<dl>
<dt><span class="returnLabel">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>
<div class="block">Sets the list of completed goals.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>completedGoals</code> - the completedGoals to set.</dd>
</dl>
</li>
</ul>
<a name="setFailedGoal-bdi4jade.event.GoalEvent-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setFailedGoal</h4>
<pre>public void setFailedGoal(<a href="../../bdi4jade/event/GoalEvent.html" title="class in bdi4jade.event">GoalEvent</a> failedGoal)</pre>
<div class="block">Sets the goal event associated with the goal that failed.</div>
<dl>
<dt><span class="paramLabel">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>
<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/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/goal/BeliefValueGoal.html" title="class in bdi4jade.goal"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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>