The InspIRCd Project
Home | Developers | Wiki | Forums | Bug Tracker | SVN | Download
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

BoolSet Class Reference

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

#include <base.h>

Inheritance diagram for BoolSet:

Inheritance graph
[legend]
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
 Actual bit values.

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 160 of file base.h.

Constructor & Destructor Documentation

BoolSet::BoolSet (   ) 
 

The default constructor initializes the BoolSet to all values unset.

Definition at line 83 of file base.cpp.

References bits.

BoolSet::BoolSet (  char  bitmask  ) 
 

This constructor copies the default bitmask from a char.

Definition at line 88 of file base.cpp.

References bits.

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.

Definition at line 61 of file base.cpp.

References bitfields.

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.

Definition at line 56 of file base.cpp.

References bitfields, and bits.

BoolSet BoolSet::operator & (  BoolSet  other  ) 
 

AND two BoolSets together.

Definition at line 77 of file base.cpp.

References bits.

bool BoolSet::operator= (  BoolSet  other  ) 
 

Assign one BoolSet to another.

Definition at line 93 of file base.cpp.

References bits.

bool BoolSet::operator== (  BoolSet  other  ) 
 

Compare two BoolSets.

Definition at line 66 of file base.cpp.

References bits.

BoolSet BoolSet::operator| (  BoolSet  other  ) 
 

OR two BoolSets together.

Definition at line 71 of file base.cpp.

References bits.

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.

Definition at line 46 of file base.cpp.

References bitfields, and bits.

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.

Definition at line 51 of file base.cpp.

References bits, and inverted_bitfields.

Member Data Documentation

char BoolSet::bits [private]
 

Actual bit values.

Definition at line 163 of file base.h.

Referenced by BoolSet(), Invert(), operator &(), operator=(), operator==(), operator|(), Set(), and Unset().

The documentation for this class was generated from the following files: