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 Inheritance diagram for Admin:<p><center><img src="classAdmin__inherit__graph.gif" border="0" usemap="#Admin__inherit__map" alt="Inheritance graph"></center>
  14 <map name="Admin__inherit__map">
  15 <area href="classclassbase.html" shape="rect" coords="8,7,88,34" alt="">
  16 </map>
  17 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Admin:<p><center><img src="classAdmin__coll__graph.gif" border="0" usemap="#Admin__coll__map" alt="Collaboration graph"></center>
  18 <map name="Admin__coll__map">
  19 <area href="classclassbase.html" shape="rect" coords="8,98,88,125" alt="">
  20 </map>
  21 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classAdmin-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="classAdmin.html#a0">Admin</a> (std::string name, std::string email, std::string nick)</td></tr>
  25
  26 <tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
  27 <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>
  28
  29 <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>
  30
  31 <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>
  32
  33 </table>
  34 <hr><a name="_details"></a><h2>Detailed Description</h2>
  35 Holds /ADMIN data This class contains the admin details of the local server.
  36 <p>
  37 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.
  38 <p>
  39
  40 <p>
  41 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>
  42 <a name="a0" doxytag="Admin::Admin"></a><p>
  43 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  44   <tr>
  45     <td class="mdRow">
  46       <table cellpadding="0" cellspacing="0" border="0">
  47         <tr>
  48           <td class="md" nowrap valign="top"> Admin::Admin </td>
  49           <td class="md" valign="top">(&nbsp;</td>
  50           <td class="md" nowrap valign="top">std::string&nbsp;</td>
  51           <td class="mdname" nowrap> <em>name</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>email</em>, </td>
  58         </tr>
  59         <tr>
  60           <td></td>
  61           <td></td>
  62           <td class="md" nowrap>std::string&nbsp;</td>
  63           <td class="mdname" nowrap> <em>nick</em></td>
  64         </tr>
  65         <tr>
  66           <td></td>
  67           <td class="md">)&nbsp;</td>
  68           <td class="md" colspan="2"></td>
  69         </tr>
  70
  71       </table>
  72     </td>
  73   </tr>
  74 </table>
  75 <table cellspacing=5 cellpadding=0 border=0>
  76   <tr>
  77     <td>
  78       &nbsp;
  79     </td>
  80     <td>
  81
  82 <p>
  83
  84 <p>
  85 Definition at line <a class="el" href="modules_8cpp-source.html#l00314">314</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.
  86 <p>
  87 <div class="fragment"><pre>00314 : <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) { };
  88 </pre></div>    </td>
  89   </tr>
  90 </table>
  91 <hr><h2>Member Data Documentation</h2>
  92 <a name="o1" doxytag="Admin::Email"></a><p>
  93 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  94   <tr>
  95     <td class="mdRow">
  96       <table cellpadding="0" cellspacing="0" border="0">
  97         <tr>
  98           <td class="md" nowrap valign="top"> const std::string <a class="el" href="classAdmin.html#o1">Admin::Email</a>
  99       </table>
 100     </td>
 101   </tr>
 102 </table>
 103 <table cellspacing=5 cellpadding=0 border=0>
 104   <tr>
 105     <td>
 106       &nbsp;
 107     </td>
 108     <td>
 109
 110 <p>
 111
 112 <p>
 113 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>
 114   </tr>
 115 </table>
 116 <a name="o0" doxytag="Admin::Name"></a><p>
 117 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 118   <tr>
 119     <td class="mdRow">
 120       <table cellpadding="0" cellspacing="0" border="0">
 121         <tr>
 122           <td class="md" nowrap valign="top"> const std::string <a class="el" href="classAdmin.html#o0">Admin::Name</a>
 123       </table>
 124     </td>
 125   </tr>
 126 </table>
 127 <table cellspacing=5 cellpadding=0 border=0>
 128   <tr>
 129     <td>
 130       &nbsp;
 131     </td>
 132     <td>
 133
 134 <p>
 135
 136 <p>
 137 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>
 138   </tr>
 139 </table>
 140 <a name="o2" doxytag="Admin::Nick"></a><p>
 141 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 142   <tr>
 143     <td class="mdRow">
 144       <table cellpadding="0" cellspacing="0" border="0">
 145         <tr>
 146           <td class="md" nowrap valign="top"> const std::string <a class="el" href="classAdmin.html#o2">Admin::Nick</a>
 147       </table>
 148     </td>
 149   </tr>
 150 </table>
 151 <table cellspacing=5 cellpadding=0 border=0>
 152   <tr>
 153     <td>
 154       &nbsp;
 155     </td>
 156     <td>
 157
 158 <p>
 159
 160 <p>
 161 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>
 162   </tr>
 163 </table>
 164 <hr>The documentation for this class was generated from the following files:<ul>
 165 <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>
 166 <hr size="1"><address style="align: right;"><small>Generated on Fri May 13 01:59:24 2005 for InspIRCd by
 167 <a href="http://www.doxygen.org/index.html">
 168 <img src="doxygen.png" alt="doxygen" align="middle" border=0 >
 169 </a>1.3.3 </small></address>
 170 </body>
 171 </html>