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

This file is indexed.

/usr/share/doc/mia-2.0/libdoc/classCPluginBase.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
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
<!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>CPluginBase 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">CPluginBase Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__plugin.html">Plug-in handling</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>The base class for all plug-ins.  
 <a href="classCPluginBase.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="plugin__base_8hh_source.html">mia/core/plugin_base.hh</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CPluginBase:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classCPluginBase.png" usemap="#CPluginBase_map" alt=""/>
  <map id="CPluginBase_map" name="CPluginBase_map">
<area href="classTPlugin.html" title="The generic base for all plug-ins. " alt="TPlugin&lt; D, T &gt;" shape="rect" coords="615,56,1220,80"/>
<area href="classTPlugin.html" alt="TPlugin&lt; C2DImageFifoFilter::plugin_data, C2DImageFifoFilter::plugin_type &gt;" shape="rect" coords="615,112,1220,136"/>
<area href="classTPlugin.html" alt="TPlugin&lt; C2DRegTimeStep::plugin_data, C2DRegTimeStep::plugin_type &gt;" shape="rect" coords="615,168,1220,192"/>
<area href="classTPlugin.html" alt="TPlugin&lt; C2DSplineTransformPenalty::plugin_data, C2DSplineTransformPenalty::plugin_type &gt;" shape="rect" coords="615,224,1220,248"/>
<area href="classTPlugin.html" alt="TPlugin&lt; C3DRegTimeStep::plugin_data, C3DRegTimeStep::plugin_type &gt;" shape="rect" coords="615,280,1220,304"/>
<area href="classTPlugin.html" alt="TPlugin&lt; C3DSplineTransformPenalty::plugin_data, C3DSplineTransformPenalty::plugin_type &gt;" shape="rect" coords="615,336,1220,360"/>
<area href="classTPlugin.html" alt="TPlugin&lt; CSplineBoundaryCondition::plugin_data, CSplineBoundaryCondition::plugin_type &gt;" shape="rect" coords="615,392,1220,416"/>
<area href="classTPlugin.html" alt="TPlugin&lt; D, io_plugin_type &gt;" shape="rect" coords="615,448,1220,472"/>
<area href="classTPlugin.html" alt="TPlugin&lt; P::plugin_data, P::plugin_type &gt;" shape="rect" coords="615,504,1220,528"/>
<area href="classTPlugin.html" alt="TPlugin&lt; TDataFilter&lt; Image &gt;::plugin_data, TDataFilter&lt; Image &gt;::plugin_type &gt;" shape="rect" coords="615,560,1220,584"/>
<area href="classTPlugin.html" alt="TPlugin&lt; test_io_data, io_plugin_type &gt;" shape="rect" coords="615,616,1220,640"/>
<area href="classTPlugin.html" alt="TPlugin&lt; test_plugin_data, test_plugin_type &gt;" shape="rect" coords="615,672,1220,696"/>
<area href="classTPlugin.html" alt="TPlugin&lt; TFullCost&lt; Transform &gt;::plugin_data, TFullCost&lt; Transform &gt;::plugin_type &gt;" shape="rect" coords="615,728,1220,752"/>
<area href="classTPlugin.html" alt="TPlugin&lt; TTransformCreator&lt; Transform &gt;::plugin_data, TTransformCreator&lt; Transform &gt;::plugin_type &gt;" shape="rect" coords="615,784,1220,808"/>
</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:a06510972d542dd6c2d234e6096fadedc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#a06510972d542dd6c2d234e6096fadedc">add_dependend_handlers</a> (<a class="el" href="group__plugin.html#ga63c695cc3368b6ba07f01350034502d4">HandlerHelpMap</a> &amp;handler_map)</td></tr>
<tr class="separator:a06510972d542dd6c2d234e6096fadedc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3d17bd814a9a364bcd16cb62d8fc78e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#ac3d17bd814a9a364bcd16cb62d8fc78e">add_parameter</a> (const std::string &amp;name, <a class="el" href="classCParameter.html">CParameter</a> *param)</td></tr>
<tr class="separator:ac3d17bd814a9a364bcd16cb62d8fc78e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a267df5dac3124df37a0327bee3d1c564"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#a267df5dac3124df37a0327bee3d1c564">append_interface</a> (<a class="el" href="classCPluginBase.html">CPluginBase</a> *plugin)</td></tr>
<tr class="separator:a267df5dac3124df37a0327bee3d1c564"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4df974783e13794b1fc8706477b0bf94"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#a4df974783e13794b1fc8706477b0bf94">check_parameters</a> ()</td></tr>
<tr class="separator:a4df974783e13794b1fc8706477b0bf94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af935fdeabe900b0882df04742c379a24"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#af935fdeabe900b0882df04742c379a24">CPluginBase</a> (const char *name)</td></tr>
<tr class="separator:af935fdeabe900b0882df04742c379a24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aacb1dc45d2e000d0449c8e81930da2a8"><td class="memItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#aacb1dc45d2e000d0449c8e81930da2a8">get_descr</a> () const </td></tr>
<tr class="separator:aacb1dc45d2e000d0449c8e81930da2a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2749c4e1cae79d545b39818c10f36425"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#a2749c4e1cae79d545b39818c10f36425">get_help</a> (std::ostream &amp;os) const </td></tr>
<tr class="separator:a2749c4e1cae79d545b39818c10f36425"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63d0528c7dbe12b0f1b6b77462ab4610"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#a63d0528c7dbe12b0f1b6b77462ab4610">get_help_xml</a> (xmlpp::Element &amp;root) const </td></tr>
<tr class="separator:a63d0528c7dbe12b0f1b6b77462ab4610"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a4478c8fbbfd7779fd13f44d2592c91"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__plugin.html#ga39fb45d0925ecaf649ca861cab0ee01a">PPluginModule</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#a5a4478c8fbbfd7779fd13f44d2592c91">get_module</a> () const </td></tr>
<tr class="separator:a5a4478c8fbbfd7779fd13f44d2592c91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affba6734e79b32dff5d218d26bb74e7a"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#affba6734e79b32dff5d218d26bb74e7a">get_name</a> () const </td></tr>
<tr class="separator:affba6734e79b32dff5d218d26bb74e7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4d5ed9fffe69e9d61de61fbec7c2a35"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#ae4d5ed9fffe69e9d61de61fbec7c2a35">get_short_help</a> (std::ostream &amp;os) const </td></tr>
<tr class="separator:ae4d5ed9fffe69e9d61de61fbec7c2a35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25dba15d6baffe41535cee94091180e1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#a25dba15d6baffe41535cee94091180e1">has_property</a> (const char *property) const </td></tr>
<tr class="separator:a25dba15d6baffe41535cee94091180e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abcfe1a69e1f5e19cf5ac19110054882e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCPluginBase.html">CPluginBase</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#abcfe1a69e1f5e19cf5ac19110054882e">next_interface</a> ()</td></tr>
<tr class="separator:abcfe1a69e1f5e19cf5ac19110054882e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46de5e676c554cd897e36a25c4950ff8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#a46de5e676c554cd897e36a25c4950ff8">set_module</a> (const <a class="el" href="group__plugin.html#ga39fb45d0925ecaf649ca861cab0ee01a">PPluginModule</a> &amp;module)</td></tr>
<tr class="separator:a46de5e676c554cd897e36a25c4950ff8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf2f0eabc3c3c86cf546c392c92f3695"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#adf2f0eabc3c3c86cf546c392c92f3695">set_parameters</a> (const <a class="el" href="group__cmdline.html#gac2085ba01a9878af9a3a65b97b81c26e">CParsedOptions</a> &amp;options)</td></tr>
<tr class="separator:adf2f0eabc3c3c86cf546c392c92f3695"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31da76a88a681dd930c86cbb7afe93f9"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#a31da76a88a681dd930c86cbb7afe93f9">~CPluginBase</a> ()</td></tr>
<tr class="separator:a31da76a88a681dd930c86cbb7afe93f9"><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:a1acdb07c3ce362b6e62286ac0b0c6831"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#a1acdb07c3ce362b6e62286ac0b0c6831">add_property</a> (const char *property)</td></tr>
<tr class="separator:a1acdb07c3ce362b6e62286ac0b0c6831"><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 all plug-ins. </p>
<p>The base class for all plug-ins. It supports handling parameters and a provides a help interface. </p>

