/usr/share/doc/mia-2.2/libdoc/classCPluginModule.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 | <!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>CPluginModule 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="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('classCPluginModule.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CPluginModule Class 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 plugin module loading class.
<a href="classCPluginModule.html#details">More...</a></p>
<p><code>#include <<a class="el" href="module_8hh_source.html">mia/core/module.hh</a>></code></p>
<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:a86289db07ab6d916038e5d156f9b7f0f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginModule.html#a86289db07ab6d916038e5d156f9b7f0f">CPluginModule</a> (const char *path)</td></tr>
<tr class="separator:a86289db07ab6d916038e5d156f9b7f0f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a795c26133ab59b76c19007ec3a52a3a7"><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="classCPluginModule.html#a795c26133ab59b76c19007ec3a52a3a7">get_interface</a> () const </td></tr>
<tr class="separator:a795c26133ab59b76c19007ec3a52a3a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a352c8a9ed5baebbcde9eb8cdf13d59e0"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginModule.html#a352c8a9ed5baebbcde9eb8cdf13d59e0">get_name</a> () const </td></tr>
<tr class="separator:a352c8a9ed5baebbcde9eb8cdf13d59e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a92b7d80ef58a00c03a65dfe09caa39e1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginModule.html#a92b7d80ef58a00c03a65dfe09caa39e1">set_keep_library</a> ()</td></tr>
<tr class="separator:a92b7d80ef58a00c03a65dfe09caa39e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8613fb6de83f9a8659aa323bdb8827c1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginModule.html#a8613fb6de83f9a8659aa323bdb8827c1">set_unload_library</a> ()</td></tr>
<tr class="separator:a8613fb6de83f9a8659aa323bdb8827c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1fc59d36d8546c35113756189994ff1f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCPluginModule.html#a1fc59d36d8546c35113756189994ff1f">~CPluginModule</a> ()</td></tr>
<tr class="separator:a1fc59d36d8546c35113756189994ff1f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The plugin module loading class. </p>
<p>This class handles the loading of shared object modules and hides all the ugliness of platform dependency. </p>
<p>Definition at line <a class="el" href="module_8hh_source.html#l00048">48</a> of file <a class="el" href="module_8hh_source.html">module.hh</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a86289db07ab6d916038e5d156f9b7f0f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CPluginModule::CPluginModule </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor that takes the path to the module, tries to open it, and will throw an <em>invalid_argument</em> exception, if the module can not be loaded </p>
</div>
</div>
<a class="anchor" id="a1fc59d36d8546c35113756189994ff1f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CPluginModule::~CPluginModule </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a795c26133ab59b76c19007ec3a52a3a7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCPluginBase.html">CPluginBase</a>* CPluginModule::get_interface </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 object implemented in the module or NULL, if the module does not proide such plug-in </dd></dl>
</div>
</div>
<a class="anchor" id="a352c8a9ed5baebbcde9eb8cdf13d59e0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& CPluginModule::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 file name of the module </dd></dl>
</div>
</div>
<a class="anchor" id="a92b7d80ef58a00c03a65dfe09caa39e1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CPluginModule::set_keep_library </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a8613fb6de83f9a8659aa323bdb8827c1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CPluginModule::set_unload_library </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>tell the DLL loader that it should unload this library when the modules is destroyed </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="module_8hh_source.html">module.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="classCPluginModule.html">CPluginModule</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>
|