BeliefSetValueGoal.html
Home
/
bdi-jade /
doc /
bdi4jade /
goal /
BeliefSetValueGoal.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_17) on Tue Aug 12 15:49:05 BRT 2014 -->
<title>BeliefSetValueGoal</title>
<meta name="date" content="2014-08-12">
<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="BeliefSetValueGoal";
}
//-->
</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/BeliefSetValueGoal.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/BeliefGoal.html" title="class in bdi4jade.goal"><span class="strong">Prev Class</span></a></li>
<li><a href="../../bdi4jade/goal/BeliefValueGoal.html" title="class in bdi4jade.goal"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/goal/BeliefSetValueGoal.html" target="_top">Frames</a></li>
<li><a href="BeliefSetValueGoal.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.goal</div>
<h2 title="Class BeliefSetValueGoal" class="title">Class BeliefSetValueGoal<T></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../bdi4jade/goal/BeliefGoal.html" title="class in bdi4jade.goal">bdi4jade.goal.BeliefGoal</a></li>
<li>
<ul class="inheritance">
<li><a href="../../bdi4jade/goal/BeliefValueGoal.html" title="class in bdi4jade.goal">bdi4jade.goal.BeliefValueGoal</a><T></li>
<li>
<ul class="inheritance">
<li>bdi4jade.goal.BeliefSetValueGoal<T></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - the type of the values in the belief set.</dd></dl>
<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>
<hr>
<br>
<pre>public class <span class="strong">BeliefSetValueGoal<T></span>
extends <a href="../../bdi4jade/goal/BeliefValueGoal.html" title="class in bdi4jade.goal">BeliefValueGoal</a><T></pre>
<div class="block">This class represents the goal of an agent believe in a belief that contains
a certain value, that is, the agent has a belief set whose name is specified
in this goal and it contains the specified value.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Ingrid Nunes</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../serialized-form.html#bdi4jade.goal.BeliefSetValueGoal">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/goal/BeliefSetValueGoal.html#BeliefSetValueGoal(java.lang.String, T)">BeliefSetValueGoal</a></strong>(java.lang.String beliefSetName,
<a href="../../bdi4jade/goal/BeliefSetValueGoal.html" title="type parameter in BeliefSetValueGoal">T</a> value)</code>
<div class="block">Creates a new BeliefSetValueGoal with the provided belief name and a
value.</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>boolean</code></td>
<td class="colLast"><code><strong><a href="../../bdi4jade/goal/BeliefSetValueGoal.html#isAchieved(bdi4jade.belief.BeliefBase)">isAchieved</a></strong>(<a href="../../bdi4jade/belief/BeliefBase.html" title="class in bdi4jade.belief">BeliefBase</a> beliefBase)</code>
<div class="block">Checks whether this goal is achieved by verifying if the provided belief
set contains the value specified in this goal.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../bdi4jade/goal/BeliefSetValueGoal.html#toString()">toString</a></strong>()</code>
<div class="block">Returns a string representation of this goal, in the form
"BeliefSetValueGoal: BELIEF NAME should have BELIEF VALUE".</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_bdi4jade.goal.BeliefValueGoal">
<!-- -->
</a>
<h3>Methods inherited from class bdi4jade.goal.<a href="../../bdi4jade/goal/BeliefValueGoal.html" title="class in bdi4jade.goal">BeliefValueGoal</a></h3>
<code><a href="../../bdi4jade/goal/BeliefValueGoal.html#getValue()">getValue</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_bdi4jade.goal.BeliefGoal">
<!-- -->
</a>
<h3>Methods inherited from class bdi4jade.goal.<a href="../../bdi4jade/goal/BeliefGoal.html" title="class in bdi4jade.goal">BeliefGoal</a></h3>
<code><a href="../../bdi4jade/goal/BeliefGoal.html#getBeliefName()">getBeliefName</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>clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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="BeliefSetValueGoal(java.lang.String,java.lang.Object)">
<!-- -->
</a><a name="BeliefSetValueGoal(java.lang.String, T)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BeliefSetValueGoal</h4>
<pre>public BeliefSetValueGoal(java.lang.String beliefSetName,
<a href="../../bdi4jade/goal/BeliefSetValueGoal.html" title="type parameter in BeliefSetValueGoal">T</a> value)</pre>
<div class="block">Creates a new BeliefSetValueGoal with the provided belief name and a
value. This value represents the one that should be part of the belief
set.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>beliefSetName</code> - the belief name.</dd><dd><code>value</code> - the value that is target of 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="isAchieved(bdi4jade.belief.BeliefBase)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAchieved</h4>
<pre>public boolean isAchieved(<a href="../../bdi4jade/belief/BeliefBase.html" title="class in bdi4jade.belief">BeliefBase</a> beliefBase)</pre>
<div class="block">Checks whether this goal is achieved by verifying if the provided belief
set contains the value specified in this goal.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../bdi4jade/goal/BeliefValueGoal.html#isAchieved(bdi4jade.belief.BeliefBase)">isAchieved</a></code> in class <code><a href="../../bdi4jade/goal/BeliefValueGoal.html" title="class in bdi4jade.goal">BeliefValueGoal</a><<a href="../../bdi4jade/goal/BeliefSetValueGoal.html" title="type parameter in BeliefSetValueGoal">T</a>></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>beliefBase</code> - the belief base to be checked.</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the belief set contains the value specified in this goal.</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<div class="block">Returns a string representation of this goal, in the form
"BeliefSetValueGoal: BELIEF NAME should have BELIEF VALUE".</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../bdi4jade/goal/BeliefValueGoal.html#toString()">toString</a></code> in class <code><a href="../../bdi4jade/goal/BeliefValueGoal.html" title="class in bdi4jade.goal">BeliefValueGoal</a><<a href="../../bdi4jade/goal/BeliefSetValueGoal.html" title="type parameter in BeliefSetValueGoal">T</a>></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the string representation of this belief value goal.</dd><dt><span class="strong">See Also:</span></dt><dd><code>Object.toString()</code></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/BeliefSetValueGoal.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/BeliefGoal.html" title="class in bdi4jade.goal"><span class="strong">Prev Class</span></a></li>
<li><a href="../../bdi4jade/goal/BeliefValueGoal.html" title="class in bdi4jade.goal"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/goal/BeliefSetValueGoal.html" target="_top">Frames</a></li>
<li><a href="BeliefSetValueGoal.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>