docs/module-doc/classAdmin.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 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.doxygen.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.4.4-20050815 -->
   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">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</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">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <h1>Admin Class Reference</h1><!-- doxytag: class="Admin" --><!-- doxytag: inherits="classbase" -->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="7,7,87,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="7,97,87,124" 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#Admin_28std_3A_3Astring_20name_2C_20std_3A_3Astring_20email_2C_20std_3A_3Astring_20nick_29">Admin</a> (<a class="el" href="namespaceirc.html#string">std::string</a> name, <a class="el" href="namespaceirc.html#string">std::string</a> email, <a class="el" href="namespaceirc.html#string">std::string</a> 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 <a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAdmin.html#Name">Name</a></td></tr>
  28
  29 <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAdmin.html#Email">Email</a></td></tr>
  30
  31 <tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAdmin.html#Nick">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#l00124">124</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  42 <a class="anchor" name="Admin_28std_3A_3Astring_20name_2C_20std_3A_3Astring_20email_2C_20std_3A_3Astring_20nick_29"></a><!-- doxytag: member="Admin::Admin" ref="Admin_28std_3A_3Astring_20name_2C_20std_3A_3Astring_20email_2C_20std_3A_3Astring_20nick_29" args="(std::string name, std::string email, std::string nick)" --><p>
  43 <table class="mdTable" 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"><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
  51           <td class="mdname" nowrap> <em>name</em>, </td>
  52         </tr>
  53         <tr>
  54           <td class="md" nowrap align="right"></td>
  55           <td class="md"></td>
  56           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
  57           <td class="mdname" nowrap> <em>email</em>, </td>
  58         </tr>
  59         <tr>
  60           <td class="md" nowrap align="right"></td>
  61           <td class="md"></td>
  62           <td class="md" nowrap><a class="el" href="namespaceirc.html#string">std::string</a>&nbsp;</td>
  63           <td class="mdname" nowrap> <em>nick</em></td>
  64         </tr>
  65         <tr>
  66           <td class="md"></td>
  67           <td class="md">)&nbsp;</td>
  68           <td class="md" colspan="2"></td>
  69         </tr>
  70       </table>
  71     </td>
  72   </tr>
  73 </table>
  74 <table cellspacing="5" cellpadding="0" border="0">
  75   <tr>
  76     <td>
  77       &nbsp;
  78     </td>
  79     <td>
  80
  81 <p>
  82
  83 <p>
  84 Definition at line <a class="el" href="modules_8cpp-source.html#l00250">250</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00250"></a>00250 : <a class="code" href="classAdmin.html#Name">Name</a>(name), <a class="code" href="classAdmin.html#Email">Email</a>(email), <a class="code" href="classAdmin.html#Nick">Nick</a>(nick) { };
  85 </pre></div>
  86 <p>
  87     </td>
  88   </tr>
  89 </table>
  90 <hr><h2>Member Data Documentation</h2>
  91 <a class="anchor" name="Email"></a><!-- doxytag: member="Admin::Email" ref="Email" args="" --><p>
  92 <table class="mdTable" cellpadding="2" cellspacing="0">
  93   <tr>
  94     <td class="mdRow">
  95       <table cellpadding="0" cellspacing="0" border="0">
  96         <tr>
  97           <td class="md" nowrap valign="top">const <a class="el" href="namespaceirc.html#string">std::string</a> <a class="el" href="classAdmin.html#Email">Admin::Email</a>          </td>
  98         </tr>
  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#l00127">127</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
 114   </tr>
 115 </table>
 116 <a class="anchor" name="Name"></a><!-- doxytag: member="Admin::Name" ref="Name" args="" --><p>
 117 <table class="mdTable" 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 <a class="el" href="namespaceirc.html#string">std::string</a> <a class="el" href="classAdmin.html#Name">Admin::Name</a>          </td>
 123         </tr>
 124       </table>
 125     </td>
 126   </tr>
 127 </table>
 128 <table cellspacing="5" cellpadding="0" border="0">
 129   <tr>
 130     <td>
 131       &nbsp;
 132     </td>
 133     <td>
 134
 135 <p>
 136
 137 <p>
 138 Definition at line <a class="el" href="modules_8h-source.html#l00127">127</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
 139   </tr>
 140 </table>
 141 <a class="anchor" name="Nick"></a><!-- doxytag: member="Admin::Nick" ref="Nick" args="" --><p>
 142 <table class="mdTable" cellpadding="2" cellspacing="0">
 143   <tr>
 144     <td class="mdRow">
 145       <table cellpadding="0" cellspacing="0" border="0">
 146         <tr>
 147           <td class="md" nowrap valign="top">const <a class="el" href="namespaceirc.html#string">std::string</a> <a class="el" href="classAdmin.html#Nick">Admin::Nick</a>          </td>
 148         </tr>
 149       </table>
 150     </td>
 151   </tr>
 152 </table>
 153 <table cellspacing="5" cellpadding="0" border="0">
 154   <tr>
 155     <td>
 156       &nbsp;
 157     </td>
 158     <td>
 159
 160 <p>
 161
 162 <p>
 163 Definition at line <a class="el" href="modules_8h-source.html#l00127">127</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>.    </td>
 164   </tr>
 165 </table>
 166 <hr>The documentation for this class was generated from the following files:<ul>
 167 <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>
 168 <hr size="1"><address style="align: right;"><small>Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by&nbsp;
 169 <a href="http://www.doxygen.org/index.html">
 170 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
 171 </body>
 172 </html>