diff options
| author | Eduardo Pedroni <ep625@york.ac.uk> | 2014-05-06 14:29:37 +0100 |
|---|---|---|
| committer | Eduardo Pedroni <ep625@york.ac.uk> | 2014-05-06 14:29:37 +0100 |
| commit | 8189116ea4b5db4675e31dfd04a5687d55e29262 (patch) | |
| tree | c1815021452a888f8838f1628d8fb4689777e73e /doc/jcgp/backend/parameters/class-use/Parameter.html | |
| parent | aa9e74e7f67789f6353fc26e02ee8e68e40609a2 (diff) | |
Added javadocs, made minor changes to the comments
Diffstat (limited to 'doc/jcgp/backend/parameters/class-use/Parameter.html')
| -rw-r--r-- | doc/jcgp/backend/parameters/class-use/Parameter.html | 267 |
1 files changed, 267 insertions, 0 deletions
diff --git a/doc/jcgp/backend/parameters/class-use/Parameter.html b/doc/jcgp/backend/parameters/class-use/Parameter.html new file mode 100644 index 0000000..7d037b6 --- /dev/null +++ b/doc/jcgp/backend/parameters/class-use/Parameter.html @@ -0,0 +1,267 @@ +<!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 Tue May 06 14:28:07 BST 2014 --> +<title>Uses of Class jcgp.backend.parameters.Parameter</title> +<meta name="date" content="2014-05-06"> +<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="Uses of Class jcgp.backend.parameters.Parameter"; + } + } + catch(err) { + } +//--> +</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><a href="../../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?jcgp/backend/parameters/class-use/Parameter.html" target="_top">Frames</a></li> +<li><a href="Parameter.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class jcgp.backend.parameters.Parameter" class="title">Uses of Class<br>jcgp.backend.parameters.Parameter</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#jcgp.backend.modules">jcgp.backend.modules</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#jcgp.backend.parameters">jcgp.backend.parameters</a></td> +<td class="colLast"> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#jcgp.backend.parameters.monitors">jcgp.backend.parameters.monitors</a></td> +<td class="colLast"> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#jcgp.gui.settings.parameters">jcgp.gui.settings.parameters</a></td> +<td class="colLast"> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="jcgp.backend.modules"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a> in <a href="../../../../jcgp/backend/modules/package-summary.html">jcgp.backend.modules</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../jcgp/backend/modules/package-summary.html">jcgp.backend.modules</a> that return types with arguments of type <a href="../../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr 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"><span class="typeNameLabel">Module.</span><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> +</tbody> +</table> +</li> +<li class="blockList"><a name="jcgp.backend.parameters"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a> in <a href="../../../../jcgp/backend/parameters/package-summary.html">jcgp.backend.parameters</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a> in <a href="../../../../jcgp/backend/parameters/package-summary.html">jcgp.backend.parameters</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/parameters/BooleanParameter.html" title="class in jcgp.backend.parameters">BooleanParameter</a></span></code> +<div class="block">Parameter subclass for the boolean type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/parameters/DoubleParameter.html" title="class in jcgp.backend.parameters">DoubleParameter</a></span></code> +<div class="block">Parameter subclass for the double type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/parameters/IntegerParameter.html" title="class in jcgp.backend.parameters">IntegerParameter</a></span></code> +<div class="block">Parameter subclass for the double type.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="jcgp.backend.parameters.monitors"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a> in <a href="../../../../jcgp/backend/parameters/monitors/package-summary.html">jcgp.backend.parameters.monitors</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a> in <a href="../../../../jcgp/backend/parameters/monitors/package-summary.html">jcgp.backend.parameters.monitors</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/parameters/monitors/BooleanMonitor.html" title="class in jcgp.backend.parameters.monitors">BooleanMonitor</a></span></code> +<div class="block">This is a special type of <code>BooleanParameter</code> which + cannot be modified in the GUI (if the GUI is in use).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/parameters/monitors/DoubleMonitor.html" title="class in jcgp.backend.parameters.monitors">DoubleMonitor</a></span></code> +<div class="block">This is a special type of <code>DoubleParameter</code> which + cannot be modified in the GUI (if the GUI is in use).</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jcgp/backend/parameters/monitors/IntegerMonitor.html" title="class in jcgp.backend.parameters.monitors">IntegerMonitor</a></span></code> +<div class="block">This is a special type of <code>IntegerParameter</code> which + cannot be modified in the GUI (if the GUI is in use).</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="jcgp.gui.settings.parameters"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a> in <a href="../../../../jcgp/gui/settings/parameters/package-summary.html">jcgp.gui.settings.parameters</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../jcgp/gui/settings/parameters/package-summary.html">jcgp.gui.settings.parameters</a> with parameters of type <a href="../../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../jcgp/gui/settings/parameters/GUIParameter.html" title="class in jcgp.gui.settings.parameters">GUIParameter</a><?></code></td> +<td class="colLast"><span class="typeNameLabel">GUIParameter.</span><code><span class="memberNameLink"><a href="../../../../jcgp/gui/settings/parameters/GUIParameter.html#create-jcgp.backend.parameters.Parameter-jcgp.gui.settings.SettingsPane-">create</a></span>(<a href="../../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Parameter</a><?> parameter, + <a href="../../../../jcgp/gui/settings/SettingsPane.html" title="class in jcgp.gui.settings">SettingsPane</a> sp)</code> +<div class="block">Factory method to create @code{GUIParameter}s from @code{Parameter}s.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</div> +<!-- ======= 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><a href="../../../../jcgp/backend/parameters/Parameter.html" title="class in jcgp.backend.parameters">Class</a></li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?jcgp/backend/parameters/class-use/Parameter.html" target="_top">Frames</a></li> +<li><a href="Parameter.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> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> |