BeliefEvent.html

501 lines | 18.455 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) on Sat Sep 13 16:54:21 BRT 2014 -->
<title>BeliefEvent</title>
<meta name="date" content="2014-09-13">
<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="BeliefEvent";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":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/BeliefEvent.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>Prev&nbsp;Class</li>
<li><a href="../../bdi4jade/event/BeliefEvent.Action.html" title="enum in bdi4jade.event"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/event/BeliefEvent.html" target="_top">Frames</a></li>
<li><a href="BeliefEvent.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.event</div>
<h2 title="Class BeliefEvent" class="title">Class BeliefEvent</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>bdi4jade.event.BeliefEvent</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>jade.content.AgentAction, jade.content.Concept, jade.content.ContentElement, jade.content.Term, java.io.Serializable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">BeliefEvent</span>
extends java.lang.Object
implements jade.content.AgentAction</pre>
<div class="block">This class represents an event performed over a belief.</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.event.BeliefEvent">Serialized Form</a></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>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/event/BeliefEvent.Action.html" title="enum in bdi4jade.event">BeliefEvent.Action</a></span></code>
<div class="block">This enumeration represents the set of possible actions that can be
 performed over a belief.</div>
</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">&nbsp;</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/event/BeliefEvent.html#BeliefEvent--">BeliefEvent</a></span>()</code>
<div class="block">Default constructor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../bdi4jade/event/BeliefEvent.html#BeliefEvent-bdi4jade.belief.Belief-">BeliefEvent</a></span>(<a href="../../bdi4jade/belief/Belief.html" title="interface in bdi4jade.belief">Belief</a>&lt;?,?&gt;&nbsp;belief)</code>
<div class="block">Creates a belief event.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../bdi4jade/event/BeliefEvent.html#BeliefEvent-bdi4jade.belief.Belief-bdi4jade.event.BeliefEvent.Action-">BeliefEvent</a></span>(<a href="../../bdi4jade/belief/Belief.html" title="interface in bdi4jade.belief">Belief</a>&lt;?,?&gt;&nbsp;belief,
           <a href="../../bdi4jade/event/BeliefEvent.Action.html" title="enum in bdi4jade.event">BeliefEvent.Action</a>&nbsp;action)</code>
<div class="block">Creates a belief event.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../bdi4jade/event/BeliefEvent.html#BeliefEvent-bdi4jade.belief.Belief-bdi4jade.event.BeliefEvent.Action-java.lang.Object-">BeliefEvent</a></span>(<a href="../../bdi4jade/belief/Belief.html" title="interface in bdi4jade.belief">Belief</a>&lt;?,?&gt;&nbsp;belief,
           <a href="../../bdi4jade/event/BeliefEvent.Action.html" title="enum in bdi4jade.event">BeliefEvent.Action</a>&nbsp;action,
           java.lang.Object&nbsp;args)</code>
<div class="block">Creates a belief event.</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><a href="../../bdi4jade/event/BeliefEvent.Action.html" title="enum in bdi4jade.event">BeliefEvent.Action</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/event/BeliefEvent.html#getAction--">getAction</a></span>()</code>
<div class="block">Returns the action performed.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/event/BeliefEvent.html#getArgs--">getArgs</a></span>()</code>
<div class="block">Returns arguments associated with the action performed.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../bdi4jade/belief/Belief.html" title="interface in bdi4jade.belief">Belief</a>&lt;?,?&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/event/BeliefEvent.html#getBelief--">getBelief</a></span>()</code>
<div class="block">Returns the belief over which the event has occurred.</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/event/BeliefEvent.html#setAction-bdi4jade.event.BeliefEvent.Action-">setAction</a></span>(<a href="../../bdi4jade/event/BeliefEvent.Action.html" title="enum in bdi4jade.event">BeliefEvent.Action</a>&nbsp;action)</code>
<div class="block">Sets the action performed.</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/event/BeliefEvent.html#setArgs-java.lang.Object-">setArgs</a></span>(java.lang.Object&nbsp;args)</code>
<div class="block">Sets the arguments associated with the action performed.</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/event/BeliefEvent.html#setBelief-bdi4jade.belief.Belief-">setBelief</a></span>(<a href="../../bdi4jade/belief/Belief.html" title="interface in bdi4jade.belief">Belief</a>&lt;?,?&gt;&nbsp;belief)</code>
<div class="block">Sets the belief over which the event has occurred.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/event/BeliefEvent.html#toString--">toString</a></span>()</code>&nbsp;</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, 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="BeliefEvent--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BeliefEvent</h4>
<pre>public&nbsp;BeliefEvent()</pre>
<div class="block">Default constructor.</div>
</li>
</ul>
<a name="BeliefEvent-bdi4jade.belief.Belief-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BeliefEvent</h4>
<pre>public&nbsp;BeliefEvent(<a href="../../bdi4jade/belief/Belief.html" title="interface in bdi4jade.belief">Belief</a>&lt;?,?&gt;&nbsp;belief)</pre>
<div class="block">Creates a belief event.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>belief</code> - the belief over which the event has occurred.</dd>
</dl>
</li>
</ul>
<a name="BeliefEvent-bdi4jade.belief.Belief-bdi4jade.event.BeliefEvent.Action-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BeliefEvent</h4>
<pre>public&nbsp;BeliefEvent(<a href="../../bdi4jade/belief/Belief.html" title="interface in bdi4jade.belief">Belief</a>&lt;?,?&gt;&nbsp;belief,
                   <a href="../../bdi4jade/event/BeliefEvent.Action.html" title="enum in bdi4jade.event">BeliefEvent.Action</a>&nbsp;action)</pre>
