libmia-2.2-doc 2.2.2-1 / usr / share / doc / mia-2.2 / libdoc / classCPluginHandlerBase.html

This file is indexed.

/usr/share/doc/mia-2.2/libdoc/classCPluginHandlerBase.html is in libmia-2.2-doc 2.2.2-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
<!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.8"/>
<title>CPluginHandlerBase 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.8 -->
  <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="inherits.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>  </div>
  <div class="headertitle">
<div class="title">CPluginHandlerBase 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 plugin handlers.  
 <a href="classCPluginHandlerBase.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="handlerbase_8hh_source.html">mia/core/handlerbase.hh</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CPluginHandlerBase:</div>
<div class="dyncontent">
<div class="center"><img src="classCPluginHandlerBase__inherit__graph.png" border="0" usemap="#CPluginHandlerBase_inherit__map" alt="Inheritance graph"/></div>
<map name="CPluginHandlerBase_inherit__map" id="CPluginHandlerBase_inherit__map">
<area shape="rect" id="node2" href="classTPluginHandler.html" title="The basic template of all plugin handlers. " alt="" coords="205,124,356,151"/><area shape="rect" id="node9" href="classTPluginHandler.html" title="TPluginHandler\&lt; C3DTransformationIO \&gt;" alt="" coords="573,5,856,32"/><area shape="rect" id="node10" href="classTPluginHandler.html" title="TPluginHandler\&lt; C2DTransformationIO \&gt;" alt="" coords="573,157,856,184"/><area shape="rect" id="node11" href="classTPluginHandler.html" title="TPluginHandler\&lt; CTestPlugin \&gt;" alt="" coords="605,244,824,271"/><area shape="rect" id="node3" href="classTFactoryPluginHandler.html" title="the Base class for all plugn handlers that deal with factory plugins. " alt="" coords="617,107,813,133"/><area shape="rect" id="node4" href="classTIOPluginHandler.html" title="Template for all plug&#45;in handlers that are responsible for data IO. " alt="" coords="633,56,796,83"/><area shape="rect" id="node5" href="classTIOPluginHandler.html" title="TIOPluginHandler\&lt; C3DTransformationIO \&gt;" alt="" coords="1073,51,1368,77"/><area shape="rect" id="node7" href="classTIOPluginHandler.html" title="TIOPluginHandler\&lt; C2DTransformationIO \&gt;" alt="" coords="1073,125,1368,152"/><area shape="rect" id="node6" href="classC3DTransformIOPluginHandlerImpl.html" title="The non&#45;singleton plug&#45;in handler for 3D transformations. " alt="" coords="1417,51,1657,77"/><area shape="rect" id="node8" href="classC2DTransformIOPluginHandlerImpl.html" title="The non&#45;singleton plug&#45;in handler for 3D transformations. " alt="" coords="1417,125,1657,152"/><area shape="rect" id="node12" href="classCTestPluginHandlerImpl.html" title="Class to test plugin handling. " alt="" coords="1135,244,1306,271"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></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:a7571a17794b8a8e604df7cc90fb9e5e4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginHandlerBase.html#a7571a17794b8a8e604df7cc90fb9e5e4">add_dependend_handlers</a> (<a class="el" href="group__plugin.html#ga63c695cc3368b6ba07f01350034502d4">HandlerHelpMap</a> &amp;handler_map) const </td></tr>
<tr class="separator:a7571a17794b8a8e604df7cc90fb9e5e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d2abb675bc73c22da004575df5342e4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginHandlerBase.html#a6d2abb675bc73c22da004575df5342e4">CPluginHandlerBase</a> (const std::string &amp;descriptor)</td></tr>
<tr class="separator:a6d2abb675bc73c22da004575df5342e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8968a5c1eaa1db20282abce2fc7630f0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginHandlerBase.html#a8968a5c1eaa1db20282abce2fc7630f0">CPluginHandlerBase</a> (const <a class="el" href="classCPluginHandlerBase.html">CPluginHandlerBase</a> &amp;other)=delete</td></tr>
<tr class="separator:a8968a5c1eaa1db20282abce2fc7630f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09f20ebddc1ef761c7958b3aca1d0986"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginHandlerBase.html#a09f20ebddc1ef761c7958b3aca1d0986">get_descriptor</a> () const </td></tr>
<tr class="separator:a09f20ebddc1ef761c7958b3aca1d0986"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a650358074a869618df2b82c33e8a5974"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginHandlerBase.html#a650358074a869618df2b82c33e8a5974">get_handler_type_string</a> () const </td></tr>
<tr class="separator:a650358074a869618df2b82c33e8a5974"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0794444ff5a433ed6d0fb46f6fe2c833"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginHandlerBase.html#a0794444ff5a433ed6d0fb46f6fe2c833">get_string_help_description_xml</a> (std::ostream &amp;os, xmlpp::Element *root) const </td></tr>
<tr class="separator:a0794444ff5a433ed6d0fb46f6fe2c833"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af21b24316372fd11e84a09cb98c7bb76"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginHandlerBase.html#af21b24316372fd11e84a09cb98c7bb76">get_xml_help</a> (xmlpp::Element *root) const </td></tr>
<tr class="separator:af21b24316372fd11e84a09cb98c7bb76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bdf9fef97120abb403a8e360aa6f5b5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCPluginHandlerBase.html">CPluginHandlerBase</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginHandlerBase.html#a6bdf9fef97120abb403a8e360aa6f5b5">operator=</a> (const <a class="el" href="classCPluginHandlerBase.html">CPluginHandlerBase</a> &amp;other)=delete</td></tr>
<tr class="separator:a6bdf9fef97120abb403a8e360aa6f5b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8861cbef8e002b3d12ea4bcd4448ed5a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginHandlerBase.html#a8861cbef8e002b3d12ea4bcd4448ed5a">print_help</a> (std::ostream &amp;os) const </td></tr>
<tr class="separator:a8861cbef8e002b3d12ea4bcd4448ed5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac95433e15a9d6550687ea87d9c41e314"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginHandlerBase.html#ac95433e15a9d6550687ea87d9c41e314">print_short_help</a> (std::ostream &amp;os) const </td></tr>
<tr class="separator:ac95433e15a9d6550687ea87d9c41e314"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a655ac1ae3a02a08c9d5f795b3aeb7ef0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginHandlerBase.html#a655ac1ae3a02a08c9d5f795b3aeb7ef0">validate_parameter_string</a> (const std::string &amp;s) const </td></tr>
<tr class="separator:a655ac1ae3a02a08c9d5f795b3aeb7ef0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36cbea8e0bfe04e8ce68ffee165f4bd1"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginHandlerBase.html#a36cbea8e0bfe04e8ce68ffee165f4bd1">~CPluginHandlerBase</a> ()</td></tr>
<tr class="separator:a36cbea8e0bfe04e8ce68ffee165f4bd1"><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 plugin handlers. </p>
<p>This clas provides some basic funcionallity that is common to all plugin handlers. In addition, the copy constructor and assigment operator are deleted in order to forbit copying of instances of this class. </p>

