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 <a href="classModuleFactory-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
  15 <tr><td></td></tr>
  16 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
  17 <tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classModuleFactory.html#a0">ModuleFactory</a> ()</td></tr>
  18 <tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classModuleFactory.html#a1">~ModuleFactory</a> ()</td></tr>
  19 <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>
  20 <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>
  21 </table>
  22 <hr><a name="_details"></a><h2>Detailed Description</h2>
  23 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.
  24 <p>
  25 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.
  26 <p>
  27
  28 <p>
  29 Definition at line <a class="el" href="modules_8h-source.html#l00316">316</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  30 <a name="a0" doxytag="ModuleFactory::ModuleFactory"></a><p>
  31 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  32   <tr>
  33     <td class="md">
  34       <table cellpadding="0" cellspacing="0" border="0">
  35         <tr>
  36           <td class="md" nowrap valign="top"> ModuleFactory::ModuleFactory </td>
  37           <td class="md" valign="top">(&nbsp;</td>
  38           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
  39           <td class="md" valign="top">)&nbsp;</td>
  40           <td class="md" nowrap><code> [inline]</code></td>
  41         </tr>
  42
  43       </table>
  44     </td>
  45   </tr>
  46 </table>
  47 <table cellspacing=5 cellpadding=0 border=0>
  48   <tr>
  49     <td>
  50       &nbsp;
  51     </td>
  52     <td>
  53
  54 <p>
  55
  56 <p>
  57 Definition at line <a class="el" href="modules_8h-source.html#l00319">319</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
  58 <p>
  59 <div class="fragment"><pre>00319 { }
  60 </pre></div>    </td>
  61   </tr>
  62 </table>
  63 <a name="a1" doxytag="ModuleFactory::~ModuleFactory"></a><p>
  64 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  65   <tr>
  66     <td class="md">
  67       <table cellpadding="0" cellspacing="0" border="0">
  68         <tr>
  69           <td class="md" nowrap valign="top"> virtual ModuleFactory::~ModuleFactory </td>
  70           <td class="md" valign="top">(&nbsp;</td>
  71           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
  72           <td class="md" valign="top">)&nbsp;</td>
  73           <td class="md" nowrap><code> [inline, virtual]</code></td>
  74         </tr>
  75
  76       </table>
  77     </td>
  78   </tr>
  79 </table>
  80 <table cellspacing=5 cellpadding=0 border=0>
  81   <tr>
  82     <td>
  83       &nbsp;
  84     </td>
  85     <td>
  86
  87 <p>
  88
  89 <p>
  90 Definition at line <a class="el" href="modules_8h-source.html#l00320">320</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.
  91 <p>
  92 <div class="fragment"><pre>00320 { }
  93 </pre></div>    </td>
  94   </tr>
  95 </table>
  96 <hr><h2>Member Function Documentation</h2>
  97 <a name="a2" doxytag="ModuleFactory::CreateModule"></a><p>
  98 <table width="100%" cellpadding="2" cellspacing="0" border="0">
  99   <tr>
 100     <td class="md">
 101       <table cellpadding="0" cellspacing="0" border="0">
 102         <tr>
 103           <td class="md" nowrap valign="top"> virtual <a class="el" href="classModule.html">Module</a>* ModuleFactory::CreateModule </td>
 104           <td class="md" valign="top">(&nbsp;</td>
 105           <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
 106           <td class="md" valign="top">)&nbsp;</td>
 107           <td class="md" nowrap><code> [pure virtual]</code></td>
 108         </tr>
 109
 110       </table>
 111     </td>
 112   </tr>
 113 </table>
 114 <table cellspacing=5 cellpadding=0 border=0>
 115   <tr>
 116     <td>
 117       &nbsp;
 118     </td>
 119     <td>
 120
 121 <p>
 122 Creates a new module.
 123 <p>
 124 Your inherited class of ModuleFactory must return a pointer to your <a class="el" href="classModule.html">Module</a> class using this method.    </td>
 125   </tr>
 126 </table>
 127 <hr>The documentation for this class was generated from the following file:<ul>
 128 <li><a class="el" href="modules_8h-source.html">modules.h</a></ul>
 129 <hr><address style="align: right;"><small>Generated on Wed Jan 22 20:56:48 2003 for InspIRCd by
 130 <a href="http://www.doxygen.org/index.html">
 131 <img src="doxygen.png" alt="doxygen" align="middle" border=0
 132 width=110 height=53></a>1.3-rc2 </small></address>
 133 </body>
 134 </html>