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