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

This file is indexed.

/usr/share/doc/mia-2.0/libdoc/classTPluginHandler.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
<!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>TPluginHandler&lt; I &gt; Class Template 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-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">TPluginHandler&lt; I &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__plugin.html">Plug-in handling</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>The basic template of all plugin handlers.  
 <a href="classTPluginHandler.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="handler_8hh_source.html">mia/core/handler.hh</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for TPluginHandler&lt; I &gt;:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classTPluginHandler.png" usemap="#TPluginHandler&lt; I &gt;_map" alt=""/>
  <map id="TPluginHandler&lt; I &gt;_map" name="TPluginHandler&lt; I &gt;_map">
<area href="classCPluginHandlerBase.html" title="The base class for all plugin handlers. " alt="CPluginHandlerBase" shape="rect" coords="90,0,260,24"/>
<area href="classTFactoryPluginHandler.html" title="the Base class for all plugn handlers that deal with factory plugins. " alt="TFactoryPluginHandler&lt; I &gt;" shape="rect" coords="0,112,170,136"/>
<area href="classTIOPluginHandler.html" title="Template for all plug-in handlers that are responsible for data IO. " alt="TIOPluginHandler&lt; I &gt;" shape="rect" coords="180,112,350,136"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a8385ce5c39e71d0b95dd51d8fd33bca5"><td class="memItemLeft" align="right" valign="top">typedef CPluginMap::const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTPluginHandler.html#a8385ce5c39e71d0b95dd51d8fd33bca5">const_iterator</a></td></tr>
<tr class="memdesc:a8385ce5c39e71d0b95dd51d8fd33bca5"><td class="mdescLeft">&#160;</td><td class="mdescRight">the iterator to walk over the available plug-ins  <a href="#a8385ce5c39e71d0b95dd51d8fd33bca5">More...</a><br/></td></tr>
<tr class="separator:a8385ce5c39e71d0b95dd51d8fd33bca5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8733b3e2e7a376c72ba799c89fef5b4f"><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; std::string, <br class="typebreak"/>
<a class="el" href="classTPluginHandler.html#a9bca1bc5d4990d4c7d5af0ca3c84e931">Interface</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTPluginHandler.html#a8733b3e2e7a376c72ba799c89fef5b4f">CPluginMap</a></td></tr>
<tr class="memdesc:a8733b3e2e7a376c72ba799c89fef5b4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">a map containing the names and theavailabe plug-ins  <a href="#a8733b3e2e7a376c72ba799c89fef5b4f">More...</a><br/></td></tr>
<tr class="separator:a8733b3e2e7a376c72ba799c89fef5b4f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bca1bc5d4990d4c7d5af0ca3c84e931"><td class="memItemLeft" align="right" valign="top">typedef I&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTPluginHandler.html#a9bca1bc5d4990d4c7d5af0ca3c84e931">Interface</a></td></tr>
<tr class="memdesc:a9bca1bc5d4990d4c7d5af0ca3c84e931"><td class="mdescLeft">&#160;</td><td class="mdescRight">typedef for the plug-in interface provided by the class  <a href="#a9bca1bc5d4990d4c7d5af0ca3c84e931">More...</a><br/></td></tr>
<tr class="separator:a9bca1bc5d4990d4c7d5af0ca3c84e931"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a468c337eb800baadad90c74100bde446"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTPluginHandler.html#a8385ce5c39e71d0b95dd51d8fd33bca5">const_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTPluginHandler.html#a468c337eb800baadad90c74100bde446">begin</a> () const </td></tr>
<tr class="separator:a468c337eb800baadad90c74100bde446"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a9606b8ba21f8270fa26909a3596934"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTPluginHandler.html#a8385ce5c39e71d0b95dd51d8fd33bca5">const_iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTPluginHandler.html#a9a9606b8ba21f8270fa26909a3596934">end</a> () const </td></tr>
<tr class="separator:a9a9606b8ba21f8270fa26909a3596934"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1040a146da666bddbf45b9a17489b4e"><td class="memItemLeft" align="right" valign="top">const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTPluginHandler.html#aa1040a146da666bddbf45b9a17489b4e">get_plugin_names</a> () const </td></tr>
<tr class="separator:aa1040a146da666bddbf45b9a17489b4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7be12fac9cbd501b2ce3f814ba340f78"><td class="memItemLeft" align="right" valign="top">const std::set&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTPluginHandler.html#a7be12fac9cbd501b2ce3f814ba340f78">get_set</a> () const </td></tr>
<tr class="separator:a7be12fac9cbd501b2ce3f814ba340f78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ddb6f1446ecee4774267860e2e1dcd7"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTPluginHandler.html#a0ddb6f1446ecee4774267860e2e1dcd7">size</a> () const </td></tr>
<tr class="separator:a0ddb6f1446ecee4774267860e2e1dcd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6a4cd836fe53fffe626d4335f831286"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTPluginHandler.html#ac6a4cd836fe53fffe626d4335f831286">~TPluginHandler</a> ()</td></tr>
<tr class="separator:ac6a4cd836fe53fffe626d4335f831286"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classCPluginHandlerBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classCPluginHandlerBase')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classCPluginHandlerBase.html">CPluginHandlerBase</a></td></tr>
<tr class="memitem:a7571a17794b8a8e604df7cc90fb9e5e4 inherit pub_methods_classCPluginHandlerBase"><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 inherit pub_methods_classCPluginHandlerBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d2abb675bc73c22da004575df5342e4 inherit pub_methods_classCPluginHandlerBase"><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 inherit pub_methods_classCPluginHandlerBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8968a5c1eaa1db20282abce2fc7630f0 inherit pub_methods_classCPluginHandlerBase"><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 inherit pub_methods_classCPluginHandlerBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09f20ebddc1ef761c7958b3aca1d0986 inherit pub_methods_classCPluginHandlerBase"><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 inherit pub_methods_classCPluginHandlerBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a650358074a869618df2b82c33e8a5974 inherit pub_methods_classCPluginHandlerBase"><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 inherit pub_methods_classCPluginHandlerBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0794444ff5a433ed6d0fb46f6fe2c833 inherit pub_methods_classCPluginHandlerBase"><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 inherit pub_methods_classCPluginHandlerBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af21b24316372fd11e84a09cb98c7bb76 inherit pub_methods_classCPluginHandlerBase"><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 inherit pub_methods_classCPluginHandlerBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bdf9fef97120abb403a8e360aa6f5b5 inherit pub_methods_classCPluginHandlerBase"><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 inherit pub_methods_classCPluginHandlerBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8861cbef8e002b3d12ea4bcd4448ed5a inherit pub_methods_classCPluginHandlerBase"><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 inherit pub_methods_classCPluginHandlerBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac95433e15a9d6550687ea87d9c41e314 inherit pub_methods_classCPluginHandlerBase"><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 inherit pub_methods_classCPluginHandlerBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36cbea8e0bfe04e8ce68ffee165f4bd1 inherit pub_methods_classCPluginHandlerBase"><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 inherit pub_methods_classCPluginHandlerBase"><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:a271a302a1b0d17e5b1c2d98166019589"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTPluginHandler.html#a271a302a1b0d17e5b1c2d98166019589">add_plugin</a> (<a class="el" href="classTPluginHandler.html#a9bca1bc5d4990d4c7d5af0ca3c84e931">Interface</a> *<a class="el" href="classTPluginHandler.html#afe8a2e49fda95c226d893b55c5928d1e">plugin</a>)</td></tr>
<tr class="separator:a271a302a1b0d17e5b1c2d98166019589"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a595b91035d0a997578dc3bb3a376b305"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTPluginHandler.html#a595b91035d0a997578dc3bb3a376b305">initialise</a> (<a class="el" href="filetools_8hh.html#a2a1a4db9b9c02a2685770eeaabac7a50">CPathNameArray</a> searchpath)</td></tr>
<tr class="separator:a595b91035d0a997578dc3bb3a376b305"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe8a2e49fda95c226d893b55c5928d1e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTPluginHandler.html">TPluginHandler</a>&lt; I &gt;::<a class="el" href="classTPluginHandler.html#a9bca1bc5d4990d4c7d5af0ca3c84e931">Interface</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTPluginHandler.html#afe8a2e49fda95c226d893b55c5928d1e">plugin</a> (const char *plugin) const </td></tr>
<tr class="separator:afe8a2e49fda95c226d893b55c5928d1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<tr class="memitem:a3f72b7707402c556ac79f5066db35df6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTPluginHandler.html#a3f72b7707402c556ac79f5066db35df6">TPluginHandler</a> ()</td></tr>
<tr class="memdesc:a3f72b7707402c556ac79f5066db35df6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the plugin handler based on the build-in search path.  <a href="#a3f72b7707402c556ac79f5066db35df6">More...</a><br/></td></tr>
<tr class="separator:a3f72b7707402c556ac79f5066db35df6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename I&gt;<br/>
class TPluginHandler&lt; I &gt;</h3>