<p>Definition at line <a class="el" href="handlerbase_8hh_source.html#l00057">57</a> of file <a class="el" href="handlerbase_8hh_source.html">handlerbase.hh</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a6d2abb675bc73c22da004575df5342e4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CPluginHandlerBase::CPluginHandlerBase </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>descriptor</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Constructor </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">descriptor</td><td>plugin search path descriptor, used to identify the plugin type for users </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a8968a5c1eaa1db20282abce2fc7630f0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">CPluginHandlerBase::CPluginHandlerBase </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCPluginHandlerBase.html">CPluginHandlerBase</a> &amp;&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>forbid copying - doxygen should drop these from the documentation </p>

</div>
</div>
<a class="anchor" id="a36cbea8e0bfe04e8ce68ffee165f4bd1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual CPluginHandlerBase::~CPluginHandlerBase </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">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a7571a17794b8a8e604df7cc90fb9e5e4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CPluginHandlerBase::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> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>add all plug-in handler that may be called by this plug-in handler </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>plug in handler map to add to </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a09f20ebddc1ef761c7958b3aca1d0986"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const std::string&amp; CPluginHandlerBase::get_descriptor </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 plug-in handler descriptor </dd></dl>

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

</div>
</div>
<a class="anchor" id="a0794444ff5a433ed6d0fb46f6fe2c833"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CPluginHandlerBase::get_string_help_description_xml </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>os</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">xmlpp::Element *&#160;</td>
          <td class="paramname"><em>root</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>write the XML description of this handler to an XML node </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">os</td><td>stream to write additional descriptions to. </td></tr>
    <tr><td class="paramname">root</td><td>the parent node the information is added to </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="af21b24316372fd11e84a09cb98c7bb76"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CPluginHandlerBase::get_xml_help </td>
          <td>(</td>
          <td class="paramtype">xmlpp::Element *&#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 all plug-ins to the xml tree </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">root</td><td>toot element the documentation is added to </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a6bdf9fef97120abb403a8e360aa6f5b5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classCPluginHandlerBase.html">CPluginHandlerBase</a>&amp; CPluginHandlerBase::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCPluginHandlerBase.html">CPluginHandlerBase</a> &amp;&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>forbid copying - doxygen should drop these from the documentation </p>

</div>
</div>
<a class="anchor" id="a8861cbef8e002b3d12ea4bcd4448ed5a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CPluginHandlerBase::print_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>Print out the help to an 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="ac95433e15a9d6550687ea87d9c41e314"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CPluginHandlerBase::print_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>Print out the short help to an 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="a655ac1ae3a02a08c9d5f795b3aeb7ef0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool CPluginHandlerBase::validate_parameter_string </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>s</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Validate the given string to see whether anything useful can be done with it. The actual way how this is validated depends on the plug-in type. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="handlerbase_8hh_source.html">handlerbase.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 9 2014 13:52:56 by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.