BALL::Bit Class Reference
[Miscellaneous]

Bit Class. More...

#include <bitVector.h>

List of all members.

Classes
class	IllegalOperation
	Exception thrown if a file could not be processed right. More...
Public Member Functions
Constructors and Destructors
	Bit ()
	Default constructor.
	Bit (const Bit &bit)
	Copy constructor.
	Bit (BitVector *bitvector, Index index=0) throw (Exception::NullPointer)
	Detailed constructor.
	Bit (const BitVector *const bitvector, Index index=0) throw (Exception::NullPointer, Exception::IndexUnderflow, Exception::IndexOverflow)
	Detailed constructor.
virtual	~Bit ()
	Destructor.
Converters
	operator bool () const throw (Exception::NullPointer)
	Casting operator from Bit to bool.
Bit &	operator= (const Bit &bit)
	Assignment.
Bit &	operator= (const bool bit) throw (Exception::NullPointer, IllegalOperation)
	Assignment operator.
virtual void	clear ()
	Clear method.
Predicates
bool	operator== (const Bit &bit) const
	Equality operator.
bool	operator== (bool bit) const throw (Exception::NullPointer)
	Equality operator.
bool	operator!= (const Bit &bit) const
	Inequality operator.
bool	operator!= (bool bit) const throw (Exception::NullPointer)
	Inequality operator.

---

Detailed Description

Bit Class.

This class represents a bit within a BitVector.

See also:

BitVector.

---

Constructor & Destructor Documentation

BALL::Bit::Bit	(	BitVector *	bitvector,
		Index	index = 0
	)			throw (Exception::NullPointer)

Detailed constructor.

For use with nonconst bitvector. The bitvector can be resized by accessing bits out of the bitvectors range.

Exceptions:

NullPointer

if bitvector is equal to 0

BALL::Bit::Bit	(	const BitVector *const	bitvector,
		Index	index = 0
	)			throw (Exception::NullPointer, Exception::IndexUnderflow, Exception::IndexOverflow)

Detailed constructor.

For use with const bitvector.

Exceptions:

	NullPointer	if bitvector is equal to 0
	IndexUnderflow	if index is too small
	IndexOverflow	if index is greater than the size of bitvector

---

Member Function Documentation

bool BALL::Bit::operator!=

(

bool

bit

)

const throw (Exception::NullPointer)

Inequality operator.

Test if this instance has not the given bool value

bool BALL::Bit::operator!=

(

const Bit &

bit

)

const

Inequality operator.

Test if two instances point to different positions.

Bit& BALL::Bit::operator=

(

const bool

bit

)

throw (Exception::NullPointer, IllegalOperation)

Assignment operator.

Assign a bool value to this instance. The bit in the bitvector is set to the given value.

Exceptions:

IllegalOperation

if instance points to a const bitvector

Bit& BALL::Bit::operator=

(

const Bit &

bit

)

Assignment.

Assignment operator. Assign the position from a Bit to this instance

bool BALL::Bit::operator==

(

bool

bit

)

const throw (Exception::NullPointer)

Equality operator.

Test if this instance has the given bool value

bool BALL::Bit::operator==

(

const Bit &

bit

)

const

Equality operator.

Test if two instances have the same position in a bitvector