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>InspIRCd: ModuleFactory class Reference</title>
   4 <link href="inspircd.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.3.3 -->
   7 <div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Compound&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <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.
   9 <a href="#_details">More...</a>
  10 <p>
  11 <code>#include &lt;<a class="el" href="modules_8h-source.html">modules.h</a>&gt;</code>
  12 <p>
  13 Inherits <a class="el" href="classclassbase.html">classbase</a>.
  14 <p>
  15 <a href="classModuleFactory-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  16 <tr><td></td></tr>
  17 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
  18 <tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModuleFactory.html#a0">ModuleFactory</a> ()</td></tr>
  19
  20 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModuleFactory.html#a1">~ModuleFactory</a> ()</td></tr>
  21
  22 <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classModule.html">Module</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classModuleFactory.html#a2">CreateModule</a> ()=0</td></tr>
  23
  24 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new module. </em> <a href="#a2"></a><em><br><br></td></tr>
  25 </table>
  26 <hr><a name="_details"></a><h2>Detailed Description</h2>
  27 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.
  28 <p>
  29 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.
  30 <p>
  31
  32 <p>
  33 Definition at line <a class="el" href="modules_8h-source.html#l01241">1241</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  34 <a name="a0" doxytag="ModuleFactory::ModuleFactory"></a><p>
  35 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  36   <tr>
  37     <td class="mdRow">
  38       <table cellpadding="0" cellspacing="0" border="0">
  39         <tr>
  40           <td class="md" nowrap valign="top"> ModuleFactory::ModuleFactory </td>
  41           <td class="md" valign="top">(&nbsp;</td>
  42           <td class="mdname1" valign="top" nowrap>          </td>
  43           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  44           <td class="md" nowrap><code> [inline]</code></td>
  45         </tr>
  46
  47       </table>
  48     </td>
  49   </tr>
  50 </table>
  51 <table cellspacing=5 cellpadding=0 border=0>
  52   <tr>
  53     <td>
  54       &nbsp;
  55     </td>
  56     <td>
  57
  58 <p>
  59
  60 <p>
  61 Definition at line <a class="el" href="modules_8h-source.html#l01244">1244</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
  62 <p>
  63 <div class="fragment"><pre>01244 { }
  64 </pre></div>    </td>
  65   </tr>
  66 </table>
  67 <a name="a1" doxytag="ModuleFactory::~ModuleFactory"></a><p>
  68 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  69   <tr>
  70     <td class="mdRow">
  71       <table cellpadding="0" cellspacing="0" border="0">
  72         <tr>
  73           <td class="md" nowrap valign="top"> virtual ModuleFactory::~<a class="el" href="classModuleFactory.html">ModuleFactory</a> </td>
  74           <td class="md" valign="top">(&nbsp;</td>
  75           <td class="mdname1" valign="top" nowrap>          </td>
  76           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  77           <td class="md" nowrap><code> [inline, virtual]</code></td>
  78         </tr>
  79
  80       </table>
  81     </td>
  82   </tr>
  83 </table>
  84 <table cellspacing=5 cellpadding=0 border=0>
  85   <tr>
  86     <td>
  87       &nbsp;
  88     </td>
  89     <td>
  90
  91 <p>
  92
  93 <p>
  94 Definition at line <a class="el" href="modules_8h-source.html#l01245">1245</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
  95 <p>
  96 <div class="fragment"><pre>01245 { }
  97 </pre></div>    </td>
  98   </tr>
  99 </table>
 100 <hr><h2>Member Function Documentation</h2>
 101 <a name="a2" doxytag="ModuleFactory::CreateModule"></a><p>
 102 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 103   <tr>
 104     <td class="mdRow">
 105       <table cellpadding="0" cellspacing="0" border="0">
 106         <tr>
 107           <td class="md" nowrap valign="top"> virtual <a class="el" href="classModule.html">Module</a>* ModuleFactory::CreateModule </td>
 108           <td class="md" valign="top">(&nbsp;</td>
 109           <td class="mdname1" valign="top" nowrap>          </td>
 110           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 111           <td class="md" nowrap><code> [pure virtual]</code></td>
 112         </tr>
 113
 114       </table>
 115     </td>
 116   </tr>
 117 </table>
 118 <table cellspacing=5 cellpadding=0 border=0>
 119   <tr>
 120     <td>
 121       &nbsp;
 122     </td>
 123     <td>
 124
 125 <p>
 126 Creates a new module.
 127 <p>
 128 Your inherited class of ModuleFactory must return a pointer to your <a class="el" href="classModule.html">Module</a> class using this method.    </td>
 129   </tr>
 130 </table>
 131 <hr>The documentation for this class was generated from the following file:<ul>
 132 <li><a class="el" href="modules_8h-source.html">modules.h</a></ul>
 133 <hr size="1"><address style="align: right;"><small>Generated on Tue Apr 26 17:11:50 2005 for InspIRCd by
 134 <a href="http://www.doxygen.org/index.html">
 135 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 136 </a>1.3.3 </small></address>
 137 </body>
 138 </html>