docs/module-doc/classBoolSet.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: BoolSet 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>BoolSet Class Reference</h1><!-- doxytag: class="BoolSet" -->BoolSet is a utility class designed to hold eight bools in a bitmask.
   9 <a href="#_details">More...</a>
  10 <p>
  11 <code>#include &lt;<a class="el" href="base_8h-source.html">base.h</a>&gt;</code>
  12 <p>
  13 Collaboration diagram for BoolSet:<p><center><img src="classBoolSet__coll__graph.gif" border="0" usemap="#BoolSet__coll__map" alt="Collaboration graph"></center>
  14 <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classBoolSet-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 Member Functions</h2></td></tr>
  17 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBoolSet.html#BoolSet_28_29">BoolSet</a> ()</td></tr>
  18
  19 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The default constructor initializes the BoolSet to all values unset.  <a href="#BoolSet_28_29"></a><br></td></tr>
  20 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBoolSet.html#BoolSet_28char_20bitmask_29">BoolSet</a> (char bitmask)</td></tr>
  21
  22 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This constructor copies the default bitmask from a char.  <a href="#BoolSet_28char_20bitmask_29"></a><br></td></tr>
  23 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBoolSet.html#Set_28int_20number_29">Set</a> (int number)</td></tr>
  24
  25 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The Set method sets one bool in the set.  <a href="#Set_28int_20number_29"></a><br></td></tr>
  26 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBoolSet.html#Get_28int_20number_29">Get</a> (int number)</td></tr>
  27
  28 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The Get method returns the value of one bool in the set.  <a href="#Get_28int_20number_29"></a><br></td></tr>
  29 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBoolSet.html#Unset_28int_20number_29">Unset</a> (int number)</td></tr>
  30
  31 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The Unset method unsets one value in the set.  <a href="#Unset_28int_20number_29"></a><br></td></tr>
  32 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBoolSet.html#Invert_28int_20number_29">Invert</a> (int number)</td></tr>
  33
  34 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The Unset method inverts (flips) one value in the set.  <a href="#Invert_28int_20number_29"></a><br></td></tr>
  35 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBoolSet.html#operator_3D_3D_28BoolSet_20other_29">operator==</a> (<a class="el" href="classBoolSet.html">BoolSet</a> other)</td></tr>
  36
  37 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compare two BoolSets.  <a href="#operator_3D_3D_28BoolSet_20other_29"></a><br></td></tr>
  38 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classBoolSet.html">BoolSet</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBoolSet.html#operator_7C_28BoolSet_20other_29">operator|</a> (<a class="el" href="classBoolSet.html">BoolSet</a> other)</td></tr>
  39
  40 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">OR two BoolSets together.  <a href="#operator_7C_28BoolSet_20other_29"></a><br></td></tr>
  41 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classBoolSet.html">BoolSet</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBoolSet.html#operator_20_26_28BoolSet_20other_29">operator &amp;</a> (<a class="el" href="classBoolSet.html">BoolSet</a> other)</td></tr>
  42
  43 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">AND two BoolSets together.  <a href="#operator_20_26_28BoolSet_20other_29"></a><br></td></tr>
  44 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBoolSet.html#operator_3D_28BoolSet_20other_29">operator=</a> (<a class="el" href="classBoolSet.html">BoolSet</a> other)</td></tr>
  45
  46 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assign one BoolSet to another.  <a href="#operator_3D_28BoolSet_20other_29"></a><br></td></tr>
  47 <tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
  48 <tr><td class="memItemLeft" nowrap align="right" valign="top">char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBoolSet.html#bits">bits</a></td></tr>
  49
  50 </table>
  51 <hr><a name="_details"></a><h2>Detailed Description</h2>
  52 BoolSet is a utility class designed to hold eight bools in a bitmask.
  53 <p>
  54 Use <a class="el" href="classBoolSet.html#Set_28int_20number_29">BoolSet::Set</a> and <a class="el" href="classBoolSet.html#Get_28int_20number_29">BoolSet::Get</a> to set and get bools in the bitmask, and Unset and Invert for special operations upon them.
  55 <p>
  56
  57 <p>
  58 Definition at line <a class="el" href="base_8h-source.html#l00104">104</a> of file <a class="el" href="base_8h-source.html">base.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
  59 <a class="anchor" name="BoolSet_28_29"></a><!-- doxytag: member="BoolSet::BoolSet" ref="BoolSet_28_29" args="()" --><p>
  60 <table class="mdTable" cellpadding="2" cellspacing="0">
  61   <tr>
  62     <td class="mdRow">
  63       <table cellpadding="0" cellspacing="0" border="0">
  64         <tr>
  65           <td class="md" nowrap valign="top">BoolSet::BoolSet           </td>
  66           <td class="md" valign="top">(&nbsp;</td>
  67           <td class="mdname1" valign="top" nowrap>          </td>
  68           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  69           <td class="md" nowrap></td>
  70         </tr>
  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 The default constructor initializes the BoolSet to all values unset.
  84 <p>
  85     </td>
  86   </tr>
  87 </table>
  88 <a class="anchor" name="BoolSet_28char_20bitmask_29"></a><!-- doxytag: member="BoolSet::BoolSet" ref="BoolSet_28char_20bitmask_29" args="(char bitmask)" --><p>
  89 <table class="mdTable" cellpadding="2" cellspacing="0">
  90   <tr>
  91     <td class="mdRow">
  92       <table cellpadding="0" cellspacing="0" border="0">
  93         <tr>
  94           <td class="md" nowrap valign="top">BoolSet::BoolSet           </td>
  95           <td class="md" valign="top">(&nbsp;</td>
  96           <td class="md" nowrap valign="top">char&nbsp;</td>
  97           <td class="mdname1" valign="top" nowrap> <em>bitmask</em>          </td>
  98           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  99           <td class="md" nowrap></td>
 100         </tr>
 101       </table>
 102     </td>
 103   </tr>
 104 </table>
 105 <table cellspacing="5" cellpadding="0" border="0">
 106   <tr>
 107     <td>
 108       &nbsp;
 109     </td>
 110     <td>
 111
 112 <p>
 113 This constructor copies the default bitmask from a char.
 114 <p>
 115     </td>
 116   </tr>
 117 </table>
 118 <hr><h2>Member Function Documentation</h2>
 119 <a class="anchor" name="Get_28int_20number_29"></a><!-- doxytag: member="BoolSet::Get" ref="Get_28int_20number_29" args="(int number)" --><p>
 120 <table class="mdTable" cellpadding="2" cellspacing="0">
 121   <tr>
 122     <td class="mdRow">
 123       <table cellpadding="0" cellspacing="0" border="0">
 124         <tr>
 125           <td class="md" nowrap valign="top">bool BoolSet::Get           </td>
 126           <td class="md" valign="top">(&nbsp;</td>
 127           <td class="md" nowrap valign="top">int&nbsp;</td>
 128           <td class="mdname1" valign="top" nowrap> <em>number</em>          </td>
 129           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 130           <td class="md" nowrap></td>
 131         </tr>
 132       </table>
 133     </td>
 134   </tr>
 135 </table>
 136 <table cellspacing="5" cellpadding="0" border="0">
 137   <tr>
 138     <td>
 139       &nbsp;
 140     </td>
 141     <td>
 142
 143 <p>
 144 The Get method returns the value of one bool in the set.
 145 <p>
 146 <dl compact><dt><b>Parameters:</b></dt><dd>
 147   <table border="0" cellspacing="2" cellpadding="0">
 148     <tr><td valign="top"></td><td valign="top"><em>number</em>&nbsp;</td><td>The number of the item to retrieve. This must be between 0 and 7.</td></tr>
 149   </table>
 150 </dl>
 151 <dl compact><dt><b>Returns:</b></dt><dd>True if the item is set, false if it is unset.</dd></dl>
 152     </td>
 153   </tr>
 154 </table>
 155 <a class="anchor" name="Invert_28int_20number_29"></a><!-- doxytag: member="BoolSet::Invert" ref="Invert_28int_20number_29" args="(int number)" --><p>
 156 <table class="mdTable" cellpadding="2" cellspacing="0">
 157   <tr>
 158     <td class="mdRow">
 159       <table cellpadding="0" cellspacing="0" border="0">
 160         <tr>
 161           <td class="md" nowrap valign="top">void BoolSet::Invert           </td>
 162           <td class="md" valign="top">(&nbsp;</td>
 163           <td class="md" nowrap valign="top">int&nbsp;</td>
 164           <td class="mdname1" valign="top" nowrap> <em>number</em>          </td>
 165           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 166           <td class="md" nowrap></td>
 167         </tr>
 168       </table>
 169     </td>
 170   </tr>
 171 </table>
 172 <table cellspacing="5" cellpadding="0" border="0">
 173   <tr>
 174     <td>
 175       &nbsp;
 176     </td>
 177     <td>
 178
 179 <p>
 180 The Unset method inverts (flips) one value in the set.
 181 <p>
 182 <dl compact><dt><b>Parameters:</b></dt><dd>
 183   <table border="0" cellspacing="2" cellpadding="0">
 184     <tr><td valign="top"></td><td valign="top"><em>number</em>&nbsp;</td><td>The number of the item to invert. This must be between 0 and 7.</td></tr>
 185   </table>
 186 </dl>
 187     </td>
 188   </tr>
 189 </table>
 190 <a class="anchor" name="operator_20_26_28BoolSet_20other_29"></a><!-- doxytag: member="BoolSet::operator &amp;" ref="operator_20_26_28BoolSet_20other_29" args="(BoolSet other)" --><p>
 191 <table class="mdTable" cellpadding="2" cellspacing="0">
 192   <tr>
 193     <td class="mdRow">
 194       <table cellpadding="0" cellspacing="0" border="0">
 195         <tr>
 196           <td class="md" nowrap valign="top"><a class="el" href="classBoolSet.html">BoolSet</a> BoolSet::operator &amp;           </td>
 197           <td class="md" valign="top">(&nbsp;</td>
 198           <td class="md" nowrap valign="top"><a class="el" href="classBoolSet.html">BoolSet</a>&nbsp;</td>
 199           <td class="mdname1" valign="top" nowrap> <em>other</em>          </td>
 200           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 201           <td class="md" nowrap></td>
 202         </tr>
 203       </table>
 204     </td>
 205   </tr>
 206 </table>
 207 <table cellspacing="5" cellpadding="0" border="0">
 208   <tr>
 209     <td>
 210       &nbsp;
 211     </td>
 212     <td>
 213
 214 <p>
 215 AND two BoolSets together.
 216 <p>
 217     </td>
 218   </tr>
 219 </table>
 220 <a class="anchor" name="operator_3D_28BoolSet_20other_29"></a><!-- doxytag: member="BoolSet::operator=" ref="operator_3D_28BoolSet_20other_29" args="(BoolSet other)" --><p>
 221 <table class="mdTable" cellpadding="2" cellspacing="0">
 222   <tr>
 223     <td class="mdRow">
 224       <table cellpadding="0" cellspacing="0" border="0">
 225         <tr>
 226           <td class="md" nowrap valign="top">bool BoolSet::operator=           </td>
 227           <td class="md" valign="top">(&nbsp;</td>
 228           <td class="md" nowrap valign="top"><a class="el" href="classBoolSet.html">BoolSet</a>&nbsp;</td>
 229           <td class="mdname1" valign="top" nowrap> <em>other</em>          </td>
 230           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 231           <td class="md" nowrap></td>
 232         </tr>
 233       </table>
 234     </td>
 235   </tr>
 236 </table>
 237 <table cellspacing="5" cellpadding="0" border="0">
 238   <tr>
 239     <td>
 240       &nbsp;
 241     </td>
 242     <td>
 243
 244 <p>
 245 Assign one BoolSet to another.
 246 <p>
 247     </td>
 248   </tr>
 249 </table>
 250 <a class="anchor" name="operator_3D_3D_28BoolSet_20other_29"></a><!-- doxytag: member="BoolSet::operator==" ref="operator_3D_3D_28BoolSet_20other_29" args="(BoolSet other)" --><p>
 251 <table class="mdTable" cellpadding="2" cellspacing="0">
 252   <tr>
 253     <td class="mdRow">
 254       <table cellpadding="0" cellspacing="0" border="0">
 255         <tr>
 256           <td class="md" nowrap valign="top">bool BoolSet::operator==           </td>
 257           <td class="md" valign="top">(&nbsp;</td>
 258           <td class="md" nowrap valign="top"><a class="el" href="classBoolSet.html">BoolSet</a>&nbsp;</td>
 259           <td class="mdname1" valign="top" nowrap> <em>other</em>          </td>
 260           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 261           <td class="md" nowrap></td>
 262         </tr>
 263       </table>
 264     </td>
 265   </tr>
 266 </table>
 267 <table cellspacing="5" cellpadding="0" border="0">
 268   <tr>
 269     <td>
 270       &nbsp;
 271     </td>
 272     <td>
 273
 274 <p>
 275 Compare two BoolSets.
 276 <p>
 277     </td>
 278   </tr>
 279 </table>
 280 <a class="anchor" name="operator_7C_28BoolSet_20other_29"></a><!-- doxytag: member="BoolSet::operator|" ref="operator_7C_28BoolSet_20other_29" args="(BoolSet other)" --><p>
 281 <table class="mdTable" cellpadding="2" cellspacing="0">
 282   <tr>
 283     <td class="mdRow">
 284       <table cellpadding="0" cellspacing="0" border="0">
 285         <tr>
 286           <td class="md" nowrap valign="top"><a class="el" href="classBoolSet.html">BoolSet</a> BoolSet::operator|           </td>
 287           <td class="md" valign="top">(&nbsp;</td>
 288           <td class="md" nowrap valign="top"><a class="el" href="classBoolSet.html">BoolSet</a>&nbsp;</td>
 289           <td class="mdname1" valign="top" nowrap> <em>other</em>          </td>
 290           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 291           <td class="md" nowrap></td>
 292         </tr>
 293       </table>
 294     </td>
 295   </tr>
 296 </table>
 297 <table cellspacing="5" cellpadding="0" border="0">
 298   <tr>
 299     <td>
 300       &nbsp;
 301     </td>
 302     <td>
 303
 304 <p>
 305 OR two BoolSets together.
 306 <p>
 307     </td>
 308   </tr>
 309 </table>
 310 <a class="anchor" name="Set_28int_20number_29"></a><!-- doxytag: member="BoolSet::Set" ref="Set_28int_20number_29" args="(int number)" --><p>
 311 <table class="mdTable" cellpadding="2" cellspacing="0">
 312   <tr>
 313     <td class="mdRow">
 314       <table cellpadding="0" cellspacing="0" border="0">
 315         <tr>
 316           <td class="md" nowrap valign="top">void BoolSet::Set           </td>
 317           <td class="md" valign="top">(&nbsp;</td>
 318           <td class="md" nowrap valign="top">int&nbsp;</td>
 319           <td class="mdname1" valign="top" nowrap> <em>number</em>          </td>
 320           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 321           <td class="md" nowrap></td>
 322         </tr>
 323       </table>
 324     </td>
 325   </tr>
 326 </table>
 327 <table cellspacing="5" cellpadding="0" border="0">
 328   <tr>
 329     <td>
 330       &nbsp;
 331     </td>
 332     <td>
 333
 334 <p>
 335 The Set method sets one bool in the set.
 336 <p>
 337 <dl compact><dt><b>Parameters:</b></dt><dd>
 338   <table border="0" cellspacing="2" cellpadding="0">
 339     <tr><td valign="top"></td><td valign="top"><em>number</em>&nbsp;</td><td>The number of the item to set. This must be between 0 and 7.</td></tr>
 340   </table>
 341 </dl>
 342     </td>
 343   </tr>
 344 </table>
 345 <a class="anchor" name="Unset_28int_20number_29"></a><!-- doxytag: member="BoolSet::Unset" ref="Unset_28int_20number_29" args="(int number)" --><p>
 346 <table class="mdTable" cellpadding="2" cellspacing="0">
 347   <tr>
 348     <td class="mdRow">
 349       <table cellpadding="0" cellspacing="0" border="0">
 350         <tr>
 351           <td class="md" nowrap valign="top">void BoolSet::Unset           </td>
 352           <td class="md" valign="top">(&nbsp;</td>
 353           <td class="md" nowrap valign="top">int&nbsp;</td>
 354           <td class="mdname1" valign="top" nowrap> <em>number</em>          </td>
 355           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 356           <td class="md" nowrap></td>
 357         </tr>
 358       </table>
 359     </td>
 360   </tr>
 361 </table>
 362 <table cellspacing="5" cellpadding="0" border="0">
 363   <tr>
 364     <td>
 365       &nbsp;
 366     </td>
 367     <td>
 368
 369 <p>
 370 The Unset method unsets one value in the set.
 371 <p>
 372 <dl compact><dt><b>Parameters:</b></dt><dd>
 373   <table border="0" cellspacing="2" cellpadding="0">
 374     <tr><td valign="top"></td><td valign="top"><em>number</em>&nbsp;</td><td>The number of the item to set. This must be between 0 and 7.</td></tr>
 375   </table>
 376 </dl>
 377     </td>
 378   </tr>
 379 </table>
 380 <hr><h2>Member Data Documentation</h2>
 381 <a class="anchor" name="bits"></a><!-- doxytag: member="BoolSet::bits" ref="bits" args="" --><p>
 382 <table class="mdTable" cellpadding="2" cellspacing="0">
 383   <tr>
 384     <td class="mdRow">
 385       <table cellpadding="0" cellspacing="0" border="0">
 386         <tr>
 387           <td class="md" nowrap valign="top">char <a class="el" href="classBoolSet.html#bits">BoolSet::bits</a><code> [private]</code>          </td>
 388         </tr>
 389       </table>
 390     </td>
 391   </tr>
 392 </table>
 393 <table cellspacing="5" cellpadding="0" border="0">
 394   <tr>
 395     <td>
 396       &nbsp;
 397     </td>
 398     <td>
 399
 400 <p>
 401
 402 <p>
 403 Definition at line <a class="el" href="base_8h-source.html#l00106">106</a> of file <a class="el" href="base_8h-source.html">base.h</a>.    </td>
 404   </tr>
 405 </table>
 406 <hr>The documentation for this class was generated from the following file:<ul>
 407 <li><a class="el" href="base_8h-source.html">base.h</a></ul>
 408 <hr size="1"><address style="align: right;"><small>Generated on Mon Dec 19 18:05:21 2005 for InspIRCd by&nbsp;
 409 <a href="http://www.doxygen.org/index.html">
 410 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
 411 </body>
 412 </html>