diff options
Diffstat (limited to 'doc/jcgp/backend/modules/Module.html')
| -rw-r--r-- | doc/jcgp/backend/modules/Module.html | 288 |
1 files changed, 0 insertions, 288 deletions
diff --git a/doc/jcgp/backend/modules/Module.html b/doc/jcgp/backend/modules/Module.html deleted file mode 100644 index 86a859e..0000000 --- a/doc/jcgp/backend/modules/Module.html +++ /dev/null @@ -1,288 +0,0 @@ -<!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_05) on Thu May 22 06:02:30 BST 2014 --> -<title>Module</title> -<meta name="date" content="2014-05-22"> -<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="Module"; - } - } - catch(err) { - } -//--> -var methods = {"i0":10,"i1":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/Module.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 Class</li> -<li>Next Class</li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?jcgp/backend/modules/Module.html" target="_top">Frames</a></li> -<li><a href="Module.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>Field | </li> -<li>Constr | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </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">jcgp.backend.modules</div> -<h2 title="Class Module" class="title">Class Module</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li>jcgp.backend.modules.Module</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>Direct Known Subclasses:</dt> -<dd><a href="../../../jcgp/backend/modules/es/EvolutionaryStrategy.html" title="class in jcgp.backend.modules.es">EvolutionaryStrategy</a>, <a href="../../../jcgp/backend/modules/mutator/Mutator.html" title="class in jcgp.backend.modules.mutator">Mutator</a>, <a href="../../../jcgp/backend/modules/problem/Problem.html" title="class in jcgp.backend.modules.problem">Problem</a></dd> -</dl> -<hr> -<br> -<pre>public abstract class <span class="typeNameLabel">Module</span> -extends java.lang.Object</pre> -<div class="block">This class defines the expected behaviour of a module. Generally, modules - are entities which contain parameters; these can be retrieved using - <code>getLocalParameters()</code>. GUIs should make use of this getter - to display visual parameter controls to users. Subclasses don't have direct - access to the list; instead they must use <code>registerParameter()</code> (ideally - in the constructor) to make sure the parameters are returned. - <br> - In addition, implementations of <code>Module</code> should specify a module name - in their constructor using <code>setName()</code>. If a name is not provided, - the simple name of the class will be used. - <br> - All modules, by definition, contain a reference to the experiment's resources, which - must be passed at construction. The resources should be accessed with <code>getResources()</code>.</div> -<dl> -<dt><span class="simpleTagLabel">Author:</span></dt> -<dd>Eduardo Pedroni</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters"><code>Parameter</code></a></dd> -</dl> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========== 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>java.util.ArrayList<<a href="../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a><?>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/modules/Module.html#getLocalParameters--">getLocalParameters</a></span>()</code> -<div class="block">This method is used by the GUI in order to build visual - representations of all parameters used by the module.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../jcgp/backend/modules/Module.html#toString--">toString</a></span>()</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>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="getLocalParameters--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getLocalParameters</h4> -<pre>public java.util.ArrayList<<a href="../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a><?>> getLocalParameters()</pre> -<div class="block">This method is used by the GUI in order to build visual - representations of all parameters used by the module. - Therefore, any parameters returned here will be displayed - visually.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>a list of generic parameters exposed by the module.</dd> -</dl> -</li> -</ul> -<a name="toString--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>toString</h4> -<pre>public java.lang.String toString()</pre> -<dl> -<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> -<dd><code>toString</code> in class <code>java.lang.Object</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/Module.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 Class</li> -<li>Next Class</li> -</ul> -<ul class="navList"> -<li><a href="../../../index.html?jcgp/backend/modules/Module.html" target="_top">Frames</a></li> -<li><a href="Module.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>Field | </li> -<li>Constr | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> |