Newer
Older
ecologia / doc / javadoc / model / Carnivore.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_111) on Mon Dec 19 20:43:55 CET 2016 -->
<title>Carnivore</title>
<meta name="date" content="2016-12-19">
<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="Carnivore";
        }
    }
    catch(err) {
    }
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">Ecologia</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../model/Animal.html" title="class in model"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../model/Direction.html" title="enum in model"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?model/Carnivore.html" target="_top">Frames</a></li>
<li><a href="Carnivore.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>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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">model</div>
<h2 title="Class Carnivore" class="title">Class Carnivore</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../model/Animal.html" title="class in model">model.Animal</a></li>
<li>
<ul class="inheritance">
<li>model.Carnivore</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">Carnivore</span>
extends <a href="../model/Animal.html" title="class in model">Animal</a></pre>
<div class="block">This class simulates a carnivore.</div>
</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">&nbsp;</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>private <a href="../model/Direction.html" title="enum in model">Direction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Carnivore.html#currentDirection">currentDirection</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../model/Genome.html" title="class in model">Genome</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Carnivore.html#defaultGenome">defaultGenome</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Carnivore.html#fights_won">fights_won</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private int[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Carnivore.html#preyPosition">preyPosition</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Carnivore.html#total_fights">total_fights</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.model.Animal">
<!--   -->
</a>
<h3>Fields inherited from class&nbsp;model.<a href="../model/Animal.html" title="class in model">Animal</a></h3>
<code><a href="../model/Animal.html#age">age</a>, <a href="../model/Animal.html#attemptedMovesThisTurn">attemptedMovesThisTurn</a>, <a href="../model/Animal.html#energy">energy</a>, <a href="../model/Animal.html#exhaustion">exhaustion</a>, <a href="../model/Animal.html#generation">generation</a>, <a href="../model/Animal.html#genome">genome</a>, <a href="../model/Animal.html#gestationPeriod">gestationPeriod</a>, <a href="../model/Animal.html#IDnumber">IDnumber</a>, <a href="../model/Animal.html#isAlive">isAlive</a>, <a href="../model/Animal.html#movesThisTurn">movesThisTurn</a>, <a href="../model/Animal.html#offspring">offspring</a>, <a href="../model/Animal.html#parent">parent</a>, <a href="../model/Animal.html#random">random</a>, <a href="../model/Animal.html#type">type</a>, <a href="../model/Animal.html#x">x</a>, <a href="../model/Animal.html#y">y</a></code></li>
</ul>
</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="../model/Carnivore.html#Carnivore-int-model.Genome-int-int-int-int-int-">Carnivore</a></span>(int&nbsp;setID,
         <a href="../model/Genome.html" title="class in model">Genome</a>&nbsp;newGenome,
         int&nbsp;myGeneration,
         int&nbsp;setX,
         int&nbsp;setY,
         int&nbsp;setEnergy,
         int&nbsp;parentID)</code>
<div class="block">The constructor.</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>private void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Carnivore.html#attack--">attack</a></span>()</code>
<div class="block">The carnivore has run down a herbivore and now tries to kill it
 XXX Warning: here be magic numbers!</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>private void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Carnivore.html#hunt--">hunt</a></span>()</code>
<div class="block">The carnivore runs toward a herbivore</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>private boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Carnivore.html#strengthEnergyFight-int-int-int-int-">strengthEnergyFight</a></span>(int&nbsp;pred_str,
                   int&nbsp;pred_en,
                   int&nbsp;prey_str,
                   int&nbsp;prey_en)</code>
<div class="block">A fight method based on the strength and current energy of the combatants.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>private boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Carnivore.html#strengthFight-int-int-">strengthFight</a></span>(int&nbsp;predStrength,
             int&nbsp;preyStrength)</code>
