<!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>EcologiaIO</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="EcologiaIO";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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="../main/Ecologia.html" title="class in main"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../main/EcoTest.html" title="class in main"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?main/EcologiaIO.html" target="_top">Frames</a></li>
<li><a href="EcologiaIO.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">main</div>
<h2 title="Class EcologiaIO" class="title">Class EcologiaIO</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>main.EcologiaIO</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">EcologiaIO</span>
extends java.lang.Object</pre>
<div class="block">This class provides unified I/O methods for debugging,
logging, error messages, 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>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../main/EcologiaIO.html#analysing">analysing</a></span></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../main/EcologiaIO.html#BREAK_ERROR">BREAK_ERROR</a></span></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../main/EcologiaIO.html#CONTINUABLE_ERROR">CONTINUABLE_ERROR</a></span></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../main/EcologiaIO.html#debugging">debugging</a></span></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../main/EcologiaIO.html#FATAL_ERROR">FATAL_ERROR</a></span></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../main/EcologiaIO.html#logging">logging</a></span></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../main/EcologiaIO.html#verbose">verbose</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="../main/EcologiaIO.html#EcologiaIO--">EcologiaIO</a></span>()</code> </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="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="../main/EcologiaIO.html#analysis-java.lang.String-">analysis</a></span>(java.lang.String message)</code>
<div class="block">Print an analysis message if the analysing flag is set.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../main/EcologiaIO.html#archiveLog--">archiveLog</a></span>()</code>
<div class="block">Archive the current log file, ready for a new run</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../main/EcologiaIO.html#debug-java.lang.String-">debug</a></span>(java.lang.String message)</code>
<div class="block">Print a debug message if the debug flag is set.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../main/EcologiaIO.html#error-java.lang.String-">error</a></span>(java.lang.String message)</code>
<div class="block">Print an error message</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../main/EcologiaIO.html#error-java.lang.String-java.lang.Exception-">error</a></span>(java.lang.String message,
java.lang.Exception error)</code>
<div class="block">Print an error message and the stack trace</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../main/EcologiaIO.html#error-java.lang.String-int-">error</a></span>(java.lang.String message,
int errorType)</code>
<div class="block">Give an error message and pause/shut down</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>private static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../main/EcologiaIO.html#getDate--">getDate</a></span>()</code> </td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../main/EcologiaIO.html#log-java.lang.String-">log</a></span>(java.lang.String message)</code>
<div class="block">Print a log message if the verbose flag is set.</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="../main/EcologiaIO.html#printStatus--">printStatus</a></span>()</code>
<div class="block">Print out which flags are set.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>private static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../main/EcologiaIO.html#writeFile-java.lang.String-">writeFile</a></span>(java.lang.String message)</code>
<div class="block">Write a message to file</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="verbose">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verbose</h4>
<pre>public static boolean verbose</pre>
</li>
</ul>
<a name="debugging">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>debugging</h4>
<pre>public static boolean debugging</pre>
</li>
</ul>
<a name="analysing">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>analysing</h4>
<pre>public static boolean analysing</pre>
</li>
</ul>
<a name="logging">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>logging</h4>
<pre>public static boolean logging</pre>
</li>
</ul>
<a name="CONTINUABLE_ERROR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CONTINUABLE_ERROR</h4>
<pre>public static final int CONTINUABLE_ERROR</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../constant-values.html#main.EcologiaIO.CONTINUABLE_ERROR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="BREAK_ERROR">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BREAK_ERROR</h4>
<pre>public static final int BREAK_ERROR</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../constant-values.html#main.EcologiaIO.BREAK_ERROR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="FATAL_ERROR">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FATAL_ERROR</h4>
<pre>public static final int FATAL_ERROR</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../constant-values.html#main.EcologiaIO.FATAL_ERROR">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="EcologiaIO--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EcologiaIO</h4>
<pre>public EcologiaIO()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="log-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>log</h4>
<pre>public static void log(java.lang.String message)</pre>
<div class="block">Print a log message if the verbose flag is set.
This is meant to be used for important runtime events in the program,
and for fundamental (e.g. birth and death) events during the simulation.
For more detailed output, use either debug() or analysis().</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - </dd>
</dl>
</li>
</ul>
<a name="debug-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>debug</h4>
<pre>public static void debug(java.lang.String message)</pre>
<div class="block">Print a debug message if the debug flag is set.
This is primarily intended for use during development.
Experimental data should go to analysis(), important
messages to log().</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - </dd>
</dl>
</li>
</ul>
<a name="analysis-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>analysis</h4>
<pre>public static void analysis(java.lang.String message)</pre>
<div class="block">Print an analysis message if the analysing flag is set.
This is meant to be used for simulation data output relevant only to a
current experiment.
FIXME A lot of analysis() calls slow the program down drastically.
Implement caching?</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - </dd>
</dl>
</li>
</ul>
<a name="error-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>error</h4>
<pre>public static void error(java.lang.String message)</pre>
<div class="block">Print an error message</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - </dd>
</dl>
</li>
</ul>
<a name="error-java.lang.String-java.lang.Exception-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>error</h4>
<pre>public static void error(java.lang.String message,
java.lang.Exception error)</pre>
<div class="block">Print an error message and the stack trace</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - </dd>
<dd><code>error</code> - </dd>
</dl>
</li>
</ul>
<a name="error-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>error</h4>
<pre>public static void error(java.lang.String message,
int errorType)</pre>
<div class="block">Give an error message and pause/shut down</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>message</code> - </dd>
<dd><code>errorType</code> - CONTINUABLE_ERROR, BREAK_ERROR, FATAL_ERROR</dd>
</dl>
</li>
</ul>
<a name="archiveLog--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>archiveLog</h4>
<pre>public static void archiveLog()</pre>
<div class="block">Archive the current log file, ready for a new run</div>
</li>
</ul>
<a name="printStatus--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printStatus</h4>
<pre>public static void printStatus()</pre>
<div class="block">Print out which flags are set.</div>
</li>
</ul>
<a name="writeFile-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeFile</h4>
<pre>private static void writeFile(java.lang.String message)</pre>
<div class="block">Write a message to file</div>
</li>
</ul>
<a name="getDate--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDate</h4>
<pre>private static java.lang.String getDate()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>time stamp</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="../main/Ecologia.html" title="class in main"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../main/EcoTest.html" title="class in main"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../index.html?main/EcologiaIO.html" target="_top">Frames</a></li>
<li><a href="EcologiaIO.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>