<p>Definition at line <a class="el" href="plugin__base_8hh_source.html#l00067">67</a> of file <a class="el" href="plugin__base_8hh_source.html">plugin_base.hh</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="af935fdeabe900b0882df04742c379a24"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CPluginBase::CPluginBase </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The constructor initialises the plug-in with its name and sets its link-up to nil ant initialises its parameter map. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a31da76a88a681dd930c86cbb7afe93f9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual CPluginBase::~CPluginBase </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 destructur exists for the sole purpouse to ensure a virtual destructor for all plug-ins. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a06510972d542dd6c2d234e6096fadedc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CPluginBase::add_dependend_handlers </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></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Add all plugin handlers that may be called by this plugin </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></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ac3d17bd814a9a364bcd16cb62d8fc78e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CPluginBase::add_parameter </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classCParameter.html">CParameter</a> *&#160;</td>
          <td class="paramname"><em>param</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Add a parameter to the parameter list. If the name of the parameter already exists this function throws an <em>invalid_argument</em> exception. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>Name of the new parameter </td></tr>
    <tr><td class="paramname">param</td><td>the actual parameter </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a1acdb07c3ce362b6e62286ac0b0c6831"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void CPluginBase::add_property </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>property</em></td><td>)</td>
          <td></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>Add a porperty to the map of supported properties </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">property</td><td>a named property </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a267df5dac3124df37a0327bee3d1c564"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CPluginBase::append_interface </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classCPluginBase.html">CPluginBase</a> *&#160;</td>
          <td class="paramname"><em>plugin</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>link up another plug-in in order to be able to put several plug-ins of the same type into the same dynamic library </p>

