BoolSet Class Reference

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

#include <base.h>

Collaboration diagram for BoolSet:

[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 104 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 106 of file base.h.

---

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

• base.h

---