/usr/share/doc/mia-2.2/libdoc/classTPlugin.html is in libmia-2.2-doc 2.2.7-3.
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 | <!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.9.1"/>
<title>TPlugin< D, T > 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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.9.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data 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 Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classTPlugin.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">TPlugin< D, T > 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 generic base for all plug-ins.
<a href="classTPlugin.html#details">More...</a></p>
<p><code>#include <<a class="el" href="plugin__base_8hh_source.html">mia/core/plugin_base.hh</a>></code></p>
<div class="dynheader">
Inheritance diagram for TPlugin< D, T >:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classTPlugin__inherit__graph.svg" width="2362" height="995"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for TPlugin< D, T >:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classTPlugin__coll__graph.svg" width="139" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></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:a1a2ababb6aab90a129473db188af5521"><td class="memItemLeft" align="right" valign="top">typedef D </td><td class="memItemRight" valign="bottom"><a class="el" href="classTPlugin.html#a1a2ababb6aab90a129473db188af5521">PlugData</a></td></tr>
<tr class="memdesc:a1a2ababb6aab90a129473db188af5521"><td class="mdescLeft"> </td><td class="mdescRight">Typedef for the data type descriptor handled by this plug-in. <a href="#a1a2ababb6aab90a129473db188af5521">More...</a><br /></td></tr>
<tr class="separator:a1a2ababb6aab90a129473db188af5521"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3346b9d135fd2421ae85a9ae75e1e22a"><td class="memItemLeft" align="right" valign="top">typedef T </td><td class="memItemRight" valign="bottom"><a class="el" href="classTPlugin.html#a3346b9d135fd2421ae85a9ae75e1e22a">PlugType</a></td></tr>
<tr class="memdesc:a3346b9d135fd2421ae85a9ae75e1e22a"><td class="mdescLeft"> </td><td class="mdescRight">Typedef for the plugin type descriptor handled by this plug-in. <a href="#a3346b9d135fd2421ae85a9ae75e1e22a">More...</a><br /></td></tr>
<tr class="separator:a3346b9d135fd2421ae85a9ae75e1e22a"><td class="memSeparator" colspan="2"> </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:a1f1cd77800b012efd9e5f08314146cfa"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTPlugin.html#a1f1cd77800b012efd9e5f08314146cfa">get_help</a> (std::ostream &os) const </td></tr>
<tr class="separator:a1f1cd77800b012efd9e5f08314146cfa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3c6d4f2890cf84e21c5e58410b9882f4"><td class="memItemLeft" align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classTPlugin.html#a3c6d4f2890cf84e21c5e58410b9882f4">get_long_name</a> () const </td></tr>
<tr class="separator:a3c6d4f2890cf84e21c5e58410b9882f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2b7cf3ac88b460df006e27d1d35c7f10"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTPlugin.html#a2b7cf3ac88b460df006e27d1d35c7f10">TPlugin</a> (const char *name)</td></tr>
<tr class="separator:a2b7cf3ac88b460df006e27d1d35c7f10"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classCPluginBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classCPluginBase')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classCPluginBase.html">CPluginBase</a></td></tr>
<tr class="memitem:a06510972d542dd6c2d234e6096fadedc inherit pub_methods_classCPluginBase"><td class="memItemLeft" align="right" valign="top">void </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> &handler_map)</td></tr>
<tr class="separator:a06510972d542dd6c2d234e6096fadedc inherit pub_methods_classCPluginBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1acdb07c3ce362b6e62286ac0b0c6831 inherit pub_methods_classCPluginBase"><td class="memItemLeft" align="right" valign="top">void </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 inherit pub_methods_classCPluginBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a267df5dac3124df37a0327bee3d1c564 inherit pub_methods_classCPluginBase"><td class="memItemLeft" align="right" valign="top">void </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 inherit pub_methods_classCPluginBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af935fdeabe900b0882df04742c379a24 inherit pub_methods_classCPluginBase"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#af935fdeabe900b0882df04742c379a24">CPluginBase</a> (const char *name)</td></tr>
<tr class="separator:af935fdeabe900b0882df04742c379a24 inherit pub_methods_classCPluginBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a4478c8fbbfd7779fd13f44d2592c91 inherit pub_methods_classCPluginBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__plugin.html#ga39fb45d0925ecaf649ca861cab0ee01a">PPluginModule</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#a5a4478c8fbbfd7779fd13f44d2592c91">get_module</a> () const </td></tr>
<tr class="separator:a5a4478c8fbbfd7779fd13f44d2592c91 inherit pub_methods_classCPluginBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7d746391d46712011968eaee052257cf inherit pub_methods_classCPluginBase"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#a7d746391d46712011968eaee052257cf">get_priority</a> () const </td></tr>
<tr class="separator:a7d746391d46712011968eaee052257cf inherit pub_methods_classCPluginBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a25dba15d6baffe41535cee94091180e1 inherit pub_methods_classCPluginBase"><td class="memItemLeft" align="right" valign="top">bool </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 inherit pub_methods_classCPluginBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abcfe1a69e1f5e19cf5ac19110054882e inherit pub_methods_classCPluginBase"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCPluginBase.html">CPluginBase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#abcfe1a69e1f5e19cf5ac19110054882e">next_interface</a> ()</td></tr>
<tr class="separator:abcfe1a69e1f5e19cf5ac19110054882e inherit pub_methods_classCPluginBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46de5e676c554cd897e36a25c4950ff8 inherit pub_methods_classCPluginBase"><td class="memItemLeft" align="right" valign="top">void </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> &module)</td></tr>
<tr class="separator:a46de5e676c554cd897e36a25c4950ff8 inherit pub_methods_classCPluginBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a32106df7524e99c9143630a2579ffca5 inherit pub_methods_classCPluginBase"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#a32106df7524e99c9143630a2579ffca5">set_priority</a> (unsigned p)</td></tr>
<tr class="separator:a32106df7524e99c9143630a2579ffca5 inherit pub_methods_classCPluginBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a31da76a88a681dd930c86cbb7afe93f9 inherit pub_methods_classCPluginBase"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginBase.html#a31da76a88a681dd930c86cbb7afe93f9">~CPluginBase</a> ()</td></tr>
<tr class="separator:a31da76a88a681dd930c86cbb7afe93f9 inherit pub_methods_classCPluginBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classCParamTranslator"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classCParamTranslator')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classCParamTranslator.html">CParamTranslator</a></td></tr>
<tr class="memitem:a2107a918d54b2253c345ab8c1f31dee3 inherit pub_methods_classCParamTranslator"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCParamTranslator.html#a2107a918d54b2253c345ab8c1f31dee3">add_parameter</a> (const std::string &name, <a class="el" href="classCParameter.html">CParameter</a> *param)</td></tr>
<tr class="separator:a2107a918d54b2253c345ab8c1f31dee3 inherit pub_methods_classCParamTranslator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a800557c6ac254e69deb95c9c19204c0a inherit pub_methods_classCParamTranslator"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCParamTranslator.html#a800557c6ac254e69deb95c9c19204c0a">check_parameters</a> ()</td></tr>
<tr class="separator:a800557c6ac254e69deb95c9c19204c0a inherit pub_methods_classCParamTranslator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1e063f43df0c35de3e7759fbb65a80b7 inherit pub_methods_classCParamTranslator"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCParamTranslator.html#a1e063f43df0c35de3e7759fbb65a80b7">CParamTranslator</a> (const char *name)</td></tr>
<tr class="separator:a1e063f43df0c35de3e7759fbb65a80b7 inherit pub_methods_classCParamTranslator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:accdb46465e2d2fbd9dbbcb77c1bc7e40 inherit pub_methods_classCParamTranslator"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCParamTranslator.html#accdb46465e2d2fbd9dbbcb77c1bc7e40">do_get_help_xml</a> (<a class="el" href="classCXMLElement.html">CXMLElement</a> &root) const </td></tr>
<tr class="separator:accdb46465e2d2fbd9dbbcb77c1bc7e40 inherit pub_methods_classCParamTranslator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a867b647ba923c56a422404ed4b2a171c inherit pub_methods_classCParamTranslator"><td class="memItemLeft" align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classCParamTranslator.html#a867b647ba923c56a422404ed4b2a171c">get_descr</a> () const </td></tr>
<tr class="separator:a867b647ba923c56a422404ed4b2a171c inherit pub_methods_classCParamTranslator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c50ab34ee3851d8b022178f72678155 inherit pub_methods_classCParamTranslator"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCParamTranslator.html#a5c50ab34ee3851d8b022178f72678155">get_help</a> (std::ostream &os) const </td></tr>
<tr class="separator:a5c50ab34ee3851d8b022178f72678155 inherit pub_methods_classCParamTranslator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a5da92a4b8459c6fe6887d79d309158 inherit pub_methods_classCParamTranslator"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCParamTranslator.html#a0a5da92a4b8459c6fe6887d79d309158">get_help_xml</a> (<a class="el" href="classCXMLElement.html">CXMLElement</a> &root) const </td></tr>
<tr class="separator:a0a5da92a4b8459c6fe6887d79d309158 inherit pub_methods_classCParamTranslator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3677741de31530b3d65a734827c1b7cd inherit pub_methods_classCParamTranslator"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCParamTranslator.html#a3677741de31530b3d65a734827c1b7cd">get_name</a> () const </td></tr>
<tr class="separator:a3677741de31530b3d65a734827c1b7cd inherit pub_methods_classCParamTranslator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a03d05579322d8eb559d29bbb584090e2 inherit pub_methods_classCParamTranslator"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCParamTranslator.html#a03d05579322d8eb559d29bbb584090e2">get_short_help</a> (std::ostream &os) const </td></tr>
<tr class="separator:a03d05579322d8eb559d29bbb584090e2 inherit pub_methods_classCParamTranslator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b5a40e717161e76913fa659d79ea008 inherit pub_methods_classCParamTranslator"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCParamTranslator.html#a4b5a40e717161e76913fa659d79ea008">set_parameters</a> (const <a class="el" href="group__cmdline.html#gac2085ba01a9878af9a3a65b97b81c26e">CParsedOptions</a> &options)</td></tr>
<tr class="separator:a4b5a40e717161e76913fa659d79ea008 inherit pub_methods_classCParamTranslator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9185a0c6de5d81b6449a9500a8a630bb inherit pub_methods_classCParamTranslator"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCParamTranslator.html#a9185a0c6de5d81b6449a9500a8a630bb">~CParamTranslator</a> ()</td></tr>
<tr class="separator:a9185a0c6de5d81b6449a9500a8a630bb inherit pub_methods_classCParamTranslator"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a7e282912d27f0a231238edfa4efbc17d"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTPlugin.html#a7e282912d27f0a231238edfa4efbc17d">get_data_path_part</a> ()</td></tr>
<tr class="separator:a7e282912d27f0a231238edfa4efbc17d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a519478229e116f558857185fdc2efbbf"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTPlugin.html#a519478229e116f558857185fdc2efbbf">get_type_path_part</a> ()</td></tr>
<tr class="separator:a519478229e116f558857185fdc2efbbf"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classCParamTranslator"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classCParamTranslator')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classCParamTranslator.html">CParamTranslator</a></td></tr>
<tr class="memitem:a8cbfe4f9476958a20c27333625a3627b inherit pro_methods_classCParamTranslator"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCParamList.html">CParamList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCParamTranslator.html#a8cbfe4f9476958a20c27333625a3627b">get_parameters</a> ()</td></tr>
<tr class="separator:a8cbfe4f9476958a20c27333625a3627b inherit pro_methods_classCParamTranslator"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<typename D, typename T><br />
class TPlugin< D, T ></h3>
<p>The generic base for all plug-ins. </p>
<p>Templated plugin base class. The classes <em>D</em> and <em>T</em> must define a static const char *data_descr and static const char *type_descr respectively. The combination D::data_descr and T::type_descr is will be part of the plugin search path. </p><dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">D</td><td>data type descriptior </td></tr>
<tr><td class="paramname">T</td><td>plugin type descriptor </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="plugin__base_8hh_source.html#l00170">170</a> of file <a class="el" href="plugin__base_8hh_source.html">plugin_base.hh</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a1a2ababb6aab90a129473db188af5521"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename D, typename T> </div>
<table class="memname">
<tr>
<td class="memname">typedef D <a class="el" href="classTPlugin.html">TPlugin</a>< D, T >::<a class="el" href="classTPlugin.html#a1a2ababb6aab90a129473db188af5521">PlugData</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Typedef for the data type descriptor handled by this plug-in. </p>
<p>Definition at line <a class="el" href="plugin__base_8hh_source.html#l00173">173</a> of file <a class="el" href="plugin__base_8hh_source.html">plugin_base.hh</a>.</p>
</div>
</div>
<a class="anchor" id="a3346b9d135fd2421ae85a9ae75e1e22a"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename D, typename T> </div>
<table class="memname">
<tr>
<td class="memname">typedef T <a class="el" href="classTPlugin.html">TPlugin</a>< D, T >::<a class="el" href="classTPlugin.html#a3346b9d135fd2421ae85a9ae75e1e22a">PlugType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Typedef for the plugin type descriptor handled by this plug-in. </p>
<p>Definition at line <a class="el" href="plugin__base_8hh_source.html#l00176">176</a> of file <a class="el" href="plugin__base_8hh_source.html">plugin_base.hh</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a2b7cf3ac88b460df006e27d1d35c7f10"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename D, typename T> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTPlugin.html">TPlugin</a>< D, T >::<a class="el" href="classTPlugin.html">TPlugin</a> </td>
<td>(</td>
<td class="paramtype">const char * </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>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a7e282912d27f0a231238edfa4efbc17d"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename D, typename T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static const char* <a class="el" href="classTPlugin.html">TPlugin</a>< D, T >::get_data_path_part </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a1f1cd77800b012efd9e5f08314146cfa"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename D, typename T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classTPlugin.html">TPlugin</a>< D, T >::get_help </td>
<td>(</td>
<td class="paramtype">std::ostream & </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>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="a3c6d4f2890cf84e21c5e58410b9882f4"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename D, typename T> </div>
<table class="memname">
<tr>
<td class="memname">const std::string <a class="el" href="classTPlugin.html">TPlugin</a>< D, T >::get_long_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 long name of the plug in consisting of its name, its type, and data descriptors </dd></dl>
</div>
</div>
<a class="anchor" id="a519478229e116f558857185fdc2efbbf"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename D, typename T> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static const char* <a class="el" href="classTPlugin.html">TPlugin</a>< D, T >::get_type_path_part </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</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 -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classTPlugin.html">TPlugin</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
</ul>
</div>
</body>
</html>
|