docs/module-doc/classModuleFactory.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>ModuleFactory class Reference</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3-rc2 -->
   7 <center>
   8 <a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
   9 <hr><h1>ModuleFactory Class Reference</h1>Instantiates classes inherited from <a class="el" href="classModule.html">Module</a> This class creates a class inherited from type <a class="el" href="classModule.html">Module</a>, using new.
  10 <a href="#_details">More...</a>
  11 <p>
  12 <code>#include &lt;<a class="el" href="modules_8h-source.html">modules.h</a>&gt;</code>
  13 <p>
  14 <p>Inheritance diagram for ModuleFactory:
  15 <p><center><img src="classModuleFactory.png" usemap="#ModuleFactory_map" border="0" alt=""></center>
  16 <map name="ModuleFactory_map">
  17 <area href="classclassbase.html" alt="classbase" shape="rect" coords="0,0,98,24">
  18 </map>
  19 <a href="classModuleFactory-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  20 <tr><td></td></tr>
  21 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
  22 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classModuleFactory.html#a0">ModuleFactory</a> ()</td></tr>
  23 <tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classModuleFactory.html#a1">~ModuleFactory</a> ()</td></tr>
  24 <tr><td nowrap align=right valign=top>virtual <a class="el" href="classModule.html">Module</a> *&nbsp;</td><td valign=bottom><a class="el" href="classModuleFactory.html#a2">CreateModule</a> ()=0</td></tr>
  25 <tr><td>&nbsp;</td><td><font size=-1><em>Creates a new module.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
  26 </table>
  27 <hr><a name="_details"></a><h2>Detailed Description</h2>
  28 Instantiates classes inherited from <a class="el" href="classModule.html">Module</a> This class creates a class inherited from type <a class="el" href="classModule.html">Module</a>, using new.
  29 <p>
  30 This is to allow for modules to create many different variants of <a class="el" href="classModule.html">Module</a>, dependent on architecture, configuration, etc. In most cases, the simple class shown in the example module m_foobar.so will suffice for most modules.
  31 <p>
  32
  33 <p>
  34 Definition at line <a class="el" href="modules_8h-source.html#l00327">327</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  35 <a name="a0" doxytag="ModuleFactory::ModuleFactory"></a><p>
  36 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  37   <tr>
  38     <td class="md">
  39       <table cellpadding="0" cellspacing="0" border="0">
  40         <tr>
  41           <td class="md" nowrap valign="top"> ModuleFactory::ModuleFactory </td>
  42           <td class="md" valign="top">(&nbsp;</td>
  43           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
  44           <td class="md" valign="top">)&nbsp;</td>
  45           <td class="md" nowrap><code> [inline]</code></td>
  46         </tr>
  47
  48       </table>
  49     </td>
  50   </tr>
  51 </table>
  52 <table cellspacing=5 cellpadding=0 border=0>
  53   <tr>
  54     <td>
  55       &nbsp;
  56     </td>
  57     <td>
  58
  59 <p>
  60
  61 <p>
  62 Definition at line <a class="el" href="modules_8h-source.html#l00330">330</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
  63 <p>
  64 <div class="fragment"><pre>00330 { }
  65 </pre></div>    </td>
  66   </tr>
  67 </table>
  68 <a name="a1" doxytag="ModuleFactory::~ModuleFactory"></a><p>
  69 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  70   <tr>
  71     <td class="md">
  72       <table cellpadding="0" cellspacing="0" border="0">
  73         <tr>
  74           <td class="md" nowrap valign="top"> virtual ModuleFactory::~ModuleFactory </td>
  75           <td class="md" valign="top">(&nbsp;</td>
  76           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
  77           <td class="md" valign="top">)&nbsp;</td>
  78           <td class="md" nowrap><code> [inline, virtual]</code></td>
  79         </tr>
  80
  81       </table>
  82     </td>
  83   </tr>
  84 </table>
  85 <table cellspacing=5 cellpadding=0 border=0>
  86   <tr>
  87     <td>
  88       &nbsp;
  89     </td>
  90     <td>
  91
  92 <p>
  93
  94 <p>
  95 Definition at line <a class="el" href="modules_8h-source.html#l00331">331</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
  96 <p>
  97 <div class="fragment"><pre>00331 { }
  98 </pre></div>    </td>
  99   </tr>
 100 </table>
 101 <hr><h2>Member Function Documentation</h2>
 102 <a name="a2" doxytag="ModuleFactory::CreateModule"></a><p>
 103 <table width="100%" cellpadding="2" cellspacing="0" border="0">
 104   <tr>
 105     <td class="md">
 106       <table cellpadding="0" cellspacing="0" border="0">
 107         <tr>
 108           <td class="md" nowrap valign="top"> virtual <a class="el" href="classModule.html">Module</a>* ModuleFactory::CreateModule </td>
 109           <td class="md" valign="top">(&nbsp;</td>
 110           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 111           <td class="md" valign="top">)&nbsp;</td>
 112           <td class="md" nowrap><code> [pure virtual]</code></td>
 113         </tr>
 114
 115       </table>
 116     </td>
 117   </tr>
 118 </table>
 119 <table cellspacing=5 cellpadding=0 border=0>
 120   <tr>
 121     <td>
 122       &nbsp;
 123     </td>
 124     <td>
 125
 126 <p>
 127 Creates a new module.
 128 <p>
 129 Your inherited class of ModuleFactory must return a pointer to your <a class="el" href="classModule.html">Module</a> class using this method.    </td>
 130   </tr>
 131 </table>
 132 <hr>The documentation for this class was generated from the following file:<ul>
 133 <li><a class="el" href="modules_8h-source.html">modules.h</a></ul>
 134 <hr><address style="align: right;"><small>Generated on Mon Jan 27 00:23:13 2003 for InspIRCd by
 135 <a href="http://www.doxygen.org/index.html">
 136 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 137 width=110 height=53></a>1.3-rc2 </small></address>
 138 </body>
 139 </html>