<div class="block">Creates a belief event.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>belief</code> - the belief over which the event has occurred.</dd>
<dd><code>action</code> - the action performed.</dd>
</dl>
</li>
</ul>
<a name="BeliefEvent-bdi4jade.belief.Belief-bdi4jade.event.BeliefEvent.Action-java.lang.Object-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BeliefEvent</h4>
<pre>public&nbsp;BeliefEvent(<a href="../../bdi4jade/belief/Belief.html" title="interface in bdi4jade.belief">Belief</a>&lt;?,?&gt;&nbsp;belief,
                   <a href="../../bdi4jade/event/BeliefEvent.Action.html" title="enum in bdi4jade.event">BeliefEvent.Action</a>&nbsp;action,
                   java.lang.Object&nbsp;args)</pre>
<div class="block">Creates a belief event.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>belief</code> - the belief over which the event has occurred.</dd>
<dd><code>action</code> - the action performed.</dd>
<dd><code>args</code> - an argument passed for this action.</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="getAction--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAction</h4>
<pre>public&nbsp;<a href="../../bdi4jade/event/BeliefEvent.Action.html" title="enum in bdi4jade.event">BeliefEvent.Action</a>&nbsp;getAction()</pre>
<div class="block">Returns the action performed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the action</dd>
</dl>
</li>
</ul>
<a name="getArgs--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getArgs</h4>
<pre>public&nbsp;java.lang.Object&nbsp;getArgs()</pre>
<div class="block">Returns arguments associated with the action performed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the args</dd>
</dl>
</li>
</ul>
<a name="getBelief--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBelief</h4>
<pre>public&nbsp;<a href="../../bdi4jade/belief/Belief.html" title="interface in bdi4jade.belief">Belief</a>&lt;?,?&gt;&nbsp;getBelief()</pre>
<div class="block">Returns the belief over which the event has occurred.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the belief</dd>
</dl>
</li>
</ul>
<a name="setAction-bdi4jade.event.BeliefEvent.Action-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAction</h4>
<pre>public&nbsp;void&nbsp;setAction(<a href="../../bdi4jade/event/BeliefEvent.Action.html" title="enum in bdi4jade.event">BeliefEvent.Action</a>&nbsp;action)</pre>
<div class="block">Sets the action performed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>action</code> - the action to set.</dd>
</dl>
</li>
</ul>
<a name="setArgs-java.lang.Object-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setArgs</h4>
<pre>public&nbsp;void&nbsp;setArgs(java.lang.Object&nbsp;args)</pre>
<div class="block">Sets the arguments associated with the action performed.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>args</code> - the args to set.</dd>
</dl>
</li>
</ul>
<a name="setBelief-bdi4jade.belief.Belief-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBelief</h4>
<pre>public&nbsp;void&nbsp;setBelief(<a href="../../bdi4jade/belief/Belief.html" title="interface in bdi4jade.belief">Belief</a>&lt;?,?&gt;&nbsp;belief)</pre>
<div class="block">Sets the belief over which the event has occurred.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>belief</code> - the belief to set.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
<dt><span class="seeLabel">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>
<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/BeliefEvent.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>Prev&nbsp;Class</li>
<li><a href="../../bdi4jade/event/BeliefEvent.Action.html" title="enum in bdi4jade.event"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/event/BeliefEvent.html" target="_top">Frames</a></li>
<li><a href="BeliefEvent.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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>