From 956328e80741c88cdae6d98b07be4171c98f4e26 Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 30 May 2005 05:23:22 +0000 Subject: Added docs for base: BoolSet git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1565 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classBoolSet.html | 422 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 422 insertions(+) create mode 100644 docs/module-doc/classBoolSet.html (limited to 'docs/module-doc/classBoolSet.html') 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 @@ + + +InspIRCd: BoolSet class Reference + + + +
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members
+

BoolSet Class Reference

BoolSet is a utility class designed to hold eight bools in a bitmask. +More... +

+#include <base.h> +

+Collaboration diagram for BoolSet:

Collaboration graph
+
[legend]
List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

 BoolSet ()
 The default constructor initializes the BoolSet to all values unset.

 BoolSet (char bitmask)
 This constructor copies the default bitmask from a char.

void Set (int number)
 The Set method sets one bool in the set.

bool Get (int number)
 The Get method returns the value of one bool in the set.

void Unset (int number)
 The Unset method unsets one value in the set.

void Invert (int number)
 The Unset method inverts (flips) one value in the set.

bool operator== (BoolSet other)
 Compare two BoolSets.

BoolSet operator| (BoolSet other)
 OR two BoolSets together.

BoolSet operator & (BoolSet other)
 AND two BoolSets together.

bool operator= (BoolSet other)
 Assign one BoolSet to another.


Private Attributes

char bits
+

Detailed Description

+BoolSet is a utility class designed to hold eight bools in a bitmask. +

+Use BoolSet::Set and BoolSet::Get to set and get bools in the bitmask, and Unset and Invert for special operations upon them. +

+ +

+Definition at line 98 of file base.h.

Constructor & Destructor Documentation

+

+ + + + +
+ + + + + + + + + +
BoolSet::BoolSet (   ) 
+
+ + + + + +
+   + + +

+The default constructor initializes the BoolSet to all values unset. +

+

+

+ + + + +
+ + + + + + + + + + +
BoolSet::BoolSet ( char  bitmask  ) 
+
+ + + + + +
+   + + +

+This constructor copies the default bitmask from a char. +

+

+

Member Function Documentation

+

+ + + + +
+ + + + + + + + + + +
bool BoolSet::Get ( int  number  ) 
+
+ + + + + +
+   + + +

+The Get method returns the value of one bool in the set. +

+

Parameters:
+ + +
number The number of the item to retrieve. This must be between 0 and 7.
+
+
Returns:
True if the item is set, false if it is unset.
+
+

+ + + + +
+ + + + + + + + + + +
void BoolSet::Invert ( int  number  ) 
+
+ + + + + +
+   + + +

+The Unset method inverts (flips) one value in the set. +

+

Parameters:
+ + +
number The number of the item to invert. This must be between 0 and 7.
+
+
+

+ + + + +
+ + + + + + + + + + +
BoolSet BoolSet::operator & ( BoolSet  other  ) 
+
+ + + + + +
+   + + +

+AND two BoolSets together. +

+

+

+ + + + +
+ + + + + + + + + + +
bool BoolSet::operator= ( BoolSet  other  ) 
+
+ + + + + +
+   + + +

+Assign one BoolSet to another. +

+

+

+ + + + +
+ + + + + + + + + + +
bool BoolSet::operator== ( BoolSet  other  ) 
+
+ + + + + +
+   + + +

+Compare two BoolSets. +

+

+

+ + + + +
+ + + + + + + + + + +
BoolSet BoolSet::operator| ( BoolSet  other  ) 
+
+ + + + + +
+   + + +

+OR two BoolSets together. +

+

+

+ + + + +
+ + + + + + + + + + +
void BoolSet::Set ( int  number  ) 
+
+ + + + + +
+   + + +

+The Set method sets one bool in the set. +

+

Parameters:
+ + +
number The number of the item to set. This must be between 0 and 7.
+
+
+

+ + + + +
+ + + + + + + + + + +
void BoolSet::Unset ( int  number  ) 
+
+ + + + + +
+   + + +

+The Unset method unsets one value in the set. +

+

Parameters:
+ + +
number The number of the item to set. This must be between 0 and 7.
+
+
+

Member Data Documentation

+

+ + + + +
+ + +
char BoolSet::bits [private] +
+
+ + + + + +
+   + + +

+ +

+Definition at line 100 of file base.h.

+

The documentation for this class was generated from the following file: +
Generated on Mon May 30 05:16:29 2005 for InspIRCd by + +doxygen +1.3.3
+ + -- cgit v1.2.3