</div>
</div>
<a class="anchor" id="a4df974783e13794b1fc8706477b0bf94"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CPluginBase::check_parameters </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This function checks, whether all requzired parameters have really been set. It throws an <em>invalid_argument</em> </p>

</div>
</div>
<a class="anchor" id="aacb1dc45d2e000d0449c8e81930da2a8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const std::string CPluginBase::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 name of the plug-in </dd></dl>

</div>
</div>
<a class="anchor" id="a2749c4e1cae79d545b39818c10f36425"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void CPluginBase::get_help </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">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>prints out a help text to the given output stream </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">os</td><td></td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented in <a class="el" href="classTPlugin.html#a1f1cd77800b012efd9e5f08314146cfa">TPlugin&lt; D, T &gt;</a>, <a class="el" href="classTPlugin.html#a1f1cd77800b012efd9e5f08314146cfa">TPlugin&lt; test_plugin_data, test_plugin_type &gt;</a>, <a class="el" href="classTPlugin.html#a1f1cd77800b012efd9e5f08314146cfa">TPlugin&lt; P::plugin_data, P::plugin_type &gt;</a>, <a class="el" href="classTPlugin.html#a1f1cd77800b012efd9e5f08314146cfa">TPlugin&lt; D, io_plugin_type &gt;</a>, <a class="el" href="classTPlugin.html#a1f1cd77800b012efd9e5f08314146cfa">TPlugin&lt; C2DImageFifoFilter::plugin_data, C2DImageFifoFilter::plugin_type &gt;</a>, <a class="el" href="classTPlugin.html#a1f1cd77800b012efd9e5f08314146cfa">TPlugin&lt; test_io_data, io_plugin_type &gt;</a>, <a class="el" href="classTPlugin.html#a1f1cd77800b012efd9e5f08314146cfa">TPlugin&lt; CSplineBoundaryCondition::plugin_data, CSplineBoundaryCondition::plugin_type &gt;</a>, <a class="el" href="classTPlugin.html#a1f1cd77800b012efd9e5f08314146cfa">TPlugin&lt; TTransformCreator&lt; Transform &gt;::plugin_data, TTransformCreator&lt; Transform &gt;::plugin_type &gt;</a>, <a class="el" href="classTPlugin.html#a1f1cd77800b012efd9e5f08314146cfa">TPlugin&lt; C3DSplineTransformPenalty::plugin_data, C3DSplineTransformPenalty::plugin_type &gt;</a>, <a class="el" href="classTPlugin.html#a1f1cd77800b012efd9e5f08314146cfa">TPlugin&lt; TDataFilter&lt; Image &gt;::plugin_data, TDataFilter&lt; Image &gt;::plugin_type &gt;</a>, <a class="el" href="classTPlugin.html#a1f1cd77800b012efd9e5f08314146cfa">TPlugin&lt; C2DSplineTransformPenalty::plugin_data, C2DSplineTransformPenalty::plugin_type &gt;</a>, <a class="el" href="classTPlugin.html#a1f1cd77800b012efd9e5f08314146cfa">TPlugin&lt; TFullCost&lt; Transform &gt;::plugin_data, TFullCost&lt; Transform &gt;::plugin_type &gt;</a>, <a class="el" href="classTPlugin.html#a1f1cd77800b012efd9e5f08314146cfa">TPlugin&lt; C3DRegTimeStep::plugin_data, C3DRegTimeStep::plugin_type &gt;</a>, and <a class="el" href="classTPlugin.html#a1f1cd77800b012efd9e5f08314146cfa">TPlugin&lt; C2DRegTimeStep::plugin_data, C2DRegTimeStep::plugin_type &gt;</a>.</p>

