diff options
| author | Eduardo Pedroni <ep625@york.ac.uk> | 2014-05-22 07:44:52 +0100 |
|---|---|---|
| committer | Eduardo Pedroni <ep625@york.ac.uk> | 2014-05-22 07:44:52 +0100 |
| commit | 2b571f08d091dc062cedbb9816c29dcf0cbd4f12 (patch) | |
| tree | 98505fe5fbd433eafe74a188f833b71a4627e08f /doc/jcgp/gui/GUI.html | |
| parent | 9aac9892b5c827e70c4598e0e052d10aad40a2d9 (diff) | |
Final commit, will release later today.
Diffstat (limited to 'doc/jcgp/gui/GUI.html')
| -rw-r--r-- | doc/jcgp/gui/GUI.html | 195 |
1 files changed, 170 insertions, 25 deletions
diff --git a/doc/jcgp/gui/GUI.html b/doc/jcgp/gui/GUI.html index 73bbe2a..c8274c9 100644 --- a/doc/jcgp/gui/GUI.html +++ b/doc/jcgp/gui/GUI.html @@ -2,9 +2,9 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_05) on Mon May 12 23:05:44 BST 2014 --> +<!-- Generated by javadoc (1.8.0_05) on Thu May 22 06:02:32 BST 2014 --> <title>GUI</title> -<meta name="date" content="2014-05-12"> +<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> @@ -124,7 +124,17 @@ extends javafx.application.Application</pre> The user interface is divided into 3 main components: the node grid (<a href="../../jcgp/gui/population/PopulationPane.html" title="class in jcgp.gui.population"><code>PopulationPane</code></a>), the control pane (<a href="../../jcgp/gui/settings/SettingsPane.html" title="class in jcgp.gui.settings"><code>SettingsPane</code></a>) and the console (<a href="../../jcgp/gui/console/ConsolePane.html" title="class in jcgp.gui.console"><code>ConsolePane</code></a>). Click on any of the links in - brackets to see more information about each interface component.</div> + brackets to see more information about each interface component. + <br><br> + This class also contains the instance of JCGP responsible for + running the experiments in GUI mode. JCGP's execution must be delegated + to a separate thread so that the GUI remains unblocked. This is done using + a JavaFX <code>Service</code> which calls <code>nextGeneration()</code> in a loop + until it is interrupted by the main JavaFX thread. + <br> + This service also handles flushing the console in a thread safe way. This + is done by synchronizing the <code>nextGeneration()</code> and <code>flush()</code> + method calls on a lock object.</div> <dl> <dt><span class="simpleTagLabel">Author:</span></dt> <dd>Eduardo Pedroni</dd> @@ -164,43 +174,66 @@ extends javafx.application.Application</pre> </tr> <tr class="altColor"> <td class="colFirst"><code>static java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#BAD_SELECTION_COLOUR">BAD_SELECTION_COLOUR</a></span></code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#BAD_SELECTION_COLOUR">BAD_SELECTION_COLOUR</a></span></code> +<div class="block">A string containing the hexadecimal colour used for representing a bad selection.</div> +</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static double</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#CONSOLE_MIN_HEIGHT">CONSOLE_MIN_HEIGHT</a></span></code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#CONSOLE_MIN_HEIGHT">CONSOLE_MIN_HEIGHT</a></span></code> +<div class="block">The minimum width of the console pane, to prevent it + from being resized beyond visibility.</div> +</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#GOOD_SELECTION_COLOUR">GOOD_SELECTION_COLOUR</a></span></code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#GOOD_SELECTION_COLOUR">GOOD_SELECTION_COLOUR</a></span></code> +<div class="block">A string containing the hexadecimal colour used for representing a good selection.</div> +</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#HARD_HIGHLIGHT_COLOUR">HARD_HIGHLIGHT_COLOUR</a></span></code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#HARD_HIGHLIGHT_COLOUR">HARD_HIGHLIGHT_COLOUR</a></span></code> +<div class="block">A string containing the hexadecimal colour used for representing a hard highlight.</div> +</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#MEDIUM_HIGHLIGHT_COLOUR">MEDIUM_HIGHLIGHT_COLOUR</a></span></code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#MEDIUM_HIGHLIGHT_COLOUR">MEDIUM_HIGHLIGHT_COLOUR</a></span></code> +<div class="block">A string containing the hexadecimal colour used for a medium highlight.</div> +</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#NEUTRAL_COLOUR">NEUTRAL_COLOUR</a></span></code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#NEUTRAL_COLOUR">NEUTRAL_COLOUR</a></span></code> +<div class="block">A string containing the hexadecimal colour used for representing neutrality.</div> +</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#NEUTRAL_SELECTION_COLOUR">NEUTRAL_SELECTION_COLOUR</a></span></code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#NEUTRAL_SELECTION_COLOUR">NEUTRAL_SELECTION_COLOUR</a></span></code> +<div class="block">A string containing the hexadecimal colour used for representing a neutral selection.</div> +</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static double</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#RESIZE_MARGIN">RESIZE_MARGIN</a></span></code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#RESIZE_MARGIN">RESIZE_MARGIN</a></span></code> +<div class="block">The width or height of the area that can be clicked on + to drag-resize a pane.</div> +</td> </tr> <tr class="altColor"> <td class="colFirst"><code>static double</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#SETTINGS_MIN_WIDTH">SETTINGS_MIN_WIDTH</a></span></code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#SETTINGS_MIN_WIDTH">SETTINGS_MIN_WIDTH</a></span></code> +<div class="block">The minimum width of the settings pane, to prevent it + from being resized beyond visibility.</div> +</td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#SOFT_HIGHLIGHT_COLOUR">SOFT_HIGHLIGHT_COLOUR</a></span></code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#SOFT_HIGHLIGHT_COLOUR">SOFT_HIGHLIGHT_COLOUR</a></span></code> +<div class="block">A string containing the hexadecimal colour used for a soft highlight.</div> +</td> </tr> </table> <ul class="blockList"> @@ -224,7 +257,9 @@ extends javafx.application.Application</pre> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#GUI--">GUI</a></span>()</code> </td> +<td class="colOne"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#GUI--">GUI</a></span>()</code> +<div class="block">Makes a new instance of GUI.</div> +</td> </tr> </table> </li> @@ -244,15 +279,22 @@ extends javafx.application.Application</pre> <tr id="i0" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#bringFunctionSelector-javafx.scene.input.MouseEvent-jcgp.gui.population.GUINode-">bringFunctionSelector</a></span>(javafx.scene.input.MouseEvent event, - <a href="../../jcgp/gui/population/GUINode.html" title="class in jcgp.gui.population">GUINode</a> node)</code> </td> + <a href="../../jcgp/gui/population/GUINode.html" title="class in jcgp.gui.population">GUINode</a> node)</code> +<div class="block">Relocate the function selector to the right position + relative to the specified node and set it visible.</div> +</td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#evaluateTestCase-jcgp.backend.modules.problem.TestCaseProblem.TestCase-">evaluateTestCase</a></span>(<a href="../../jcgp/backend/modules/problem/TestCaseProblem.TestCase.html" title="class in jcgp.backend.modules.problem">TestCaseProblem.TestCase</a><java.lang.Object> testCase)</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#evaluateTestCase-jcgp.backend.modules.problem.TestCaseProblem.TestCase-">evaluateTestCase</a></span>(<a href="../../jcgp/backend/modules/problem/TestCaseProblem.TestCase.html" title="class in jcgp.backend.modules.problem">TestCaseProblem.TestCase</a><java.lang.Object> testCase)</code> +<div class="block">Starts the evaluation process with the given test case.</div> +</td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#flushConsole--">flushConsole</a></span>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#flushConsole--">flushConsole</a></span>()</code> +<div class="block">Writes all buffered content out to the GUI console.</div> +</td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>int</code></td> @@ -268,7 +310,9 @@ extends javafx.application.Application</pre> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#hideGeneValues--">hideGeneValues</a></span>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#hideGeneValues--">hideGeneValues</a></span>()</code> +<div class="block">Hide all evaluated values.</div> +</td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>boolean</code></td> @@ -276,23 +320,33 @@ extends javafx.application.Application</pre> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>static void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#main-java.lang.String:A-">main</a></span>(java.lang.String[] args)</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#main-java.lang.String:A-">main</a></span>(java.lang.String[] args)</code> +<div class="block">Start JCGP with the user interface.</div> +</td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#reDraw--">reDraw</a></span>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#reDraw--">reDraw</a></span>()</code> +<div class="block">Does a complete GUI refresh.</div> +</td> </tr> <tr id="i10" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#reset--">reset</a></span>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#reset--">reset</a></span>()</code> +<div class="block">Reset button callback.</div> +</td> </tr> <tr id="i11" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#runPause--">runPause</a></span>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#runPause--">runPause</a></span>()</code> +<div class="block">Run/pause method.</div> +</td> </tr> <tr id="i12" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#setEvaluating-boolean-">setEvaluating</a></span>(boolean value)</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#setEvaluating-boolean-">setEvaluating</a></span>(boolean value)</code> +<div class="block">Set the system into evaluation mode.</div> +</td> </tr> <tr id="i13" class="rowColor"> <td class="colFirst"><code>void</code></td> @@ -300,11 +354,15 @@ extends javafx.application.Application</pre> </tr> <tr id="i14" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#step--">step</a></span>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#step--">step</a></span>()</code> +<div class="block">Perform a single generation using <code>nextGeneration()</code>.</div> +</td> </tr> <tr id="i15" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#updateFunctionSelector--">updateFunctionSelector</a></span>()</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../jcgp/gui/GUI.html#updateFunctionSelector--">updateFunctionSelector</a></span>()</code> +<div class="block">Refresh the function selector, used when functions are enabled or disabled.</div> +</td> </tr> </table> <ul class="blockList"> @@ -342,6 +400,7 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>NEUTRAL_COLOUR</h4> <pre>public static final java.lang.String NEUTRAL_COLOUR</pre> +<div class="block">A string containing the hexadecimal colour used for representing neutrality.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../constant-values.html#jcgp.gui.GUI.NEUTRAL_COLOUR">Constant Field Values</a></dd> @@ -355,6 +414,9 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>HARD_HIGHLIGHT_COLOUR</h4> <pre>public static final java.lang.String HARD_HIGHLIGHT_COLOUR</pre> +<div class="block">A string containing the hexadecimal colour used for representing a hard highlight. + A "hard" select, for instance, happens when an output path is locked on the chromosome + pane.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../constant-values.html#jcgp.gui.GUI.HARD_HIGHLIGHT_COLOUR">Constant Field Values</a></dd> @@ -368,6 +430,9 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>MEDIUM_HIGHLIGHT_COLOUR</h4> <pre>public static final java.lang.String MEDIUM_HIGHLIGHT_COLOUR</pre> +<div class="block">A string containing the hexadecimal colour used for a medium highlight. + One example of such a selection is the colour applied to a node + when it is hovered over.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../constant-values.html#jcgp.gui.GUI.MEDIUM_HIGHLIGHT_COLOUR">Constant Field Values</a></dd> @@ -381,6 +446,8 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>SOFT_HIGHLIGHT_COLOUR</h4> <pre>public static final java.lang.String SOFT_HIGHLIGHT_COLOUR</pre> +<div class="block">A string containing the hexadecimal colour used for a soft highlight. + When hovering over a node, its connections are soft-selected.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../constant-values.html#jcgp.gui.GUI.SOFT_HIGHLIGHT_COLOUR">Constant Field Values</a></dd> @@ -394,6 +461,8 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>GOOD_SELECTION_COLOUR</h4> <pre>public static final java.lang.String GOOD_SELECTION_COLOUR</pre> +<div class="block">A string containing the hexadecimal colour used for representing a good selection. + Ideally a shade of green, used for instance when a manual connection is valid.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../constant-values.html#jcgp.gui.GUI.GOOD_SELECTION_COLOUR">Constant Field Values</a></dd> @@ -407,6 +476,9 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>NEUTRAL_SELECTION_COLOUR</h4> <pre>public static final java.lang.String NEUTRAL_SELECTION_COLOUR</pre> +<div class="block">A string containing the hexadecimal colour used for representing a neutral selection. + Ideally a shade of yellow, used for instance when a manual connection is already the + current connection.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../constant-values.html#jcgp.gui.GUI.NEUTRAL_SELECTION_COLOUR">Constant Field Values</a></dd> @@ -420,6 +492,8 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>BAD_SELECTION_COLOUR</h4> <pre>public static final java.lang.String BAD_SELECTION_COLOUR</pre> +<div class="block">A string containing the hexadecimal colour used for representing a bad selection. + Ideally a shade of red, use for instance when a manual connection is not valid.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../constant-values.html#jcgp.gui.GUI.BAD_SELECTION_COLOUR">Constant Field Values</a></dd> @@ -433,6 +507,8 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>RESIZE_MARGIN</h4> <pre>public static final double RESIZE_MARGIN</pre> +<div class="block">The width or height of the area that can be clicked on + to drag-resize a pane.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../constant-values.html#jcgp.gui.GUI.RESIZE_MARGIN">Constant Field Values</a></dd> @@ -446,6 +522,8 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>SETTINGS_MIN_WIDTH</h4> <pre>public static final double SETTINGS_MIN_WIDTH</pre> +<div class="block">The minimum width of the settings pane, to prevent it + from being resized beyond visibility.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../constant-values.html#jcgp.gui.GUI.SETTINGS_MIN_WIDTH">Constant Field Values</a></dd> @@ -459,6 +537,8 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>CONSOLE_MIN_HEIGHT</h4> <pre>public static final double CONSOLE_MIN_HEIGHT</pre> +<div class="block">The minimum width of the console pane, to prevent it + from being resized beyond visibility.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../constant-values.html#jcgp.gui.GUI.CONSOLE_MIN_HEIGHT">Constant Field Values</a></dd> @@ -480,6 +560,9 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>GUI</h4> <pre>public GUI()</pre> +<div class="block">Makes a new instance of GUI. This initialises the JCGP experiment and + instantiates the function selector. It also creates the console flush task + and the service responsible for running the JCGP experiment.</div> </li> </ul> </li> @@ -497,6 +580,11 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>main</h4> <pre>public static void main(java.lang.String[] args)</pre> +<div class="block">Start JCGP with the user interface.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>args</code> - no arguments are used.</dd> +</dl> </li> </ul> <a name="start-javafx.stage.Stage-"> @@ -522,6 +610,11 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>runPause</h4> <pre>public void runPause()</pre> +<div class="block">Run/pause method. + Run the experiment if it is paused, or pause it if it is running. + <br> + This method is the callback used by the run/pause button. It + controls the jcgp service.</div> </li> </ul> <a name="step--"> @@ -531,6 +624,11 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>step</h4> <pre>public void step()</pre> +<div class="block">Perform a single generation using <code>nextGeneration()</code>. + <br> + On top of that, this method performs all of the housekeeping + that is normally done before and after running, such as + refreshing the chromosome panes.</div> </li> </ul> <a name="reset--"> @@ -540,6 +638,9 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>reset</h4> <pre>public void reset()</pre> +<div class="block">Reset button callback. If the parameters are valid, + this resets the entire experiment by calling <code>reset()</code> + on jcgp.</div> </li> </ul> <a name="reDraw--"> @@ -549,6 +650,8 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>reDraw</h4> <pre>public void reDraw()</pre> +<div class="block">Does a complete GUI refresh. + This is potentially lengthy, so use with care.</div> </li> </ul> <a name="updateFunctionSelector--"> @@ -558,6 +661,7 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>updateFunctionSelector</h4> <pre>public void updateFunctionSelector()</pre> +<div class="block">Refresh the function selector, used when functions are enabled or disabled.</div> </li> </ul> <a name="isWorking--"> @@ -567,6 +671,10 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>isWorking</h4> <pre>public boolean isWorking()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if jcgp is evolving.</dd> +</dl> </li> </ul> <a name="bringFunctionSelector-javafx.scene.input.MouseEvent-jcgp.gui.population.GUINode-"> @@ -577,6 +685,13 @@ extends javafx.application.Application</pre> <h4>bringFunctionSelector</h4> <pre>public void bringFunctionSelector(javafx.scene.input.MouseEvent event, <a href="../../jcgp/gui/population/GUINode.html" title="class in jcgp.gui.population">GUINode</a> node)</pre> +<div class="block">Relocate the function selector to the right position + relative to the specified node and set it visible.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>event</code> - the mouse event containing cursor coordinates.</dd> +<dd><code>node</code> - the node whose function should be changed.</dd> +</dl> </li> </ul> <a name="getExperiment--"> @@ -586,6 +701,10 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>getExperiment</h4> <pre>public <a href="../../jcgp/JCGP.html" title="class in jcgp">JCGP</a> getExperiment()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to the <code>JCGP</code> experiment.</dd> +</dl> </li> </ul> <a name="evaluateTestCase-jcgp.backend.modules.problem.TestCaseProblem.TestCase-"> @@ -595,6 +714,13 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>evaluateTestCase</h4> <pre>public void evaluateTestCase(<a href="../../jcgp/backend/modules/problem/TestCaseProblem.TestCase.html" title="class in jcgp.backend.modules.problem">TestCaseProblem.TestCase</a><java.lang.Object> testCase)</pre> +<div class="block">Starts the evaluation process with the given test case. + It does so by calling <code>evaluateTestCase()</code> on + the population pane.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>testCase</code> - the test case to evaluate.</dd> +</dl> </li> </ul> <a name="hideGeneValues--"> @@ -604,6 +730,8 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>hideGeneValues</h4> <pre>public void hideGeneValues()</pre> +<div class="block">Hide all evaluated values. This should be called when + evaluations are no longer being performed.</div> </li> </ul> <a name="setEvaluating-boolean-"> @@ -613,6 +741,14 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>setEvaluating</h4> <pre>public void setEvaluating(boolean value)</pre> +<div class="block">Set the system into evaluation mode. + When in evaluation mode, the population pane + refreshes the node values whenever connection + changes happen.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - true if evaluations are happening, false otherwise.</dd> +</dl> </li> </ul> <a name="getStage--"> @@ -622,6 +758,10 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>getStage</h4> <pre>public javafx.stage.Stage getStage()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to the GUI stage.</dd> +</dl> </li> </ul> <a name="flushConsole--"> @@ -631,6 +771,7 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>flushConsole</h4> <pre>public void flushConsole()</pre> +<div class="block">Writes all buffered content out to the GUI console.</div> </li> </ul> <a name="getChromosomeIndex--"> @@ -640,6 +781,10 @@ extends javafx.application.Application</pre> <li class="blockList"> <h4>getChromosomeIndex</h4> <pre>public int getChromosomeIndex()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the index of the chromosome currently being looked at.</dd> +</dl> </li> </ul> </li> |