diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-05-30 05:23:22 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-05-30 05:23:22 +0000 |
| commit | 956328e80741c88cdae6d98b07be4171c98f4e26 (patch) | |
| tree | ad61830f2cc82fa0cc2e20294ed3416f3abf12ae /docs/module-doc/classBoolSet.html | |
| parent | 02c18fcb826e63ce7c654d44e9f0afe1eafa7a64 (diff) | |
Added docs for base: BoolSet
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1565 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classBoolSet.html')
| -rw-r--r-- | docs/module-doc/classBoolSet.html | 422 |
1 files changed, 422 insertions, 0 deletions
diff --git a/docs/module-doc/classBoolSet.html b/docs/module-doc/classBoolSet.html new file mode 100644 index 000000000..bf356dabe --- /dev/null +++ b/docs/module-doc/classBoolSet.html @@ -0,0 +1,422 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 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.3.3 --> +<div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Compound List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Compound Members</a> | <a class="qindex" href="globals.html">File Members</a></div> +<h1>BoolSet Class Reference</h1>BoolSet is a utility class designed to hold eight bools in a bitmask. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="base_8h-source.html">base.h</a>></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> </td><td class="memItemRight" valign=bottom><a class="el" href="classBoolSet.html#a0">BoolSet</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The default constructor initializes the BoolSet to all values unset. </em> <a href="#a0"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classBoolSet.html#a1">BoolSet</a> (char bitmask)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This constructor copies the default bitmask from a char. </em> <a href="#a1"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classBoolSet.html#a2">Set</a> (int number)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The Set method sets one bool in the set. </em> <a href="#a2"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classBoolSet.html#a3">Get</a> (int number)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The Get method returns the value of one bool in the set. </em> <a href="#a3"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classBoolSet.html#a4">Unset</a> (int number)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The Unset method unsets one value in the set. </em> <a href="#a4"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classBoolSet.html#a5">Invert</a> (int number)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The Unset method inverts (flips) one value in the set. </em> <a href="#a5"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classBoolSet.html#a6">operator==</a> (<a class="el" href="classBoolSet.html">BoolSet</a> other)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare two BoolSets. </em> <a href="#a6"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classBoolSet.html">BoolSet</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classBoolSet.html#a7">operator|</a> (<a class="el" href="classBoolSet.html">BoolSet</a> other)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">OR two BoolSets together. </em> <a href="#a7"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classBoolSet.html">BoolSet</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classBoolSet.html#a8">operator &</a> (<a class="el" href="classBoolSet.html">BoolSet</a> other)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">AND two BoolSets together. </em> <a href="#a8"></a><em><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classBoolSet.html#a9">operator=</a> (<a class="el" href="classBoolSet.html">BoolSet</a> other)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign one BoolSet to another. </em> <a href="#a9"></a><em><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classBoolSet.html#r0">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#a2">BoolSet::Set</a> and <a class="el" href="classBoolSet.html#a3">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#l00098">98</a> of file <a class="el" href="base_8h-source.html">base.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="BoolSet::BoolSet"></a><p> +<table class="mdTable" width="100%" 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">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +The default constructor initializes the BoolSet to all values unset. +<p> + </td> + </tr> +</table> +<a name="a1" doxytag="BoolSet::BoolSet"></a><p> +<table class="mdTable" width="100%" 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">( </td> + <td class="md" nowrap valign="top">char </td> + <td class="mdname1" valign="top" nowrap> <em>bitmask</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +This constructor copies the default bitmask from a char. +<p> + </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a3" doxytag="BoolSet::Get"></a><p> +<table class="mdTable" width="100%" 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">( </td> + <td class="md" nowrap valign="top">int </td> + <td class="mdname1" valign="top" nowrap> <em>number</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </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><em>number</em> </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 name="a5" doxytag="BoolSet::Invert"></a><p> +<table class="mdTable" width="100%" 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">( </td> + <td class="md" nowrap valign="top">int </td> + <td class="mdname1" valign="top" nowrap> <em>number</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </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><em>number</em> </td><td>The number of the item to invert. This must be between 0 and 7.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a name="a8" doxytag="BoolSet::operator &"></a><p> +<table class="mdTable" width="100%" 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">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classBoolSet.html">BoolSet</a> </td> + <td class="mdname1" valign="top" nowrap> <em>other</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +AND two BoolSets together. +<p> + </td> + </tr> +</table> +<a name="a9" doxytag="BoolSet::operator="></a><p> +<table class="mdTable" width="100%" 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">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classBoolSet.html">BoolSet</a> </td> + <td class="mdname1" valign="top" nowrap> <em>other</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Assign one BoolSet to another. +<p> + </td> + </tr> +</table> +<a name="a6" doxytag="BoolSet::operator=="></a><p> +<table class="mdTable" width="100%" 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">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classBoolSet.html">BoolSet</a> </td> + <td class="mdname1" valign="top" nowrap> <em>other</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Compare two BoolSets. +<p> + </td> + </tr> +</table> +<a name="a7" doxytag="BoolSet::operator|"></a><p> +<table class="mdTable" width="100%" 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">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classBoolSet.html">BoolSet</a> </td> + <td class="mdname1" valign="top" nowrap> <em>other</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +OR two BoolSets together. +<p> + </td> + </tr> +</table> +<a name="a2" doxytag="BoolSet::Set"></a><p> +<table class="mdTable" width="100%" 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">( </td> + <td class="md" nowrap valign="top">int </td> + <td class="mdname1" valign="top" nowrap> <em>number</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </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><em>number</em> </td><td>The number of the item to set. This must be between 0 and 7.</td></tr> + </table> +</dl> + </td> + </tr> +</table> +<a name="a4" doxytag="BoolSet::Unset"></a><p> +<table class="mdTable" width="100%" 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">( </td> + <td class="md" nowrap valign="top">int </td> + <td class="mdname1" valign="top" nowrap> <em>number</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </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><em>number</em> </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 name="r0" doxytag="BoolSet::bits"></a><p> +<table class="mdTable" width="100%" 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#r0">BoolSet::bits</a><code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="base_8h-source.html#l00100">100</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 May 30 05:16:29 2005 for InspIRCd by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 > +</a>1.3.3 </small></address> +</body> +</html> |