The Simons     Component Library

           

---

IntegerBox Class Reference

#include <Value.h>

Inheritance diagram for IntegerBox:

List of all members.

---

Detailed Description

IntegerBox: the wrapper for an Integer value.

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

---

Constructor & Destructor Documentation

IntegerBox::IntegerBox (   )

Construct a default IntegerBox. Returns: an IntegerBox.

IntegerBox::~IntegerBox (   )

Release an IntegerBox.

IntegerBox::IntegerBox (  Integer  value  )

Initialise an IntegerBox to an Integer value. Parameters: value  - the Integer value. Returns: an IntegerBox.

---

Member Function Documentation

ObjectID IntegerBox::clone (   )  const [virtual]

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

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

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

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

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

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

Read this IntegerBox on a Reader stream. Read in the wrapped Integer value. Reimplemented from Object.

Integer IntegerBox::toInteger (   )  const [inline, virtual]

Convert this IntegerBox to an Integer value. Returns: an Integer value. Reimplemented from Object.

TypeID IntegerBox::type (   )  const [virtual]

Return the Type of this IntegerBox. Returns: the type descriptor for "Integer". Reimplemented from Object.

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

Write this IntegerBox on a Writer stream. Write out the wrapped Integer value. Reimplemented from Object.

---

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

• Value.h
• Value.cc

---