The Simons     Component Library

           

---

BooleanBox Class Reference

#include <Value.h>

Inheritance diagram for BooleanBox:

List of all members.

---

Detailed Description

BooleanBox: the wrapper for a Boolean value.

Public Member Functions
	BooleanBox ()
	Construct a default BooleanBox.
	~BooleanBox ()
	Release a BooleanBox.
	BooleanBox (Boolean)
	Initialise a BooleanBox to a Boolean value.
virtual ObjectID	clone () const
	Clone a deep copy of this BooleanBox.
virtual TypeID	type () const
	Return the Type of this BooleanBox.
virtual Natural	hash () const
	Return a quasi-unique hash code for this BooleanBox.
virtual Order	compare (ObjectID) const
	Compare this BooleanBox with another.
Void	readOn (ReaderID)
	Read this BooleanBox on a Reader stream.
Void	writeOn (WriterID) const
	Write this BooleanBox on a Writer stream.
virtual Boolean	toBoolean () const
	Convert this BooleanBox to a Boolean value.

---

Constructor & Destructor Documentation

BooleanBox::BooleanBox (   )

Construct a default BooleanBox. Returns: a BooleanBox.

BooleanBox::~BooleanBox (   )

Release a BooleanBox.

BooleanBox::BooleanBox (  Boolean  value  )

Initialise a BooleanBox to a Boolean value. Parameters: value  - the Boolean value. Returns: a BooleanBox.

---

Member Function Documentation

ObjectID BooleanBox::clone (   )  const [virtual]

Clone a deep copy of this BooleanBox. Returns: a copy of this BooleanBox. Reimplemented from Object.

Order BooleanBox::compare (  ObjectID  other  )  const [virtual]

Compare this BooleanBox with another. Parameters: other  - the other BooleanBox. Returns: an Order in { NONE, LESS, EQUAL, MORE } Reimplemented from Object.

Natural BooleanBox::hash (   )  const [inline, virtual]

Return a quasi-unique hash code for this BooleanBox. Returns: a quasi-unique hash code. Reimplemented from Object.

Void BooleanBox::readOn (  ReaderID  in  )  [virtual]

Read this BooleanBox on a Reader stream. Read in the wrapped Boolean value. Reimplemented from Object.

Boolean BooleanBox::toBoolean (   )  const [inline, virtual]

Convert this BooleanBox to a Boolean value. Returns: a Boolean value. Reimplemented from Object.

TypeID BooleanBox::type (   )  const [virtual]

Return the Type of this BooleanBox. Returns: the type descriptor for "Boolean". Reimplemented from Object.

Void BooleanBox::writeOn (  WriterID  out  )  const [virtual]

Write this BooleanBox on a Writer stream. Write out the wrapped Boolean value. Reimplemented from Object.

---

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

• Value.h
• Value.cc

---