University of Sheffield   

    The Simons
    Component Library
Introduction   Class Hierarchy   Class Listing   Index of Classes   Index of Methods   Header Files  

NaturalBox Class Reference

#include <Value.h>

Inheritance diagram for NaturalBox:

Value Object List of all members.

Detailed Description

NaturalBox: the wrapper for a Natural value.


Public Member Functions

 NaturalBox ()
 Construct a default NaturalBox.

 ~NaturalBox ()
 Release a NaturalBox.

 NaturalBox (Natural)
 Initialise a NaturalBox to a Natural value.

virtual ObjectID clone () const
 Clone a deep copy of this NaturalBox.

virtual TypeID type () const
 Return the Type of this NaturalBox.

virtual Natural hash () const
 Return a quasi-unique hash code for this NaturalBox.

virtual Order compare (ObjectID) const
 Compare this NaturalBox with another.

Void readOn (ReaderID)
 Read this NaturalBox on a Reader stream.

Void writeOn (WriterID) const
 Write this NaturalBox on a Writer stream.

virtual Natural toNatural () const
 Convert this NaturalBox to a Natural value.

Constructor & Destructor Documentation

NaturalBox::NaturalBox (   ) 
 

Construct a default NaturalBox.

Returns:
a NaturalBox.

NaturalBox::~NaturalBox (   ) 
 

Release a NaturalBox.

NaturalBox::NaturalBox (  Natural  value  ) 
 

Initialise a NaturalBox to a Natural value.

Parameters:
value - the Natural value.
Returns:
a NaturalBox.

Member Function Documentation

ObjectID NaturalBox::clone (   )  const [virtual]
 

Clone a deep copy of this NaturalBox.

Returns:
a copy of this NaturalBox.

Reimplemented from Object.

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

Compare this NaturalBox with another.

Parameters:
other - the other NaturalBox.
Returns:
an Order in { NONE, LESS, EQUAL, MORE }

Reimplemented from Object.

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

Return a quasi-unique hash code for this NaturalBox.

Returns:
a quasi-unique hash code.

Reimplemented from Object.

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

Read this NaturalBox on a Reader stream.

Read in the wrapped Natural value.

Reimplemented from Object.

Natural NaturalBox::toNatural (   )  const [inline, virtual]
 

Convert this NaturalBox to a Natural value.

Returns:
a Natural value.

Reimplemented from Object.

TypeID NaturalBox::type (   )  const [virtual]
 

Return the Type of this NaturalBox.

Returns:
the type descriptor for "Natural".

Reimplemented from Object.

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

Write this NaturalBox on a Writer stream.

Write out the wrapped Natural value.

Reimplemented from Object.

The documentation for this class was generated from the following files:
Generated on Fri May 5 17:17:18 2006 for The Simons Component Library by doxygen1.3