docs/module-doc/classAdmin.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: Admin 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>Admin Class Reference</h1>Holds /ADMIN data This class contains the admin details of the local server.
   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="classAdmin-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="classAdmin.html#a0">Admin</a> (std::string name, std::string email, std::string nick)</td></tr>
  19
  20 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
  21 <tr><td class="memItemLeft" nowrap align=right valign=top>const std::string&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classAdmin.html#o0">Name</a></td></tr>
  22
  23 <tr><td class="memItemLeft" nowrap align=right valign=top>const std::string&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classAdmin.html#o1">Email</a></td></tr>
  24
  25 <tr><td class="memItemLeft" nowrap align=right valign=top>const std::string&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classAdmin.html#o2">Nick</a></td></tr>
  26
  27 </table>
  28 <hr><a name="_details"></a><h2>Detailed Description</h2>
  29 Holds /ADMIN data This class contains the admin details of the local server.
  30 <p>
  31 It is constructed by class <a class="el" href="classServer.html">Server</a>, and has three read-only values, Name, Email and Nick that contain the specified values for the server where the module is running.
  32 <p>
  33
  34 <p>
  35 Definition at line <a class="el" href="modules_8h-source.html#l00123">123</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  36 <a name="a0" doxytag="Admin::Admin"></a><p>
  37 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  38   <tr>
  39     <td class="mdRow">
  40       <table cellpadding="0" cellspacing="0" border="0">
  41         <tr>
  42           <td class="md" nowrap valign="top"> Admin::Admin </td>
  43           <td class="md" valign="top">(&nbsp;</td>
  44           <td class="md" nowrap valign="top">std::string&nbsp;</td>
  45           <td class="mdname" nowrap> <em>name</em>, </td>
  46         </tr>
  47         <tr>
  48           <td></td>
  49           <td></td>
  50           <td class="md" nowrap>std::string&nbsp;</td>
  51           <td class="mdname" nowrap> <em>email</em>, </td>
  52         </tr>
  53         <tr>
  54           <td></td>
  55           <td></td>
  56           <td class="md" nowrap>std::string&nbsp;</td>
  57           <td class="mdname" nowrap> <em>nick</em></td>
  58         </tr>
  59         <tr>
  60           <td></td>
  61           <td class="md">)&nbsp;</td>
  62           <td class="md" colspan="2"></td>
  63         </tr>
  64
  65       </table>
  66     </td>
  67   </tr>
  68 </table>
  69 <table cellspacing=5 cellpadding=0 border=0>
  70   <tr>
  71     <td>
  72       &nbsp;
  73     </td>
  74     <td>
  75
  76 <p>
  77
  78 <p>
  79 Definition at line <a class="el" href="modules_8cpp-source.html#l00304">304</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
  80 <p>
  81 <div class="fragment"><pre>00304 : <a class="code" href="classAdmin.html#o0">Name</a>(name), <a class="code" href="classAdmin.html#o1">Email</a>(email), <a class="code" href="classAdmin.html#o2">Nick</a>(nick) { };
  82 </pre></div>    </td>
  83   </tr>
  84 </table>
  85 <hr><h2>Member Data Documentation</h2>
  86 <a name="o1" doxytag="Admin::Email"></a><p>
  87 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  88   <tr>
  89     <td class="mdRow">
  90       <table cellpadding="0" cellspacing="0" border="0">
  91         <tr>
  92           <td class="md" nowrap valign="top"> const std::string <a class="el" href="classAdmin.html#o1">Admin::Email</a>
  93       </table>
  94     </td>
  95   </tr>
  96 </table>
  97 <table cellspacing=5 cellpadding=0 border=0>
  98   <tr>
  99     <td>
 100       &nbsp;
 101     </td>
 102     <td>
 103
 104 <p>
 105
 106 <p>
 107 Definition at line <a class="el" href="modules_8h-source.html#l00126">126</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
 108   </tr>
 109 </table>
 110 <a name="o0" doxytag="Admin::Name"></a><p>
 111 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 112   <tr>
 113     <td class="mdRow">
 114       <table cellpadding="0" cellspacing="0" border="0">
 115         <tr>
 116           <td class="md" nowrap valign="top"> const std::string <a class="el" href="classAdmin.html#o0">Admin::Name</a>
 117       </table>
 118     </td>
 119   </tr>
 120 </table>
 121 <table cellspacing=5 cellpadding=0 border=0>
 122   <tr>
 123     <td>
 124       &nbsp;
 125     </td>
 126     <td>
 127
 128 <p>
 129
 130 <p>
 131 Definition at line <a class="el" href="modules_8h-source.html#l00126">126</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
 132   </tr>
 133 </table>
 134 <a name="o2" doxytag="Admin::Nick"></a><p>
 135 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 136   <tr>
 137     <td class="mdRow">
 138       <table cellpadding="0" cellspacing="0" border="0">
 139         <tr>
 140           <td class="md" nowrap valign="top"> const std::string <a class="el" href="classAdmin.html#o2">Admin::Nick</a>
 141       </table>
 142     </td>
 143   </tr>
 144 </table>
 145 <table cellspacing=5 cellpadding=0 border=0>
 146   <tr>
 147     <td>
 148       &nbsp;
 149     </td>
 150     <td>
 151
 152 <p>
 153
 154 <p>
 155 Definition at line <a class="el" href="modules_8h-source.html#l00126">126</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
 156   </tr>
 157 </table>
 158 <hr>The documentation for this class was generated from the following files:<ul>
 159 <li><a class="el" href="modules_8h-source.html">modules.h</a><li><a class="el" href="modules_8cpp-source.html">modules.cpp</a></ul>
 160 <hr size="1"><address style="align: right;"><small>Generated on Wed Apr 13 13:07:00 2005 for InspIRCd by
 161 <a href="http://www.doxygen.org/index.html">
 162 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 163 </a>1.3.3 </small></address>
 164 </body>
 165 </html>