</div>
</div>
<a class="anchor" id="a63d0528c7dbe12b0f1b6b77462ab4610"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CPluginBase::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>Adds the help for this plug-in to an XML tree </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">root</td><td>node to add the help to </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a5a4478c8fbbfd7779fd13f44d2592c91"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__plugin.html#ga39fb45d0925ecaf649ca861cab0ee01a">PPluginModule</a> CPluginBase::get_module </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 module </dd></dl>

</div>
</div>
<a class="anchor" id="affba6734e79b32dff5d218d26bb74e7a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* CPluginBase::get_name </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 name of the plug-in </dd></dl>

</div>
</div>
<a class="anchor" id="ae4d5ed9fffe69e9d61de61fbec7c2a35"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CPluginBase::get_short_help </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 a help regarding the plugin to the output stream </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">os</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a25dba15d6baffe41535cee94091180e1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool CPluginBase::has_property </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>property</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">property</td><td>a named property </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the property is supported, false otherwise </dd></dl>

</div>
</div>
<a class="anchor" id="abcfe1a69e1f5e19cf5ac19110054882e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classCPluginBase.html">CPluginBase</a>* CPluginBase::next_interface </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>a pointer to the next plug-in, or NULL, if it doesn't exist </dd></dl>

</div>
</div>
<a class="anchor" id="a46de5e676c554cd897e36a25c4950ff8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CPluginBase::set_module </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="group__plugin.html#ga39fb45d0925ecaf649ca861cab0ee01a">PPluginModule</a> &amp;&#160;</td>
          <td class="paramname"><em>module</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>set the shared modules containing the code of this plugin This enshures that the modules is not unloaded while the plug-in still exists and needs to call its destructor whos code resides in the module. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">module</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="adf2f0eabc3c3c86cf546c392c92f3695"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CPluginBase::set_parameters </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="group__cmdline.html#gac2085ba01a9878af9a3a65b97b81c26e">CParsedOptions</a> &amp;&#160;</td>
          <td class="paramname"><em>options</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Set the parameter according to the given option map. If the parameter name does not exists, the function will throw an <em>invalid_argument</em> exception. Depending on the parameter type setting it might also throw an <em>invalid_argument</em> exception. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">options</td><td>the options map </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="plugin__base_8hh_source.html">plugin_base.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.