summaryrefslogtreecommitdiff
path: root/docs/module-doc/classBoolSet.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/module-doc/classBoolSet.html')
-rw-r--r--docs/module-doc/classBoolSet.html412
1 files changed, 0 insertions, 412 deletions
diff --git a/docs/module-doc/classBoolSet.html b/docs/module-doc/classBoolSet.html
deleted file mode 100644
index 61a5de168..000000000
--- a/docs/module-doc/classBoolSet.html
+++ /dev/null
@@ -1,412 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
-<title>InspIRCd: BoolSet Class Reference</title>
-<link href="inspircd.doxygen.css" rel="stylesheet" type="text/css">
-</head><body>
-<!-- Generated by Doxygen 1.4.4-20050815 -->
-<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>
-<h1>BoolSet Class Reference</h1><!-- doxytag: class="BoolSet" -->BoolSet is a utility class designed to hold eight bools in a bitmask.
-<a href="#_details">More...</a>
-<p>
-<code>#include &lt;<a class="el" href="base_8h-source.html">base.h</a>&gt;</code>
-<p>
-Collaboration diagram for BoolSet:<p><center><img src="classBoolSet__coll__graph.gif" border="0" usemap="#BoolSet__coll__map" alt="Collaboration graph"></center>
-<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">
-<tr><td></td></tr>
-<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
-<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>
-
-<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>
-<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>
-
-<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>
-<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>
-
-<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>
-<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>
-
-<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>
-<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>
-
-<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>
-<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>
-
-<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>
-<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>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compare two BoolSets. <a href="#operator_3D_3D_28BoolSet_20other_29"></a><br></td></tr>
-<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>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">OR two BoolSets together. <a href="#operator_7C_28BoolSet_20other_29"></a><br></td></tr>
-<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>
-
-<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>
-<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>
-
-<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>
-<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
-<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>
-
-</table>
-<hr><a name="_details"></a><h2>Detailed Description</h2>
-BoolSet is a utility class designed to hold eight bools in a bitmask.
-<p>
-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.
-<p>
-
-<p>
-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>
-<a class="anchor" name="BoolSet_28_29"></a><!-- doxytag: member="BoolSet::BoolSet" ref="BoolSet_28_29" args="()" --><p>
-<table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top">BoolSet::BoolSet </td>
- <td class="md" valign="top">(&nbsp;</td>
- <td class="mdname1" valign="top" nowrap> </td>
- <td class="md" valign="top">&nbsp;)&nbsp;</td>
- <td class="md" nowrap></td>
- </tr>
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-The default constructor initializes the BoolSet to all values unset.
-<p>
- </td>
- </tr>
-</table>
-<a class="anchor" name="BoolSet_28char_20bitmask_29"></a><!-- doxytag: member="BoolSet::BoolSet" ref="BoolSet_28char_20bitmask_29" args="(char bitmask)" --><p>
-<table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top">BoolSet::BoolSet </td>
- <td class="md" valign="top">(&nbsp;</td>
- <td class="md" nowrap valign="top">char&nbsp;</td>
- <td class="mdname1" valign="top" nowrap> <em>bitmask</em> </td>
- <td class="md" valign="top">&nbsp;)&nbsp;</td>
- <td class="md" nowrap></td>
- </tr>
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-This constructor copies the default bitmask from a char.
-<p>
- </td>
- </tr>
-</table>
-<hr><h2>Member Function Documentation</h2>
-<a class="anchor" name="Get_28int_20number_29"></a><!-- doxytag: member="BoolSet::Get" ref="Get_28int_20number_29" args="(int number)" --><p>
-<table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top">bool BoolSet::Get </td>
- <td class="md" valign="top">(&nbsp;</td>
- <td class="md" nowrap valign="top">int&nbsp;</td>
- <td class="mdname1" valign="top" nowrap> <em>number</em> </td>
- <td class="md" valign="top">&nbsp;)&nbsp;</td>
- <td class="md" nowrap></td>
- </tr>
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-The Get method returns the value of one bool in the set.
-<p>
-<dl compact><dt><b>Parameters:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <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>
- </table>
-</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>True if the item is set, false if it is unset.</dd></dl>
- </td>
- </tr>
-</table>
-<a class="anchor" name="Invert_28int_20number_29"></a><!-- doxytag: member="BoolSet::Invert" ref="Invert_28int_20number_29" args="(int number)" --><p>
-<table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top">void BoolSet::Invert </td>
- <td class="md" valign="top">(&nbsp;</td>
- <td class="md" nowrap valign="top">int&nbsp;</td>
- <td class="mdname1" valign="top" nowrap> <em>number</em> </td>
- <td class="md" valign="top">&nbsp;)&nbsp;</td>
- <td class="md" nowrap></td>
- </tr>
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-The Unset method inverts (flips) one value in the set.
-<p>
-<dl compact><dt><b>Parameters:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <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>
- </table>
-</dl>
- </td>
- </tr>
-</table>
-<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>
-<table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"><a class="el" href="classBoolSet.html">BoolSet</a> BoolSet::operator &amp; </td>
- <td class="md" valign="top">(&nbsp;</td>
- <td class="md" nowrap valign="top"><a class="el" href="classBoolSet.html">BoolSet</a>&nbsp;</td>
- <td class="mdname1" valign="top" nowrap> <em>other</em> </td>
- <td class="md" valign="top">&nbsp;)&nbsp;</td>
- <td class="md" nowrap></td>
- </tr>
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-AND two BoolSets together.
-<p>
- </td>
- </tr>
-</table>
-<a class="anchor" name="operator_3D_28BoolSet_20other_29"></a><!-- doxytag: member="BoolSet::operator=" ref="operator_3D_28BoolSet_20other_29" args="(BoolSet other)" --><p>
-<table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top">bool BoolSet::operator= </td>
- <td class="md" valign="top">(&nbsp;</td>
- <td class="md" nowrap valign="top"><a class="el" href="classBoolSet.html">BoolSet</a>&nbsp;</td>
- <td class="mdname1" valign="top" nowrap> <em>other</em> </td>
- <td class="md" valign="top">&nbsp;)&nbsp;</td>
- <td class="md" nowrap></td>
- </tr>
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-Assign one BoolSet to another.
-<p>
- </td>
- </tr>
-</table>
-<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>
-<table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top">bool BoolSet::operator== </td>
- <td class="md" valign="top">(&nbsp;</td>
- <td class="md" nowrap valign="top"><a class="el" href="classBoolSet.html">BoolSet</a>&nbsp;</td>
- <td class="mdname1" valign="top" nowrap> <em>other</em> </td>
- <td class="md" valign="top">&nbsp;)&nbsp;</td>
- <td class="md" nowrap></td>
- </tr>
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-Compare two BoolSets.
-<p>
- </td>
- </tr>
-</table>
-<a class="anchor" name="operator_7C_28BoolSet_20other_29"></a><!-- doxytag: member="BoolSet::operator|" ref="operator_7C_28BoolSet_20other_29" args="(BoolSet other)" --><p>
-<table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"><a class="el" href="classBoolSet.html">BoolSet</a> BoolSet::operator| </td>
- <td class="md" valign="top">(&nbsp;</td>
- <td class="md" nowrap valign="top"><a class="el" href="classBoolSet.html">BoolSet</a>&nbsp;</td>
- <td class="mdname1" valign="top" nowrap> <em>other</em> </td>
- <td class="md" valign="top">&nbsp;)&nbsp;</td>
- <td class="md" nowrap></td>
- </tr>
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-OR two BoolSets together.
-<p>
- </td>
- </tr>
-</table>
-<a class="anchor" name="Set_28int_20number_29"></a><!-- doxytag: member="BoolSet::Set" ref="Set_28int_20number_29" args="(int number)" --><p>
-<table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top">void BoolSet::Set </td>
- <td class="md" valign="top">(&nbsp;</td>
- <td class="md" nowrap valign="top">int&nbsp;</td>
- <td class="mdname1" valign="top" nowrap> <em>number</em> </td>
- <td class="md" valign="top">&nbsp;)&nbsp;</td>
- <td class="md" nowrap></td>
- </tr>
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-The Set method sets one bool in the set.
-<p>
-<dl compact><dt><b>Parameters:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <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>
- </table>
-</dl>
- </td>
- </tr>
-</table>
-<a class="anchor" name="Unset_28int_20number_29"></a><!-- doxytag: member="BoolSet::Unset" ref="Unset_28int_20number_29" args="(int number)" --><p>
-<table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top">void BoolSet::Unset </td>
- <td class="md" valign="top">(&nbsp;</td>
- <td class="md" nowrap valign="top">int&nbsp;</td>
- <td class="mdname1" valign="top" nowrap> <em>number</em> </td>
- <td class="md" valign="top">&nbsp;)&nbsp;</td>
- <td class="md" nowrap></td>
- </tr>
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-The Unset method unsets one value in the set.
-<p>
-<dl compact><dt><b>Parameters:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <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>
- </table>
-</dl>
- </td>
- </tr>
-</table>
-<hr><h2>Member Data Documentation</h2>
-<a class="anchor" name="bits"></a><!-- doxytag: member="BoolSet::bits" ref="bits" args="" --><p>
-<table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top">char <a class="el" href="classBoolSet.html#bits">BoolSet::bits</a><code> [private]</code> </td>
- </tr>
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
- &nbsp;
- </td>
- <td>
-
-<p>
-
-<p>
-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>
- </tr>
-</table>
-<hr>The documentation for this class was generated from the following file:<ul>
-<li><a class="el" href="base_8h-source.html">base.h</a></ul>
-<hr size="1"><address style="align: right;"><small>Generated on Mon Dec 19 18:05:21 2005 for InspIRCd by&nbsp;
-<a href="http://www.doxygen.org/index.html">
-<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
-</body>
-</html>