doc/third_party/Pluma/html/classpluma_1_1DLibrary.htm

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3     <head>
   4         <title>Pluma - Plug-in Management Framework</title>
   5         <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
   6         <link href="doxygen.css" rel="stylesheet" type="text/css" />
   7         <link href="tabs.css" rel="stylesheet" type="text/css" />
   8     </head>
   9     <body>
  10         <div id="logo">
  11             <img src="./logo.png" title="Pluma home" alt="Pluma logo" />
  12         </div>
  13 <!-- Generated by Doxygen 1.8.6 -->
  14   <div id="navrow1" class="tabs">
  15     <ul class="tablist">
  16       <li><a href="index.htm"><span>Main&#160;Page</span></a></li>
  17       <li class="current"><a href="annotated.htm"><span>Classes</span></a></li>
  18       <li><a href="files.htm"><span>Files</span></a></li>
  19     </ul>
  20   </div>
  21   <div id="navrow2" class="tabs2">
  22     <ul class="tablist">
  23       <li><a href="annotated.htm"><span>Class&#160;List</span></a></li>
  24       <li><a href="classes.htm"><span>Class&#160;Index</span></a></li>
  25       <li><a href="hierarchy.htm"><span>Class&#160;Hierarchy</span></a></li>
  26       <li><a href="functions.htm"><span>Class&#160;Members</span></a></li>
  27     </ul>
  28   </div>
  29 <div id="nav-path" class="navpath">
  30   <ul>
  31 <li class="navelem"><b>pluma</b></li><li class="navelem"><a class="el" href="classpluma_1_1DLibrary.htm">DLibrary</a></li>  </ul>
  32 </div>
  33 </div><!-- top -->
  34 <div class="header">
  35   <div class="summary">
  36 <a href="#pub-methods">Public Member Functions</a> &#124;
  37 <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  38 <a href="classpluma_1_1DLibrary-members.htm">List of all members</a>  </div>
  39   <div class="headertitle">
  40 <div class="title">pluma::DLibrary Class Reference</div>  </div>
  41 </div><!--header-->
  42 <div class="contents">
  43
  44 <p>Manages a Dynamic Linking Library.
  45  <a href="classpluma_1_1DLibrary.htm#details">More...</a></p>
  46
  47 <p><code>#include &lt;<a class="el" href="DLibrary_8hpp_source.htm">DLibrary.hpp</a>&gt;</code></p>
  48 <table class="memberdecls">
  49 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  50 Public Member Functions</h2></td></tr>
  51 <tr class="memitem:a3fa679bc824b36ce61b67716bedd15c7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpluma_1_1DLibrary.htm#a3fa679bc824b36ce61b67716bedd15c7">~DLibrary</a> ()</td></tr>
  52 <tr class="memdesc:a3fa679bc824b36ce61b67716bedd15c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a3fa679bc824b36ce61b67716bedd15c7">More...</a><br/></td></tr>
  53 <tr class="separator:a3fa679bc824b36ce61b67716bedd15c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54 <tr class="memitem:a57dd3726140cce08957e40cb5b001d84"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpluma_1_1DLibrary.htm#a57dd3726140cce08957e40cb5b001d84">getSymbol</a> (const std::string &amp;symbol)</td></tr>
  55 <tr class="memdesc:a57dd3726140cce08957e40cb5b001d84"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a symbol from the library.  <a href="#a57dd3726140cce08957e40cb5b001d84">More...</a><br/></td></tr>
  56 <tr class="separator:a57dd3726140cce08957e40cb5b001d84"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57 </table><table class="memberdecls">
  58 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  59 Static Public Member Functions</h2></td></tr>
  60 <tr class="memitem:a32400d8e50c0f03cb525ca7500b4516e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classpluma_1_1DLibrary.htm">DLibrary</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpluma_1_1DLibrary.htm#a32400d8e50c0f03cb525ca7500b4516e">load</a> (const std::string &amp;path)</td></tr>
  61 <tr class="memdesc:a32400d8e50c0f03cb525ca7500b4516e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load a library.  <a href="#a32400d8e50c0f03cb525ca7500b4516e">More...</a><br/></td></tr>
  62 <tr class="separator:a32400d8e50c0f03cb525ca7500b4516e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63 </table>
  64 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  65 <div class="textblock"><p>Manages a Dynamic Linking Library. </p>
  66
  67 <p>Definition at line <a class="el" href="DLibrary_8hpp_source.htm#l00049">49</a> of file <a class="el" href="DLibrary_8hpp_source.htm">DLibrary.hpp</a>.</p>
  68 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  69 <a class="anchor" id="a3fa679bc824b36ce61b67716bedd15c7"></a>
  70 <div class="memitem">
  71 <div class="memproto">
  72       <table class="memname">
  73         <tr>
  74           <td class="memname">pluma::DLibrary::~DLibrary </td>
  75           <td>(</td>
  76           <td class="paramname"></td><td>)</td>
  77           <td></td>
  78         </tr>
  79       </table>
  80 </div><div class="memdoc">
  81
  82 <p>Destructor. </p>
  83 <p>Close and free the opened library (if any). </p>
  84
  85 <p>Definition at line <a class="el" href="DLibrary_8cpp_source.htm#l00067">67</a> of file <a class="el" href="DLibrary_8cpp_source.htm">DLibrary.cpp</a>.</p>
  86
  87 </div>
  88 </div>
  89 <h2 class="groupheader">Member Function Documentation</h2>
  90 <a class="anchor" id="a57dd3726140cce08957e40cb5b001d84"></a>
  91 <div class="memitem">
  92 <div class="memproto">
  93       <table class="memname">
  94         <tr>
  95           <td class="memname">void * pluma::DLibrary::getSymbol </td>
  96           <td>(</td>
  97           <td class="paramtype">const std::string &amp;&#160;</td>
  98           <td class="paramname"><em>symbol</em></td><td>)</td>
  99           <td></td>
 100         </tr>
 101       </table>
 102 </div><div class="memdoc">
 103
 104 <p>Get a symbol from the library. </p>
 105 <dl class="params"><dt>Parameters</dt><dd>
 106   <table class="params">
 107     <tr><td class="paramname">symbol</td><td>Symbol that we're looking for.</td></tr>
 108   </table>
 109   </dd>
 110 </dl>
 111 <dl class="section return"><dt>Returns</dt><dd>Pointer to what the symbol refers to, or NULL if the symbol is not found. </dd></dl>
 112
 113 <p>Definition at line <a class="el" href="DLibrary_8cpp_source.htm#l00079">79</a> of file <a class="el" href="DLibrary_8cpp_source.htm">DLibrary.cpp</a>.</p>
 114
 115 </div>
 116 </div>
 117 <a class="anchor" id="a32400d8e50c0f03cb525ca7500b4516e"></a>
 118 <div class="memitem">
 119 <div class="memproto">
 120 <table class="mlabels">
 121   <tr>
 122   <td class="mlabels-left">
 123       <table class="memname">
 124         <tr>
 125           <td class="memname"><a class="el" href="classpluma_1_1DLibrary.htm">DLibrary</a> * pluma::DLibrary::load </td>
 126           <td>(</td>
 127           <td class="paramtype">const std::string &amp;&#160;</td>
 128           <td class="paramname"><em>path</em></td><td>)</td>
 129           <td></td>
 130         </tr>
 131       </table>
 132   </td>
 133   <td class="mlabels-right">
 134 <span class="mlabels"><span class="mlabel">static</span></span>  </td>
 135   </tr>
 136 </table>
 137 </div><div class="memdoc">
 138
 139 <p>Load a library. </p>
 140 <dl class="params"><dt>Parameters</dt><dd>
 141   <table class="params">
 142     <tr><td class="paramname">path</td><td>Path to the library.</td></tr>
 143   </table>
 144   </dd>
 145 </dl>
 146 <dl class="section return"><dt>Returns</dt><dd>Pointer to the loaded library, or NULL if failed. </dd></dl>
 147
 148 <p>Definition at line <a class="el" href="DLibrary_8cpp_source.htm#l00037">37</a> of file <a class="el" href="DLibrary_8cpp_source.htm">DLibrary.cpp</a>.</p>
 149
 150 </div>
 151 </div>
 152 <hr/>The documentation for this class was generated from the following files:<ul>
 153 <li><a class="el" href="DLibrary_8hpp_source.htm">DLibrary.hpp</a></li>
 154 <li><a class="el" href="DLibrary_8cpp_source.htm">DLibrary.cpp</a></li>
 155 </ul>
 156 </div><!-- contents -->
 157
 158         <p id="footer">
 159             &nbsp;::&nbsp; Copyright &copy; 2011 Gil Costa, all rights reserved &nbsp;::&nbsp;
 160             Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.7.4</a> &nbsp;::&nbsp;
 161         </p>
 162     </body>
 163 </html>