libmia-2.0-doc 2.0.13-1 / usr / share / doc / mia-2.0 / libdoc / classCParameter.html

This file is indexed.

/usr/share/doc/mia-2.0/libdoc/classCParameter.html is in libmia-2.0-doc 2.0.13-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>CParameter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">CParameter Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__cmdline.html">Command line and parameter parsing</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>The base class for parameters used in complex options.  
 <a href="classCParameter.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="parameter_8hh_source.html">mia/core/parameter.hh</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CParameter:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classCParameter.png" usemap="#CParameter_map" alt=""/>
  <map id="CParameter_map" name="CParameter_map">
<area href="classCDictParameter.html" title="Dictionary paramater. " alt="CDictParameter&lt; T &gt;" shape="rect" coords="0,56,153,80"/>
<area href="classCSetParameter.html" title="A parameter that can only assume values out of a limited set. " alt="CSetParameter&lt; T &gt;" shape="rect" coords="163,56,316,80"/>
<area href="classCStringParameter.html" title="an string parameter " alt="CStringParameter" shape="rect" coords="326,56,479,80"/>
<area href="classCTParameter.html" title="Generic type of a complex paramter. " alt="CTParameter&lt; T &gt;" shape="rect" coords="489,56,642,80"/>
<area href="classTFactoryParameter.html" title="A parameter that get&#39;s initialized by a factory to a shared or unique pointer. " alt="TFactoryParameter&lt; F &gt;" shape="rect" coords="652,56,805,80"/>
<area href="classTParameter.html" title="A parameter that can assume any value of the given value type. " alt="TParameter&lt; T &gt;" shape="rect" coords="815,56,968,80"/>
<area href="classTRangeParameter.html" title="Scalar parameter with an expected value range. " alt="TRangeParameter&lt; T &gt;" shape="rect" coords="489,112,642,136"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a94ba12dbfab92b213f573c10726cbcca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a94ba12dbfab92b213f573c10726cbcca">add_dependend_handler</a> (<a class="el" href="group__plugin.html#ga63c695cc3368b6ba07f01350034502d4">HandlerHelpMap</a> &amp;handler_map) const </td></tr>
<tr class="separator:a94ba12dbfab92b213f573c10726cbcca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d74e5adaecc979ca8b61e67b35b89a5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a6d74e5adaecc979ca8b61e67b35b89a5">CParameter</a> (const char <a class="el" href="classCParameter.html#a9fbb02a366339bccbb8dc48401fe0a4e">type</a>[], bool required, const char *<a class="el" href="classCParameter.html#a882ad136c7c557d332e215590f43b529">descr</a>)</td></tr>
<tr class="separator:a6d74e5adaecc979ca8b61e67b35b89a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a882ad136c7c557d332e215590f43b529"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a882ad136c7c557d332e215590f43b529">descr</a> (std::ostream &amp;os) const </td></tr>
<tr class="separator:a882ad136c7c557d332e215590f43b529"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50e0585eb4f6aec6e7f06a1ad57a00a1"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a50e0585eb4f6aec6e7f06a1ad57a00a1">get_default_value</a> () const </td></tr>
<tr class="separator:a50e0585eb4f6aec6e7f06a1ad57a00a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2dd0218fb8a9888e274625c7278a90b"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#ad2dd0218fb8a9888e274625c7278a90b">get_descr</a> () const </td></tr>
<tr class="separator:ad2dd0218fb8a9888e274625c7278a90b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab46d72c0a1114dd66aee4d3391dc8f25"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#ab46d72c0a1114dd66aee4d3391dc8f25">get_help_xml</a> (xmlpp::Element &amp;root) const </td></tr>
<tr class="separator:ab46d72c0a1114dd66aee4d3391dc8f25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a892f3e8005c6cbaa28d062f6139f57be"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a892f3e8005c6cbaa28d062f6139f57be">get_value_as_string</a> () const </td></tr>
<tr class="separator:a892f3e8005c6cbaa28d062f6139f57be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54f33bb1a4f5cad0231253cdffd32f50"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a54f33bb1a4f5cad0231253cdffd32f50">post_set</a> ()</td></tr>
<tr class="separator:a54f33bb1a4f5cad0231253cdffd32f50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbcc034b32bb30dc0f5c37a534d05eb1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#acbcc034b32bb30dc0f5c37a534d05eb1">required_set</a> () const </td></tr>
<tr class="separator:acbcc034b32bb30dc0f5c37a534d05eb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0702508e41ba942c04caf8b03874b65"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#ab0702508e41ba942c04caf8b03874b65">reset</a> ()</td></tr>
<tr class="separator:ab0702508e41ba942c04caf8b03874b65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16d92972d536487c83497896cf72c212"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a16d92972d536487c83497896cf72c212">set</a> (const std::string &amp;str_value)</td></tr>
<tr class="separator:a16d92972d536487c83497896cf72c212"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9fbb02a366339bccbb8dc48401fe0a4e"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a9fbb02a366339bccbb8dc48401fe0a4e">type</a> () const </td></tr>
<tr class="separator:a9fbb02a366339bccbb8dc48401fe0a4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6264144ef3f115af00021a632264db8e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a6264144ef3f115af00021a632264db8e">value</a> (std::ostream &amp;os) const </td></tr>
<tr class="separator:a6264144ef3f115af00021a632264db8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab52a12bfa54d7efe1307629656b4d1fa"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#ab52a12bfa54d7efe1307629656b4d1fa">~CParameter</a> ()</td></tr>
<tr class="separator:ab52a12bfa54d7efe1307629656b4d1fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:afee1a9aa93d9fafb94f343840b05387e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#afee1a9aa93d9fafb94f343840b05387e">do_descr</a> (std::ostream &amp;os) const =0</td></tr>
<tr class="separator:afee1a9aa93d9fafb94f343840b05387e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4014c44a9e8cc7e876f6ea902d028b68"><td class="memItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCParameter.html#a4014c44a9e8cc7e876f6ea902d028b68">errmsg</a> (const std::string &amp;err_value) const </td></tr>
<tr class="memdesc:a4014c44a9e8cc7e876f6ea902d028b68"><td class="mdescLeft">&#160;</td><td class="mdescRight">create an error message by using the given value that raises the error  <a href="#a4014c44a9e8cc7e876f6ea902d028b68">More...</a><br/></td></tr>
<tr class="separator:a4014c44a9e8cc7e876f6ea902d028b68"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The base class for parameters used in complex options. </p>
<p>The base class for parameters that might be set based on strings. The main use-case is to provide parameters to plug-ins. </p>

