docs/module-doc/classBoolSet.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412

<!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 Thu Dec 15 11:14:17 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>