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.doxygen.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="namespacemembers.html">Namespace&nbsp;Members</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 Inheritance diagram for ModuleFactory:<p><center><img src="classModuleFactory__inherit__graph.gif" border="0" usemap="#ModuleFactory__inherit__map" alt="Inheritance graph"></center>
  14 <map name="ModuleFactory__inherit__map">
  15 <area href="classclassbase.html" shape="rect" coords="22,7,102,34" alt="">
  16 </map>
  17 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for ModuleFactory:<p><center><img src="classModuleFactory__coll__graph.gif" border="0" usemap="#ModuleFactory__coll__map" alt="Collaboration graph"></center>
  18 <map name="ModuleFactory__coll__map">
  19 <area href="classclassbase.html" shape="rect" coords="22,98,102,125" alt="">
  20 </map>
  21 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classModuleFactory-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  22 <tr><td></td></tr>
  23 <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
  24 <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>
  25
  26 <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>
  27
  28 <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>
  29
  30 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new module. </em> <a href="#a2"></a><em><br><br></td></tr>
  31 </table>
  32 <hr><a name="_details"></a><h2>Detailed Description</h2>
  33 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.
  34 <p>
  35 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.
  36 <p>
  37
  38 <p>
  39 Definition at line <a class="el" href="modules_8h-source.html#l01294">1294</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  40 <a name="a0" doxytag="ModuleFactory::ModuleFactory"></a><p>
  41 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  42   <tr>
  43     <td class="mdRow">
  44       <table cellpadding="0" cellspacing="0" border="0">
  45         <tr>
  46           <td class="md" nowrap valign="top"> ModuleFactory::ModuleFactory </td>
  47           <td class="md" valign="top">(&nbsp;</td>
  48           <td class="mdname1" valign="top" nowrap>          </td>
  49           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  50           <td class="md" nowrap><code> [inline]</code></td>
  51         </tr>
  52
  53       </table>
  54     </td>
  55   </tr>
  56 </table>
  57 <table cellspacing=5 cellpadding=0 border=0>
  58   <tr>
  59     <td>
  60       &nbsp;
  61     </td>
  62     <td>
  63
  64 <p>
  65
  66 <p>
  67 Definition at line <a class="el" href="modules_8h-source.html#l01297">1297</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
  68 <p>
  69 <div class="fragment"><pre>01297 { }
  70 </pre></div>    </td>
  71   </tr>
  72 </table>
  73 <a name="a1" doxytag="ModuleFactory::~ModuleFactory"></a><p>
  74 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  75   <tr>
  76     <td class="mdRow">
  77       <table cellpadding="0" cellspacing="0" border="0">
  78         <tr>
  79           <td class="md" nowrap valign="top"> virtual ModuleFactory::~<a class="el" href="classModuleFactory.html">ModuleFactory</a> </td>
  80           <td class="md" valign="top">(&nbsp;</td>
  81           <td class="mdname1" valign="top" nowrap>          </td>
  82           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  83           <td class="md" nowrap><code> [inline, virtual]</code></td>
  84         </tr>
  85
  86       </table>
  87     </td>
  88   </tr>
  89 </table>
  90 <table cellspacing=5 cellpadding=0 border=0>
  91   <tr>
  92     <td>
  93       &nbsp;
  94     </td>
  95     <td>
  96
  97 <p>
  98
  99 <p>
 100 Definition at line <a class="el" href="modules_8h-source.html#l01298">1298</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
 101 <p>
 102 <div class="fragment"><pre>01298 { }
 103 </pre></div>    </td>
 104   </tr>
 105 </table>
 106 <hr><h2>Member Function Documentation</h2>
 107 <a name="a2" doxytag="ModuleFactory::CreateModule"></a><p>
 108 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 109   <tr>
 110     <td class="mdRow">
 111       <table cellpadding="0" cellspacing="0" border="0">
 112         <tr>
 113           <td class="md" nowrap valign="top"> virtual <a class="el" href="classModule.html">Module</a>* ModuleFactory::CreateModule </td>
 114           <td class="md" valign="top">(&nbsp;</td>
 115           <td class="mdname1" valign="top" nowrap>          </td>
 116           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 117           <td class="md" nowrap><code> [pure virtual]</code></td>
 118         </tr>
 119
 120       </table>
 121     </td>
 122   </tr>
 123 </table>
 124 <table cellspacing=5 cellpadding=0 border=0>
 125   <tr>
 126     <td>
 127       &nbsp;
 128     </td>
 129     <td>
 130
 131 <p>
 132 Creates a new module.
 133 <p>
 134 Your inherited class of ModuleFactory must return a pointer to your <a class="el" href="classModule.html">Module</a> class using this method.    </td>
 135   </tr>
 136 </table>
 137 <hr>The documentation for this class was generated from the following file:<ul>
 138 <li><a class="el" href="modules_8h-source.html">modules.h</a></ul>
 139 <hr size="1"><address style="align: right;"><small>Generated on Sun May 15 18:38:43 2005 for InspIRCd by
 140 <a href="http://www.doxygen.org/index.html">
 141 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 142 </a>1.3.3 </small></address>
 143 </body>
 144 </html>