<p>The basic template of all plugin handlers. </p>
<p>The template <a class="el" href="classTPluginHandler.html" title="The basic template of all plugin handlers. ">TPluginHandler</a> provides the base interface to all plug-in handlers. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">I</td><td>the plugin interface derived from </td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classCPluginBase.html" title="The base class for all plug-ins. ">CPluginBase</a>. </dd></dl>

<p>Definition at line <a class="el" href="handler_8hh_source.html#l00054">54</a> of file <a class="el" href="handler_8hh_source.html">handler.hh</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a8385ce5c39e71d0b95dd51d8fd33bca5"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename I&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef CPluginMap::const_iterator <a class="el" href="classTPluginHandler.html">TPluginHandler</a>&lt; I &gt;::<a class="el" href="classTPluginHandler.html#a8385ce5c39e71d0b95dd51d8fd33bca5">const_iterator</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>the iterator to walk over the available plug-ins </p>

<p>Definition at line <a class="el" href="handler_8hh_source.html#l00063">63</a> of file <a class="el" href="handler_8hh_source.html">handler.hh</a>.</p>

</div>
</div>
<a class="anchor" id="a8733b3e2e7a376c72ba799c89fef5b4f"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename I&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef std::map&lt;std::string, <a class="el" href="classTPluginHandler.html#a9bca1bc5d4990d4c7d5af0ca3c84e931">Interface</a>*&gt; <a class="el" href="classTPluginHandler.html">TPluginHandler</a>&lt; I &gt;::<a class="el" href="classTPluginHandler.html#a8733b3e2e7a376c72ba799c89fef5b4f">CPluginMap</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>a map containing the names and theavailabe plug-ins </p>

