<!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>MapField</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="MapField"; } } catch(err) { } //--> var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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/Herbivore.html" title="class in model"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../model/Simulator.html" title="class in model"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../index.html?model/MapField.html" target="_top">Frames</a></li> <li><a href="MapField.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 MapField" class="title">Class MapField</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>model.MapField</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="typeNameLabel">MapField</span> extends java.lang.Object</pre> <div class="block">This is a representation of a discrete area (tile) on the map. It monitors what animals are on it, what it's grass density is, etc.</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 int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/MapField.html#grassDensity">grassDensity</a></span></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>private boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/MapField.html#isNearWater">isNearWater</a></span></code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>private <a href="../controller/Humidity.html" title="enum in controller">Humidity</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/MapField.html#localHumidity">localHumidity</a></span></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>private <a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/MapField.html#occupant">occupant</a></span></code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>private int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/MapField.html#x">x</a></span></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>private int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/MapField.html#y">y</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/MapField.html#MapField-int-int-controller.OccupantType-controller.Humidity-int-">MapField</a></span>(int xstart, int ystart, <a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a> newOccupant, <a href="../controller/Humidity.html" title="enum in controller">Humidity</a> startingHumidity, int startingGrassDensity)</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="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>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/MapField.html#calculateGrassDensity--">calculateGrassDensity</a></span>()</code> <div class="block">Recalculate the grass density based on humidity values.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/MapField.html#getGrassDensity--">getGrassDensity</a></span>()</code> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>java.util.HashMap<java.lang.String,java.lang.Integer></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/MapField.html#getInfo--">getInfo</a></span>()</code> <div class="block">Return a hash map containing all the information about this field.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code><a href="../controller/Humidity.html" title="enum in controller">Humidity</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/MapField.html#getLocalHumidity--">getLocalHumidity</a></span>()</code> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code><a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/MapField.html#getOccupant--">getOccupant</a></span>()</code> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/MapField.html#nearWater--">nearWater</a></span>()</code> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/MapField.html#reduceGrassDensity-int-">reduceGrassDensity</a></span>(int amount)</code> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/MapField.html#setLocalHumidity-controller.Humidity-">setLocalHumidity</a></span>(<a href="../controller/Humidity.html" title="enum in controller">Humidity</a> localHumidity)</code> </td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/MapField.html#setNearWater-boolean-">setNearWater</a></span>(boolean newValue)</code> </td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../model/MapField.html#setOccupant-controller.OccupantType-">setOccupant</a></span>(<a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a> occupant)</code> </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="x"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>x</h4> <pre>private int x</pre> </li> </ul> <a name="y"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>y</h4> <pre>private int y</pre> </li> </ul> <a name="grassDensity"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>grassDensity</h4> <pre>private int grassDensity</pre> </li> </ul> <a name="isNearWater"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isNearWater</h4> <pre>private boolean isNearWater</pre> </li> </ul> <a name="localHumidity"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>localHumidity</h4> <pre>private <a href="../controller/Humidity.html" title="enum in controller">Humidity</a> localHumidity</pre> </li> </ul> <a name="occupant"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>occupant</h4> <pre>private <a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a> occupant</pre> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="MapField-int-int-controller.OccupantType-controller.Humidity-int-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>MapField</h4> <pre>public MapField(int xstart, int ystart, <a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a> newOccupant, <a href="../controller/Humidity.html" title="enum in controller">Humidity</a> startingHumidity, int startingGrassDensity)</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="calculateGrassDensity--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>calculateGrassDensity</h4> <pre>public void calculateGrassDensity()</pre> <div class="block">Recalculate the grass density based on humidity values. Min: 0 Max: 100</div> </li> </ul> <a name="getInfo--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getInfo</h4> <pre>public java.util.HashMap<java.lang.String,java.lang.Integer> getInfo()</pre> <div class="block">Return a hash map containing all the information about this field.</div> </li> </ul> <a name="setNearWater-boolean-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setNearWater</h4> <pre>public void setNearWater(boolean newValue)</pre> </li> </ul> <a name="nearWater--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>nearWater</h4> <pre>public boolean nearWater()</pre> </li> </ul> <a name="getGrassDensity--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getGrassDensity</h4> <pre>public int getGrassDensity()</pre> </li> </ul> <a name="getOccupant--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getOccupant</h4> <pre>public <a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a> getOccupant()</pre> </li> </ul> <a name="setOccupant-controller.OccupantType-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setOccupant</h4> <pre>public void setOccupant(<a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a> occupant)</pre> </li> </ul> <a name="getLocalHumidity--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getLocalHumidity</h4> <pre>public <a href="../controller/Humidity.html" title="enum in controller">Humidity</a> getLocalHumidity()</pre> </li> </ul> <a name="setLocalHumidity-controller.Humidity-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setLocalHumidity</h4> <pre>public void setLocalHumidity(<a href="../controller/Humidity.html" title="enum in controller">Humidity</a> localHumidity)</pre> </li> </ul> <a name="reduceGrassDensity-int-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>reduceGrassDensity</h4> <pre>public void reduceGrassDensity(int amount)</pre> </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/Herbivore.html" title="class in model"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../model/Simulator.html" title="class in model"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../index.html?model/MapField.html" target="_top">Frames</a></li> <li><a href="MapField.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>