<p>Definition at line <a class="el" href="parameter_8hh_source.html#l00048">48</a> of file <a class="el" href="parameter_8hh_source.html">parameter.hh</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a6d74e5adaecc979ca8b61e67b35b89a5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CParameter::CParameter </td>
          <td>(</td>
          <td class="paramtype">const char&#160;</td>
          <td class="paramname"><em>type</em>[], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>required</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>descr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Base parameter type constructor </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">type</td><td>a type description string that will show up in the help </td></tr>
    <tr><td class="paramname">required</td><td>set to true if the parameter has to be set by the user </td></tr>
    <tr><td class="paramname">descr</td><td>a short description of the parameter </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ab52a12bfa54d7efe1307629656b4d1fa"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual CParameter::~CParameter </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>ensure virtual destructor and avoid warnings because we have a virtual function </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a94ba12dbfab92b213f573c10726cbcca"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CParameter::add_dependend_handler </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__plugin.html#ga63c695cc3368b6ba07f01350034502d4">HandlerHelpMap</a> &amp;&#160;</td>
          <td class="paramname"><em>handler_map</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Interface to add the plug-in handler this parameter calls to translate the input string Only for CFactoryParameter this actually does something </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in,out]</td><td class="paramname">handler_map</td><td>the map to store then pointers to handlers used by this parameter </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a882ad136c7c557d332e215590f43b529"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CParameter::descr </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>os</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the description string of the parameter </dd></dl>

</div>
</div>
<a class="anchor" id="afee1a9aa93d9fafb94f343840b05387e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void CParameter::do_descr </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>os</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>the actual (abstract) function to write the description to a stream that needs to be overwritten </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">os</td><td></td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classTParameter.html#ab931a0307b90a08bb16b169d60c7782a">TParameter&lt; T &gt;</a>, <a class="el" href="classCSetParameter.html#a72ead67091bab6a3b2e2a3c233121d55">CSetParameter&lt; T &gt;</a>, <a class="el" href="classCDictParameter.html#a656ab9d2ee4656594289e892c31966d1">CDictParameter&lt; T &gt;</a>, <a class="el" href="classTRangeParameter.html#a4b6b136d2c86fd663ef942fe0fe31c84">TRangeParameter&lt; T &gt;</a>, and <a class="el" href="classCTParameter.html#aa81cb1c4a7f15d50ac396029be3cf4c2">CTParameter&lt; T &gt;</a>.</p>

</div>
</div>
<a class="anchor" id="a4014c44a9e8cc7e876f6ea902d028b68"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const std::string CParameter::errmsg </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>err_value</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>create an error message by using the given value that raises the error </p>

</div>
</div>
<a class="anchor" id="a50e0585eb4f6aec6e7f06a1ad57a00a1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string CParameter::get_default_value </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the default value of this parameter as a string </dd></dl>

</div>
</div>
<a class="anchor" id="ad2dd0218fb8a9888e274625c7278a90b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* CParameter::get_descr </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the help description of the parameter </dd></dl>

</div>
</div>
<a class="anchor" id="ab46d72c0a1114dd66aee4d3391dc8f25"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CParameter::get_help_xml </td>
          <td>(</td>
          <td class="paramtype">xmlpp::Element &amp;&#160;</td>
          <td class="paramname"><em>root</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Add the help for this parameter to a given XML tree </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">root</td><td>the root node to add the help entry to. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a892f3e8005c6cbaa28d062f6139f57be"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string CParameter::get_value_as_string </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the curent parameter value as string </p>
<dl class="section return"><dt>Returns</dt><dd>the current parameter value </dd></dl>

</div>
</div>
<a class="anchor" id="a54f33bb1a4f5cad0231253cdffd32f50"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void CParameter::post_set </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>This command is run after the parsing has been done in most cases it will do nothing, only for factory parameters and the like it must set the final parameter value from the init string </p>

</div>
</div>
<a class="anchor" id="acbcc034b32bb30dc0f5c37a534d05eb1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool CParameter::required_set </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>wheather the required flag is (still) set </dd></dl>

</div>
</div>
<a class="anchor" id="ab0702508e41ba942c04caf8b03874b65"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CParameter::reset </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>clear the required flag and reset to default value </p>

</div>
</div>
<a class="anchor" id="a16d92972d536487c83497896cf72c212"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool CParameter::set </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>str_value</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>set the parameter based on the string value </p>

</div>
</div>
<a class="anchor" id="a9fbb02a366339bccbb8dc48401fe0a4e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* CParameter::type </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the type string of the parameter q </dd></dl>

</div>
</div>
<a class="anchor" id="a6264144ef3f115af00021a632264db8e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CParameter::value </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>os</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Write the current value plus information to a stream, </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">os</td><td>output stream </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="parameter_8hh_source.html">parameter.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 25 2014 23:52:09 by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.