1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
---|
2 | <!-- NewPage -->
|
---|
3 | <html lang="en">
|
---|
4 | <head>
|
---|
5 | <!-- Generated by javadoc (1.8.0_112) on Thu Jun 21 12:05:56 CEST 2018 -->
|
---|
6 | <title>BOAparameter (Genius Core Documentation)</title>
|
---|
7 | <meta name="date" content="2018-06-21">
|
---|
8 | <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
|
---|
9 | <script type="text/javascript" src="../../../script.js"></script>
|
---|
10 | </head>
|
---|
11 | <body>
|
---|
12 | <script type="text/javascript"><!--
|
---|
13 | try {
|
---|
14 | if (location.href.indexOf('is-external=true') == -1) {
|
---|
15 | parent.document.title="BOAparameter (Genius Core Documentation)";
|
---|
16 | }
|
---|
17 | }
|
---|
18 | catch(err) {
|
---|
19 | }
|
---|
20 | //-->
|
---|
21 | var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10};
|
---|
22 | var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
---|
23 | var altColor = "altColor";
|
---|
24 | var rowColor = "rowColor";
|
---|
25 | var tableTab = "tableTab";
|
---|
26 | var activeTableTab = "activeTableTab";
|
---|
27 | </script>
|
---|
28 | <noscript>
|
---|
29 | <div>JavaScript is disabled on your browser.</div>
|
---|
30 | </noscript>
|
---|
31 | <!-- ========= START OF TOP NAVBAR ======= -->
|
---|
32 | <div class="topNav"><a name="navbar.top">
|
---|
33 | <!-- -->
|
---|
34 | </a>
|
---|
35 | <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
---|
36 | <a name="navbar.top.firstrow">
|
---|
37 | <!-- -->
|
---|
38 | </a>
|
---|
39 | <ul class="navList" title="Navigation">
|
---|
40 | <li><a href="../../../overview-summary.html">Overview</a></li>
|
---|
41 | <li><a href="package-summary.html">Package</a></li>
|
---|
42 | <li class="navBarCell1Rev">Class</li>
|
---|
43 | <li><a href="class-use/BOAparameter.html">Use</a></li>
|
---|
44 | <li><a href="package-tree.html">Tree</a></li>
|
---|
45 | <li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
---|
46 | <li><a href="../../../index-all.html">Index</a></li>
|
---|
47 | <li><a href="../../../help-doc.html">Help</a></li>
|
---|
48 | </ul>
|
---|
49 | </div>
|
---|
50 | <div class="subNav">
|
---|
51 | <ul class="navList">
|
---|
52 | <li><a href="../../../genius/core/boaframework/BOAcomponent.html" title="class in genius.core.boaframework"><span class="typeNameLink">Prev Class</span></a></li>
|
---|
53 | <li><a href="../../../genius/core/boaframework/BoaParty.html" title="class in genius.core.boaframework"><span class="typeNameLink">Next Class</span></a></li>
|
---|
54 | </ul>
|
---|
55 | <ul class="navList">
|
---|
56 | <li><a href="../../../index.html?genius/core/boaframework/BOAparameter.html" target="_top">Frames</a></li>
|
---|
57 | <li><a href="BOAparameter.html" target="_top">No Frames</a></li>
|
---|
58 | </ul>
|
---|
59 | <ul class="navList" id="allclasses_navbar_top">
|
---|
60 | <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
|
---|
61 | </ul>
|
---|
62 | <div>
|
---|
63 | <script type="text/javascript"><!--
|
---|
64 | allClassesLink = document.getElementById("allclasses_navbar_top");
|
---|
65 | if(window==top) {
|
---|
66 | allClassesLink.style.display = "block";
|
---|
67 | }
|
---|
68 | else {
|
---|
69 | allClassesLink.style.display = "none";
|
---|
70 | }
|
---|
71 | //-->
|
---|
72 | </script>
|
---|
73 | </div>
|
---|
74 | <div>
|
---|
75 | <ul class="subNavList">
|
---|
76 | <li>Summary: </li>
|
---|
77 | <li>Nested | </li>
|
---|
78 | <li>Field | </li>
|
---|
79 | <li><a href="#constructor.summary">Constr</a> | </li>
|
---|
80 | <li><a href="#method.summary">Method</a></li>
|
---|
81 | </ul>
|
---|
82 | <ul class="subNavList">
|
---|
83 | <li>Detail: </li>
|
---|
84 | <li>Field | </li>
|
---|
85 | <li><a href="#constructor.detail">Constr</a> | </li>
|
---|
86 | <li><a href="#method.detail">Method</a></li>
|
---|
87 | </ul>
|
---|
88 | </div>
|
---|
89 | <a name="skip.navbar.top">
|
---|
90 | <!-- -->
|
---|
91 | </a></div>
|
---|
92 | <!-- ========= END OF TOP NAVBAR ========= -->
|
---|
93 | <!-- ======== START OF CLASS DATA ======== -->
|
---|
94 | <div class="header">
|
---|
95 | <div class="subTitle">genius.core.boaframework</div>
|
---|
96 | <h2 title="Class BOAparameter" class="title">Class BOAparameter</h2>
|
---|
97 | </div>
|
---|
98 | <div class="contentContainer">
|
---|
99 | <ul class="inheritance">
|
---|
100 | <li>java.lang.Object</li>
|
---|
101 | <li>
|
---|
102 | <ul class="inheritance">
|
---|
103 | <li>genius.core.boaframework.BOAparameter</li>
|
---|
104 | </ul>
|
---|
105 | </li>
|
---|
106 | </ul>
|
---|
107 | <div class="description">
|
---|
108 | <ul class="blockList">
|
---|
109 | <li class="blockList">
|
---|
110 | <dl>
|
---|
111 | <dt>All Implemented Interfaces:</dt>
|
---|
112 | <dd>java.io.Serializable</dd>
|
---|
113 | </dl>
|
---|
114 | <hr>
|
---|
115 | <br>
|
---|
116 | <pre>public class <span class="typeNameLabel">BOAparameter</span>
|
---|
117 | extends java.lang.Object
|
---|
118 | implements java.io.Serializable</pre>
|
---|
119 | <div class="block">This stores the parameter specification of a BOA component: the name
|
---|
120 | description and range of valid values. Used in in <code>Tournament</code>.
|
---|
121 |
|
---|
122 | If lower and higher bound is used, it also requires a step size and all
|
---|
123 | in-between values in the range are being generated immediately. Basically,
|
---|
124 | what is stored is [Lowerbound:Stepsize:Upperbound]. [1:5:20] = {1, 6, 11,
|
---|
125 | 16}.</div>
|
---|
126 | <dl>
|
---|
127 | <dt><span class="seeLabel">See Also:</span></dt>
|
---|
128 | <dd><a href="../../../serialized-form.html#genius.core.boaframework.BOAparameter">Serialized Form</a></dd>
|
---|
129 | </dl>
|
---|
130 | </li>
|
---|
131 | </ul>
|
---|
132 | </div>
|
---|
133 | <div class="summary">
|
---|
134 | <ul class="blockList">
|
---|
135 | <li class="blockList">
|
---|
136 | <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
---|
137 | <ul class="blockList">
|
---|
138 | <li class="blockList"><a name="constructor.summary">
|
---|
139 | <!-- -->
|
---|
140 | </a>
|
---|
141 | <h3>Constructor Summary</h3>
|
---|
142 | <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
---|
143 | <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
---|
144 | <tr>
|
---|
145 | <th class="colOne" scope="col">Constructor and Description</th>
|
---|
146 | </tr>
|
---|
147 | <tr class="altColor">
|
---|
148 | <td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAparameter.html#BOAparameter-java.lang.String-java.lang.Double-java.lang.Double-java.lang.Double-">BOAparameter</a></span>(java.lang.String name,
|
---|
149 | java.lang.Double low,
|
---|
150 | java.lang.Double high,
|
---|
151 | java.lang.Double step)</code>
|
---|
152 | <div class="block">Describes a parameter for a BOA component.</div>
|
---|
153 | </td>
|
---|
154 | </tr>
|
---|
155 | <tr class="rowColor">
|
---|
156 | <td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAparameter.html#BOAparameter-java.lang.String-java.lang.Double-java.lang.Double-java.lang.Double-java.lang.String-">BOAparameter</a></span>(java.lang.String name,
|
---|
157 | java.lang.Double low,
|
---|
158 | java.lang.Double high,
|
---|
159 | java.lang.Double step,
|
---|
160 | java.lang.String description)</code>
|
---|
161 | <div class="block">Describes a parameter for a decoupled component.</div>
|
---|
162 | </td>
|
---|
163 | </tr>
|
---|
164 | <tr class="altColor">
|
---|
165 | <td class="colOne"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAparameter.html#BOAparameter-java.lang.String-java.lang.Double-java.lang.String-">BOAparameter</a></span>(java.lang.String name,
|
---|
166 | java.lang.Double defaultValue,
|
---|
167 | java.lang.String description)</code>
|
---|
168 | <div class="block">Describes a parameter for a BOA component with a fixed single value.</div>
|
---|
169 | </td>
|
---|
170 | </tr>
|
---|
171 | </table>
|
---|
172 | </li>
|
---|
173 | </ul>
|
---|
174 | <!-- ========== METHOD SUMMARY =========== -->
|
---|
175 | <ul class="blockList">
|
---|
176 | <li class="blockList"><a name="method.summary">
|
---|
177 | <!-- -->
|
---|
178 | </a>
|
---|
179 | <h3>Method Summary</h3>
|
---|
180 | <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
---|
181 | <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>
|
---|
182 | <tr>
|
---|
183 | <th class="colFirst" scope="col">Modifier and Type</th>
|
---|
184 | <th class="colLast" scope="col">Method and Description</th>
|
---|
185 | </tr>
|
---|
186 | <tr id="i0" class="altColor">
|
---|
187 | <td class="colFirst"><code>java.lang.String</code></td>
|
---|
188 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAparameter.html#getDescription--">getDescription</a></span>()</code> </td>
|
---|
189 | </tr>
|
---|
190 | <tr id="i1" class="rowColor">
|
---|
191 | <td class="colFirst"><code>java.lang.Double</code></td>
|
---|
192 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAparameter.html#getHigh--">getHigh</a></span>()</code> </td>
|
---|
193 | </tr>
|
---|
194 | <tr id="i2" class="altColor">
|
---|
195 | <td class="colFirst"><code>java.lang.Double</code></td>
|
---|
196 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAparameter.html#getLow--">getLow</a></span>()</code> </td>
|
---|
197 | </tr>
|
---|
198 | <tr id="i3" class="rowColor">
|
---|
199 | <td class="colFirst"><code>java.lang.String</code></td>
|
---|
200 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAparameter.html#getName--">getName</a></span>()</code> </td>
|
---|
201 | </tr>
|
---|
202 | <tr id="i4" class="altColor">
|
---|
203 | <td class="colFirst"><code>java.lang.Double</code></td>
|
---|
204 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAparameter.html#getStep--">getStep</a></span>()</code> </td>
|
---|
205 | </tr>
|
---|
206 | <tr id="i5" class="rowColor">
|
---|
207 | <td class="colFirst"><code>java.util.HashSet<<a href="../../../genius/core/misc/Pair.html" title="class in genius.core.misc">Pair</a><java.lang.String,java.lang.Double>></code></td>
|
---|
208 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAparameter.html#getValuePairs--">getValuePairs</a></span>()</code>
|
---|
209 | <div class="block">Returns all values of the parameters which satisfy
|
---|
210 | [Lowerbound:Stepsize:Upperbound].</div>
|
---|
211 | </td>
|
---|
212 | </tr>
|
---|
213 | <tr id="i6" class="altColor">
|
---|
214 | <td class="colFirst"><code>java.lang.String</code></td>
|
---|
215 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAparameter.html#toString--">toString</a></span>()</code> </td>
|
---|
216 | </tr>
|
---|
217 | <tr id="i7" class="rowColor">
|
---|
218 | <td class="colFirst"><code>java.lang.String</code></td>
|
---|
219 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAparameter.html#toXML--">toXML</a></span>()</code> </td>
|
---|
220 | </tr>
|
---|
221 | <tr id="i8" class="altColor">
|
---|
222 | <td class="colFirst"><code><a href="../../../genius/core/boaframework/BOAparameter.html" title="class in genius.core.boaframework">BOAparameter</a></code></td>
|
---|
223 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAparameter.html#withDescription-java.lang.String-">withDescription</a></span>(java.lang.String newDescr)</code> </td>
|
---|
224 | </tr>
|
---|
225 | <tr id="i9" class="rowColor">
|
---|
226 | <td class="colFirst"><code><a href="../../../genius/core/boaframework/BOAparameter.html" title="class in genius.core.boaframework">BOAparameter</a></code></td>
|
---|
227 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAparameter.html#withHigh-java.lang.Double-">withHigh</a></span>(java.lang.Double newHigh)</code> </td>
|
---|
228 | </tr>
|
---|
229 | <tr id="i10" class="altColor">
|
---|
230 | <td class="colFirst"><code><a href="../../../genius/core/boaframework/BOAparameter.html" title="class in genius.core.boaframework">BOAparameter</a></code></td>
|
---|
231 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAparameter.html#withLow-java.lang.Double-">withLow</a></span>(java.lang.Double newLow)</code> </td>
|
---|
232 | </tr>
|
---|
233 | <tr id="i11" class="rowColor">
|
---|
234 | <td class="colFirst"><code><a href="../../../genius/core/boaframework/BOAparameter.html" title="class in genius.core.boaframework">BOAparameter</a></code></td>
|
---|
235 | <td class="colLast"><code><span class="memberNameLink"><a href="../../../genius/core/boaframework/BOAparameter.html#withStep-java.lang.Double-">withStep</a></span>(java.lang.Double step)</code> </td>
|
---|
236 | </tr>
|
---|
237 | </table>
|
---|
238 | <ul class="blockList">
|
---|
239 | <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
---|
240 | <!-- -->
|
---|
241 | </a>
|
---|
242 | <h3>Methods inherited from class java.lang.Object</h3>
|
---|
243 | <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
|
---|
244 | </ul>
|
---|
245 | </li>
|
---|
246 | </ul>
|
---|
247 | </li>
|
---|
248 | </ul>
|
---|
249 | </div>
|
---|
250 | <div class="details">
|
---|
251 | <ul class="blockList">
|
---|
252 | <li class="blockList">
|
---|
253 | <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
---|
254 | <ul class="blockList">
|
---|
255 | <li class="blockList"><a name="constructor.detail">
|
---|
256 | <!-- -->
|
---|
257 | </a>
|
---|
258 | <h3>Constructor Detail</h3>
|
---|
259 | <a name="BOAparameter-java.lang.String-java.lang.Double-java.lang.Double-java.lang.Double-">
|
---|
260 | <!-- -->
|
---|
261 | </a>
|
---|
262 | <ul class="blockList">
|
---|
263 | <li class="blockList">
|
---|
264 | <h4>BOAparameter</h4>
|
---|
265 | <pre>public BOAparameter(java.lang.String name,
|
---|
266 | java.lang.Double low,
|
---|
267 | java.lang.Double high,
|
---|
268 | java.lang.Double step)</pre>
|
---|
269 | <div class="block">Describes a parameter for a BOA component. A parameter consists of a
|
---|
270 | name, and the possible values for the parameter.</div>
|
---|
271 | <dl>
|
---|
272 | <dt><span class="paramLabel">Parameters:</span></dt>
|
---|
273 | <dd><code>name</code> - of the parameter.</dd>
|
---|
274 | <dd><code>low</code> - value of the range.</dd>
|
---|
275 | <dd><code>high</code> - value of the range.</dd>
|
---|
276 | <dd><code>step</code> - of the range.</dd>
|
---|
277 | </dl>
|
---|
278 | </li>
|
---|
279 | </ul>
|
---|
280 | <a name="BOAparameter-java.lang.String-java.lang.Double-java.lang.String-">
|
---|
281 | <!-- -->
|
---|
282 | </a>
|
---|
283 | <ul class="blockList">
|
---|
284 | <li class="blockList">
|
---|
285 | <h4>BOAparameter</h4>
|
---|
286 | <pre>public BOAparameter(java.lang.String name,
|
---|
287 | java.lang.Double defaultValue,
|
---|
288 | java.lang.String description)</pre>
|
---|
289 | <div class="block">Describes a parameter for a BOA component with a fixed single value.</div>
|
---|
290 | <dl>
|
---|
291 | <dt><span class="paramLabel">Parameters:</span></dt>
|
---|
292 | <dd><code>name</code> - </dd>
|
---|
293 | <dd><code>defaultValue</code> - </dd>
|
---|
294 | <dd><code>description</code> - </dd>
|
---|
295 | </dl>
|
---|
296 | </li>
|
---|
297 | </ul>
|
---|
298 | <a name="BOAparameter-java.lang.String-java.lang.Double-java.lang.Double-java.lang.Double-java.lang.String-">
|
---|
299 | <!-- -->
|
---|
300 | </a>
|
---|
301 | <ul class="blockListLast">
|
---|
302 | <li class="blockList">
|
---|
303 | <h4>BOAparameter</h4>
|
---|
304 | <pre>public BOAparameter(java.lang.String name,
|
---|
305 | java.lang.Double low,
|
---|
306 | java.lang.Double high,
|
---|
307 | java.lang.Double step,
|
---|
308 | java.lang.String description)</pre>
|
---|
309 | <div class="block">Describes a parameter for a decoupled component. A parameter consists of
|
---|
310 | a name, a description, and the possible values for the parameter.</div>
|
---|
311 | <dl>
|
---|
312 | <dt><span class="paramLabel">Parameters:</span></dt>
|
---|
313 | <dd><code>name</code> - of the parameter.</dd>
|
---|
314 | <dd><code>low</code> - value of the range.</dd>
|
---|
315 | <dd><code>high</code> - value of the range.</dd>
|
---|
316 | <dd><code>step</code> - of the range.</dd>
|
---|
317 | <dd><code>description</code> - of the parameter.</dd>
|
---|
318 | </dl>
|
---|
319 | </li>
|
---|
320 | </ul>
|
---|
321 | </li>
|
---|
322 | </ul>
|
---|
323 | <!-- ============ METHOD DETAIL ========== -->
|
---|
324 | <ul class="blockList">
|
---|
325 | <li class="blockList"><a name="method.detail">
|
---|
326 | <!-- -->
|
---|
327 | </a>
|
---|
328 | <h3>Method Detail</h3>
|
---|
329 | <a name="getValuePairs--">
|
---|
330 | <!-- -->
|
---|
331 | </a>
|
---|
332 | <ul class="blockList">
|
---|
333 | <li class="blockList">
|
---|
334 | <h4>getValuePairs</h4>
|
---|
335 | <pre>public java.util.HashSet<<a href="../../../genius/core/misc/Pair.html" title="class in genius.core.misc">Pair</a><java.lang.String,java.lang.Double>> getValuePairs()</pre>
|
---|
336 | <div class="block">Returns all values of the parameters which satisfy
|
---|
337 | [Lowerbound:Stepsize:Upperbound].</div>
|
---|
338 | <dl>
|
---|
339 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
340 | <dd>possible values for the parameter specified.</dd>
|
---|
341 | </dl>
|
---|
342 | </li>
|
---|
343 | </ul>
|
---|
344 | <a name="getName--">
|
---|
345 | <!-- -->
|
---|
346 | </a>
|
---|
347 | <ul class="blockList">
|
---|
348 | <li class="blockList">
|
---|
349 | <h4>getName</h4>
|
---|
350 | <pre>public java.lang.String getName()</pre>
|
---|
351 | <dl>
|
---|
352 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
353 | <dd>name of the parameter.</dd>
|
---|
354 | </dl>
|
---|
355 | </li>
|
---|
356 | </ul>
|
---|
357 | <a name="getLow--">
|
---|
358 | <!-- -->
|
---|
359 | </a>
|
---|
360 | <ul class="blockList">
|
---|
361 | <li class="blockList">
|
---|
362 | <h4>getLow</h4>
|
---|
363 | <pre>public java.lang.Double getLow()</pre>
|
---|
364 | <dl>
|
---|
365 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
366 | <dd>value for the lowerbound.</dd>
|
---|
367 | </dl>
|
---|
368 | </li>
|
---|
369 | </ul>
|
---|
370 | <a name="getHigh--">
|
---|
371 | <!-- -->
|
---|
372 | </a>
|
---|
373 | <ul class="blockList">
|
---|
374 | <li class="blockList">
|
---|
375 | <h4>getHigh</h4>
|
---|
376 | <pre>public java.lang.Double getHigh()</pre>
|
---|
377 | <dl>
|
---|
378 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
379 | <dd>upperbound of the range.</dd>
|
---|
380 | </dl>
|
---|
381 | </li>
|
---|
382 | </ul>
|
---|
383 | <a name="getStep--">
|
---|
384 | <!-- -->
|
---|
385 | </a>
|
---|
386 | <ul class="blockList">
|
---|
387 | <li class="blockList">
|
---|
388 | <h4>getStep</h4>
|
---|
389 | <pre>public java.lang.Double getStep()</pre>
|
---|
390 | <dl>
|
---|
391 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
392 | <dd>stepsize of the range.</dd>
|
---|
393 | </dl>
|
---|
394 | </li>
|
---|
395 | </ul>
|
---|
396 | <a name="toString--">
|
---|
397 | <!-- -->
|
---|
398 | </a>
|
---|
399 | <ul class="blockList">
|
---|
400 | <li class="blockList">
|
---|
401 | <h4>toString</h4>
|
---|
402 | <pre>public java.lang.String toString()</pre>
|
---|
403 | <dl>
|
---|
404 | <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
---|
405 | <dd><code>toString</code> in class <code>java.lang.Object</code></dd>
|
---|
406 | </dl>
|
---|
407 | </li>
|
---|
408 | </ul>
|
---|
409 | <a name="getDescription--">
|
---|
410 | <!-- -->
|
---|
411 | </a>
|
---|
412 | <ul class="blockList">
|
---|
413 | <li class="blockList">
|
---|
414 | <h4>getDescription</h4>
|
---|
415 | <pre>public java.lang.String getDescription()</pre>
|
---|
416 | <dl>
|
---|
417 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
418 | <dd>description of the parameter.</dd>
|
---|
419 | </dl>
|
---|
420 | </li>
|
---|
421 | </ul>
|
---|
422 | <a name="toXML--">
|
---|
423 | <!-- -->
|
---|
424 | </a>
|
---|
425 | <ul class="blockList">
|
---|
426 | <li class="blockList">
|
---|
427 | <h4>toXML</h4>
|
---|
428 | <pre>public java.lang.String toXML()</pre>
|
---|
429 | </li>
|
---|
430 | </ul>
|
---|
431 | <a name="withDescription-java.lang.String-">
|
---|
432 | <!-- -->
|
---|
433 | </a>
|
---|
434 | <ul class="blockList">
|
---|
435 | <li class="blockList">
|
---|
436 | <h4>withDescription</h4>
|
---|
437 | <pre>public <a href="../../../genius/core/boaframework/BOAparameter.html" title="class in genius.core.boaframework">BOAparameter</a> withDescription(java.lang.String newDescr)</pre>
|
---|
438 | <dl>
|
---|
439 | <dt><span class="paramLabel">Parameters:</span></dt>
|
---|
440 | <dd><code>newDescr</code> - the new description for this parameter</dd>
|
---|
441 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
442 | <dd>new <a href="../../../genius/core/boaframework/BOAparameter.html" title="class in genius.core.boaframework"><code>BOAparameter</code></a> with same settings as this but new
|
---|
443 | description as given</dd>
|
---|
444 | </dl>
|
---|
445 | </li>
|
---|
446 | </ul>
|
---|
447 | <a name="withLow-java.lang.Double-">
|
---|
448 | <!-- -->
|
---|
449 | </a>
|
---|
450 | <ul class="blockList">
|
---|
451 | <li class="blockList">
|
---|
452 | <h4>withLow</h4>
|
---|
453 | <pre>public <a href="../../../genius/core/boaframework/BOAparameter.html" title="class in genius.core.boaframework">BOAparameter</a> withLow(java.lang.Double newLow)</pre>
|
---|
454 | <dl>
|
---|
455 | <dt><span class="paramLabel">Parameters:</span></dt>
|
---|
456 | <dd><code>newLow</code> - the new low value for this parameter.</dd>
|
---|
457 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
458 | <dd>new BOAparameter with same settings as this but with new low
|
---|
459 | value. If the high value is < newLow, it is also set to newLow.</dd>
|
---|
460 | </dl>
|
---|
461 | </li>
|
---|
462 | </ul>
|
---|
463 | <a name="withHigh-java.lang.Double-">
|
---|
464 | <!-- -->
|
---|
465 | </a>
|
---|
466 | <ul class="blockList">
|
---|
467 | <li class="blockList">
|
---|
468 | <h4>withHigh</h4>
|
---|
469 | <pre>public <a href="../../../genius/core/boaframework/BOAparameter.html" title="class in genius.core.boaframework">BOAparameter</a> withHigh(java.lang.Double newHigh)</pre>
|
---|
470 | <dl>
|
---|
471 | <dt><span class="paramLabel">Parameters:</span></dt>
|
---|
472 | <dd><code>newHigh</code> - the new high value for this parameter</dd>
|
---|
473 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
474 | <dd>new <a href="../../../genius/core/boaframework/BOAparameter.html" title="class in genius.core.boaframework"><code>BOAparameter</code></a> with same settings as this but with the
|
---|
475 | new high value. If the high value is < low, then low is also set
|
---|
476 | to newHigh.</dd>
|
---|
477 | </dl>
|
---|
478 | </li>
|
---|
479 | </ul>
|
---|
480 | <a name="withStep-java.lang.Double-">
|
---|
481 | <!-- -->
|
---|
482 | </a>
|
---|
483 | <ul class="blockListLast">
|
---|
484 | <li class="blockList">
|
---|
485 | <h4>withStep</h4>
|
---|
486 | <pre>public <a href="../../../genius/core/boaframework/BOAparameter.html" title="class in genius.core.boaframework">BOAparameter</a> withStep(java.lang.Double step)</pre>
|
---|
487 | <dl>
|
---|
488 | <dt><span class="paramLabel">Parameters:</span></dt>
|
---|
489 | <dd><code>step</code> - the new step value</dd>
|
---|
490 | <dt><span class="returnLabel">Returns:</span></dt>
|
---|
491 | <dd>new <a href="../../../genius/core/boaframework/BOAparameter.html" title="class in genius.core.boaframework"><code>BOAparameter</code></a> with same settings as this but with step
|
---|
492 | value as given</dd>
|
---|
493 | </dl>
|
---|
494 | </li>
|
---|
495 | </ul>
|
---|
496 | </li>
|
---|
497 | </ul>
|
---|
498 | </li>
|
---|
499 | </ul>
|
---|
500 | </div>
|
---|
501 | </div>
|
---|
502 | <!-- ========= END OF CLASS DATA ========= -->
|
---|
503 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
---|
504 | <div class="bottomNav"><a name="navbar.bottom">
|
---|
505 | <!-- -->
|
---|
506 | </a>
|
---|
507 | <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
---|
508 | <a name="navbar.bottom.firstrow">
|
---|
509 | <!-- -->
|
---|
510 | </a>
|
---|
511 | <ul class="navList" title="Navigation">
|
---|
512 | <li><a href="../../../overview-summary.html">Overview</a></li>
|
---|
513 | <li><a href="package-summary.html">Package</a></li>
|
---|
514 | <li class="navBarCell1Rev">Class</li>
|
---|
515 | <li><a href="class-use/BOAparameter.html">Use</a></li>
|
---|
516 | <li><a href="package-tree.html">Tree</a></li>
|
---|
517 | <li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
---|
518 | <li><a href="../../../index-all.html">Index</a></li>
|
---|
519 | <li><a href="../../../help-doc.html">Help</a></li>
|
---|
520 | </ul>
|
---|
521 | </div>
|
---|
522 | <div class="subNav">
|
---|
523 | <ul class="navList">
|
---|
524 | <li><a href="../../../genius/core/boaframework/BOAcomponent.html" title="class in genius.core.boaframework"><span class="typeNameLink">Prev Class</span></a></li>
|
---|
525 | <li><a href="../../../genius/core/boaframework/BoaParty.html" title="class in genius.core.boaframework"><span class="typeNameLink">Next Class</span></a></li>
|
---|
526 | </ul>
|
---|
527 | <ul class="navList">
|
---|
528 | <li><a href="../../../index.html?genius/core/boaframework/BOAparameter.html" target="_top">Frames</a></li>
|
---|
529 | <li><a href="BOAparameter.html" target="_top">No Frames</a></li>
|
---|
530 | </ul>
|
---|
531 | <ul class="navList" id="allclasses_navbar_bottom">
|
---|
532 | <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
|
---|
533 | </ul>
|
---|
534 | <div>
|
---|
535 | <script type="text/javascript"><!--
|
---|
536 | allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
---|
537 | if(window==top) {
|
---|
538 | allClassesLink.style.display = "block";
|
---|
539 | }
|
---|
540 | else {
|
---|
541 | allClassesLink.style.display = "none";
|
---|
542 | }
|
---|
543 | //-->
|
---|
544 | </script>
|
---|
545 | </div>
|
---|
546 | <div>
|
---|
547 | <ul class="subNavList">
|
---|
548 | <li>Summary: </li>
|
---|
549 | <li>Nested | </li>
|
---|
550 | <li>Field | </li>
|
---|
551 | <li><a href="#constructor.summary">Constr</a> | </li>
|
---|
552 | <li><a href="#method.summary">Method</a></li>
|
---|
553 | </ul>
|
---|
554 | <ul class="subNavList">
|
---|
555 | <li>Detail: </li>
|
---|
556 | <li>Field | </li>
|
---|
557 | <li><a href="#constructor.detail">Constr</a> | </li>
|
---|
558 | <li><a href="#method.detail">Method</a></li>
|
---|
559 | </ul>
|
---|
560 | </div>
|
---|
561 | <a name="skip.navbar.bottom">
|
---|
562 | <!-- -->
|
---|
563 | </a></div>
|
---|
564 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
---|
565 | </body>
|
---|
566 | </html>
|
---|