The Simons     Component Library

           

---

CharacterBox Class Reference

#include <Value.h>

Inheritance diagram for CharacterBox:

List of all members.

---

Detailed Description

CharacterBox: the wrapper for a Character value.

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

---

Constructor & Destructor Documentation

CharacterBox::CharacterBox (   )

Construct a default CharacterBox. Returns: a CharacterBox.

CharacterBox::~CharacterBox (   )

Release a CharacterBox.

CharacterBox::CharacterBox (  Character  value  )

Initialise a CharacterBox to a Character value. Parameters: value  - the Character value. Returns: a CharacterBox.

---

Member Function Documentation

ObjectID CharacterBox::clone (   )  const [virtual]

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

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

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

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

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

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

Read this CharacterBox on a Reader stream. Read in the wrapped Character value. Reimplemented from Object.

Character CharacterBox::toCharacter (   )  const [inline, virtual]

Convert this CharacterBox to a Character value. Returns: a Character value. Reimplemented from Object.

TypeID CharacterBox::type (   )  const [virtual]

Return the Type of this CharacterBox. Returns: the type descriptor for "Character". Reimplemented from Object.

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

Write this CharacterBox on a Writer stream. Write out the wrapped Character value. Reimplemented from Object.

---

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

• Value.h
• Value.cc

---