<!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>Simulator</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="Simulator";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":10,"i6":10,"i7":10,"i8":9,"i9":10,"i10":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/MapField.html" title="class in model"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../index.html?model/Simulator.html" target="_top">Frames</a></li>
<li><a href="Simulator.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">model</div>
<h2 title="Class Simulator" class="title">Class Simulator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>model.Simulator</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">Simulator</span>
extends java.lang.Object</pre>
<div class="block">The Simulator class is the main class of the model package. It manages all
elements of the actual simulation, and passes any relevant information on
to World.</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"> </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 static java.util.ArrayList<<a href="../model/Carnivore.html" title="class in model">Carnivore</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Simulator.html#carnivorePopulation">carnivorePopulation</a></span></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static java.util.ArrayList<<a href="../model/Herbivore.html" title="class in model">Herbivore</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Simulator.html#herbivorePopulation">herbivorePopulation</a></span></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static <a href="../model/MapField.html" title="class in model">MapField</a>[][]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Simulator.html#map">map</a></span></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private java.util.Random</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Simulator.html#random">random</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="../model/Simulator.html#Simulator--">Simulator</a></span>()</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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="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>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Simulator.html#addAnimal-model.Animal-">addAnimal</a></span>(<a href="../model/Animal.html" title="class in model">Animal</a> a)</code>
<div class="block">Add an animal to the population</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../model/Animal.html" title="class in model">Animal</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Simulator.html#getAnimal-int-int-">getAnimal</a></span>(int x,
int y)</code>
<div class="block">Return the animal at (x, y), or null if there is no animal at that field.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../model/Carnivore.html" title="class in model">Carnivore</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Simulator.html#getCarnivore-int-int-">getCarnivore</a></span>(int x,
int y)</code>
<div class="block">Return the carnivore at (x, y), or null if there is no animal at that field.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../model/MapField.html" title="class in model">MapField</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Simulator.html#getField-int-int-">getField</a></span>(int x,
int y)</code>
<div class="block">Returns the field at the required position.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../model/Herbivore.html" title="class in model">Herbivore</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Simulator.html#getHerbivore-int-int-">getHerbivore</a></span>(int x,
int y)</code>
<div class="block">Return the herbivore at (x, y), or null if there is no animal at that field.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>private void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Simulator.html#initMap--">initMap</a></span>()</code>
<div class="block">Initialise the map.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>private void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Simulator.html#initPopulations--">initPopulations</a></span>()</code>
<div class="block">Initialise the animal populations.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>private void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Simulator.html#initWaterTiles--">initWaterTiles</a></span>()</code>
<div class="block">Initialise the water tiles.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Simulator.html#removeAnimal-int-int-controller.OccupantType-">removeAnimal</a></span>(int x,
int y,
<a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a> type)</code>
<div class="block">Remove an animal from the population</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Simulator.html#update--">update</a></span>()</code>
<div class="block">Updates the model each turn.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../model/Simulator.html#updateWorld--">updateWorld</a></span>()</code>
<div class="block">Send the current state of the simulation on to World</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="herbivorePopulation">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>herbivorePopulation</h4>
<pre>private static java.util.ArrayList<<a href="../model/Herbivore.html" title="class in model">Herbivore</a>> herbivorePopulation</pre>
</li>
</ul>
<a name="carnivorePopulation">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>carnivorePopulation</h4>
<pre>private static java.util.ArrayList<<a href="../model/Carnivore.html" title="class in model">Carnivore</a>> carnivorePopulation</pre>
</li>
</ul>
<a name="map">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>map</h4>
<pre>private static <a href="../model/MapField.html" title="class in model">MapField</a>[][] map</pre>
</li>
</ul>
<a name="random">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>random</h4>
<pre>private java.util.Random random</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Simulator--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Simulator</h4>
<pre>public Simulator()</pre>
<div class="block">The constructor.</div>
</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 void update()</pre>
<div class="block">Updates the model each turn.</div>
</li>
</ul>
<a name="updateWorld--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateWorld</h4>
<pre>public void updateWorld()</pre>
<div class="block">Send the current state of the simulation on to World</div>
</li>
</ul>
<a name="initMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initMap</h4>
<pre>private void initMap()</pre>
<div class="block">Initialise the map.</div>
</li>
</ul>
<a name="initWaterTiles--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initWaterTiles</h4>
<pre>private void initWaterTiles()</pre>
<div class="block">Initialise the water tiles.</div>
</li>
</ul>
<a name="initPopulations--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initPopulations</h4>
<pre>private void initPopulations()</pre>
<div class="block">Initialise the animal populations.</div>
</li>
</ul>
<a name="getField-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getField</h4>
<pre>public static <a href="../model/MapField.html" title="class in model">MapField</a> getField(int x,
int y)</pre>
<div class="block">Returns the field at the required position.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>x,</code> - y</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>MapField</dd>
</dl>
</li>
</ul>
<a name="getAnimal-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAnimal</h4>
<pre>public static <a href="../model/Animal.html" title="class in model">Animal</a> getAnimal(int x,
int y)</pre>
<div class="block">Return the animal at (x, y), or null if there is no animal at that field.</div>
</li>
</ul>
<a name="getHerbivore-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHerbivore</h4>
<pre>public static <a href="../model/Herbivore.html" title="class in model">Herbivore</a> getHerbivore(int x,
int y)</pre>
<div class="block">Return the herbivore at (x, y), or null if there is no animal at that field.</div>
</li>
</ul>
<a name="getCarnivore-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCarnivore</h4>
<pre>public static <a href="../model/Carnivore.html" title="class in model">Carnivore</a> getCarnivore(int x,
int y)</pre>
<div class="block">Return the carnivore at (x, y), or null if there is no animal at that field.</div>
</li>
</ul>
<a name="addAnimal-model.Animal-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addAnimal</h4>
<pre>public static void addAnimal(<a href="../model/Animal.html" title="class in model">Animal</a> a)</pre>
<div class="block">Add an animal to the population</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>animal</code> - </dd>
</dl>
</li>
</ul>
<a name="removeAnimal-int-int-controller.OccupantType-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeAnimal</h4>
<pre>public static void removeAnimal(int x,
int y,
<a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a> type)</pre>
<div class="block">Remove an animal from the population</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>x,</code> - y coordinates</dd>
<dd><code>type</code> - Make sure we are removing the right animal</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="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/MapField.html" title="class in model"><span class="typeNameLink">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../index.html?model/Simulator.html" target="_top">Frames</a></li>
<li><a href="Simulator.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>