<div class="block">A fight method based on the strength of the combatants.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Carnivore.html#update--">update</a></span>()</code>
<div class="block">Each turn, the carnivore looks for a herbivore and moves towards it.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.model.Animal">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;model.<a href="../model/Animal.html" title="class in model">Animal</a></h3>
<code><a href="../model/Animal.html#changeEnergy-int-">changeEnergy</a>, <a href="../model/Animal.html#closestSearch-controller.OccupantType-">closestSearch</a>, <a href="../model/Animal.html#exhaust-int-">exhaust</a>, <a href="../model/Animal.html#getAge--">getAge</a>, <a href="../model/Animal.html#getDirection-int-int-">getDirection</a>, <a href="../model/Animal.html#getDistance-int-int-">getDistance</a>, <a href="../model/Animal.html#getEnergy--">getEnergy</a>, <a href="../model/Animal.html#getGeneration--">getGeneration</a>, <a href="../model/Animal.html#getGenome--">getGenome</a>, <a href="../model/Animal.html#getID--">getID</a>, <a href="../model/Animal.html#getInfo--">getInfo</a>, <a href="../model/Animal.html#getNeighbouringField-model.Direction-">getNeighbouringField</a>, <a href="../model/Animal.html#getOffspring--">getOffspring</a>, <a href="../model/Animal.html#getParent--">getParent</a>, <a href="../model/Animal.html#getType--">getType</a>, <a href="../model/Animal.html#getX--">getX</a>, <a href="../model/Animal.html#getY--">getY</a>, <a href="../model/Animal.html#isAlive--">isAlive</a>, <a href="../model/Animal.html#mixedSearch-controller.OccupantType-">mixedSearch</a>, <a href="../model/Animal.html#move-model.Direction-">move</a>, <a href="../model/Animal.html#randomizedSearch-controller.OccupantType-">randomizedSearch</a>, <a href="../model/Animal.html#reproduce--">reproduce</a>, <a href="../model/Animal.html#search-controller.OccupantType-">search</a>, <a href="../model/Animal.html#setAge-int-">setAge</a>, <a href="../model/Animal.html#setEnergy-int-">setEnergy</a>, <a href="../model/Animal.html#setPosition-int-int-">setPosition</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&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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a name="fights_won">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fights_won</h4>
<pre>public static&nbsp;int fights_won</pre>
</li>
</ul>
<a name="total_fights">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>total_fights</h4>
<pre>public static&nbsp;int total_fights</pre>
</li>
</ul>
<a name="preyPosition">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preyPosition</h4>
<pre>private&nbsp;int[] preyPosition</pre>
</li>
</ul>
<a name="currentDirection">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>currentDirection</h4>
<pre>private&nbsp;<a href="../model/Direction.html" title="enum in model">Direction</a> currentDirection</pre>
</li>
</ul>
<a name="defaultGenome">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>defaultGenome</h4>
<pre>public static&nbsp;<a href="../model/Genome.html" title="class in model">Genome</a> defaultGenome</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="Carnivore-int-model.Genome-int-int-int-int-int-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Carnivore</h4>
<pre>public&nbsp;Carnivore(int&nbsp;setID,
                 <a href="../model/Genome.html" title="class in model">Genome</a>&nbsp;newGenome,
                 int&nbsp;myGeneration,
                 int&nbsp;setX,
                 int&nbsp;setY,
                 int&nbsp;setEnergy,
                 int&nbsp;parentID)</pre>
<div class="block">The constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>setID</code> - </dd>
<dd><code>newGenome</code> - </dd>
<dd><code>myGeneration</code> - </dd>
<dd><code>setX</code> - </dd>
<dd><code>setY</code> - </dd>
<dd><code>setEnergy</code> - </dd>
<dd><code>parentID</code> - </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="update--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>update</h4>
<pre>public&nbsp;void&nbsp;update()</pre>
<div class="block">Each turn, the carnivore looks for a herbivore and moves towards it.
 If no herbivore can be found, it moves in a random direction.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../model/Animal.html#update--">update</a></code>&nbsp;in class&nbsp;<code><a href="../model/Animal.html" title="class in model">Animal</a></code></dd>
</dl>
</li>
</ul>
<a name="hunt--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hunt</h4>
<pre>private&nbsp;void&nbsp;hunt()</pre>
<div class="block">The carnivore runs toward a herbivore</div>
</li>
</ul>
<a name="attack--">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>attack</h4>
<pre>private&nbsp;void&nbsp;attack()</pre>
<div class="block">The carnivore has run down a herbivore and now tries to kill it
 XXX Warning: here be magic numbers!</div>
</li>
</ul>
<a name="strengthEnergyFight-int-int-int-int-">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>strengthEnergyFight</h4>
<pre>private&nbsp;boolean&nbsp;strengthEnergyFight(int&nbsp;pred_str,
                                    int&nbsp;pred_en,
                                    int&nbsp;prey_str,
                                    int&nbsp;prey_en)</pre>
<div class="block">A fight method based on the strength and current energy of the combatants.
 This method is currently not used.</div>
</li>
</ul>
<a name="strengthFight-int-int-">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>strengthFight</h4>
<pre>private&nbsp;boolean&nbsp;strengthFight(int&nbsp;predStrength,
                              int&nbsp;preyStrength)</pre>
<div class="block">A fight method based on the strength of the combatants.
 This is the method currently employed.</div>
</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="package-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">Ecologia</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../model/Animal.html" title="class in model"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../model/Direction.html" title="enum in model"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?model/Carnivore.html" target="_top">Frames</a></li>
<li><a href="Carnivore.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>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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>