<p>Definition at line <a class="el" href="handler_8hh_source.html#l00060">60</a> of file <a class="el" href="handler_8hh_source.html">handler.hh</a>.</p>

</div>
</div>
<a class="anchor" id="a9bca1bc5d4990d4c7d5af0ca3c84e931"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename I&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef I <a class="el" href="classTPluginHandler.html">TPluginHandler</a>&lt; I &gt;::<a class="el" href="classTPluginHandler.html#a9bca1bc5d4990d4c7d5af0ca3c84e931">Interface</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>typedef for the plug-in interface provided by the class </p>

<p>Definition at line <a class="el" href="handler_8hh_source.html#l00057">57</a> of file <a class="el" href="handler_8hh_source.html">handler.hh</a>.</p>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ac6a4cd836fe53fffe626d4335f831286"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename I&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classTPluginHandler.html">TPluginHandler</a>&lt; I &gt;::~<a class="el" href="classTPluginHandler.html">TPluginHandler</a> </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>The destructor frees the modules and plug-ins </p>

</div>
</div>
<a class="anchor" id="a3f72b7707402c556ac79f5066db35df6"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename I&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTPluginHandler.html">TPluginHandler</a>&lt; I &gt;::<a class="el" href="classTPluginHandler.html">TPluginHandler</a> </td>
          <td>(</td>
          <td class="paramname"></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>Initializes the plugin handler based on the build-in search path. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a271a302a1b0d17e5b1c2d98166019589"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename I&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classTPluginHandler.html">TPluginHandler</a>&lt; I &gt;::add_plugin </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classTPluginHandler.html#a9bca1bc5d4990d4c7d5af0ca3c84e931">Interface</a> *&#160;</td>
          <td class="paramname"><em>plugin</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 given plug-in to the handler </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">plugin</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a468c337eb800baadad90c74100bde446"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename I&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTPluginHandler.html#a8385ce5c39e71d0b95dd51d8fd33bca5">const_iterator</a> <a class="el" href="classTPluginHandler.html">TPluginHandler</a>&lt; I &gt;::begin </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>an iterator to the plug-ins </dd></dl>

</div>
</div>
<a class="anchor" id="a9a9606b8ba21f8270fa26909a3596934"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename I&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTPluginHandler.html#a8385ce5c39e71d0b95dd51d8fd33bca5">const_iterator</a> <a class="el" href="classTPluginHandler.html">TPluginHandler</a>&lt; I &gt;::end </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 behind-end iterator to the plug-ins </dd></dl>

</div>
</div>
<a class="anchor" id="aa1040a146da666bddbf45b9a17489b4e"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename I&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const std::string <a class="el" href="classTPluginHandler.html">TPluginHandler</a>&lt; I &gt;::get_plugin_names </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 names of the plug-ins as a space delimited string, ordered case sensitive and alphabetically. </dd></dl>

</div>
</div>
<a class="anchor" id="a7be12fac9cbd501b2ce3f814ba340f78"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename I&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const std::set&lt;std::string&gt; <a class="el" href="classTPluginHandler.html">TPluginHandler</a>&lt; I &gt;::get_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>the names of the plug-ins as a set </dd></dl>

</div>
</div>
<a class="anchor" id="a595b91035d0a997578dc3bb3a376b305"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename I&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classTPluginHandler.html">TPluginHandler</a>&lt; I &gt;::initialise </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="filetools_8hh.html#a2a1a4db9b9c02a2685770eeaabac7a50">CPathNameArray</a>&#160;</td>
          <td class="paramname"><em>searchpath</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">

</div>
</div>
<a class="anchor" id="afe8a2e49fda95c226d893b55c5928d1e"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename I&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTPluginHandler.html">TPluginHandler</a>&lt;I&gt;::<a class="el" href="classTPluginHandler.html#a9bca1bc5d4990d4c7d5af0ca3c84e931">Interface</a>* <a class="el" href="classTPluginHandler.html">TPluginHandler</a>&lt; I &gt;::plugin </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>plugin</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>find a plugin by name. If the plug-in is not available, the method throws an <em>invalid_argument</em> exception. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">plugin</td><td>name of the plugin </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to the plug-in </dd></dl>

</div>
</div>
<a class="anchor" id="a0ddb6f1446ecee4774267860e2e1dcd7"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename I&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">size_t <a class="el" href="classTPluginHandler.html">TPluginHandler</a>&lt; I &gt;::size </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 number of available plug-ins </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="handler_8hh_source.html">handler.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 25 2014 23:52:10 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.