University of Sheffield   

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

ValueID Class Reference

#include <ValueID.h>

Inheritance diagram for ValueID:

ObjectID List of all members.

Detailed Description

ValueID: a typed reference to a basic Value.

ValueID is a strongly typed, reference counting pointer that refers to a Value. ValueID variables may be initialised to Value* objects and all subtypes. ValueID variables may alias objects held by other ValueID variables, or any subtype. When a ValueID acquires an object, it increments the object's reference count. When a ValueID releases an object, it decrements the object's reference count. If the reference count reaches zero, the object is automatically deleted.

A ValueID may be initialised with a Value object, or with literal Boolean, Character, Natural, Integer and Decimal values. In the latter cases, a Value is automatically constructed to wrap the value.


Public Member Functions

 ValueID ()
 Declare a ValueID.

 ~ValueID ()
 Release a ValueID.

 ValueID (const Null *)
 Initialise a ValueID explicitly to null.

 ValueID (const Value *)
 Initialise a ValueID to refer to a Value.

 ValueID (const ValueID &)
 Initialise a ValueID to alias another ValueID.

 ValueID (Boolean)
 Initialise a ValueID to refer to a Boolean value.

 ValueID (Character)
 Initialise a ValueID to refer to a Character value.

 ValueID (Natural)
 Initialise a ValueID to refer to a Natural number.

 ValueID (Integer)
 Initialise a ValueID to refer to an Integer number.

 ValueID (Decimal)
 Initialise a ValueID to refer to a Decimal number.

ValueID & operator= (const Value *)
 Reassign this ValueID to refer to a Value.

ValueID & operator= (const ValueID &)
 Reassign this ValueID to alias another ValueID.

Value * operator-> () const
 Invoke a method on this ValueID.

Constructor & Destructor Documentation

ValueID::ValueID (   )  [inline]
 

Declare a ValueID.

Returns:
a null ValueID.

ValueID::~ValueID (   )  [inline]
 

Release a ValueID.

ValueID::ValueID (  const Null *  null  )  [inline]
 

Initialise a ValueID explicitly to null.

Parameters:
null - the null reference.
Returns:
a ValueID referring to null.

ValueID::ValueID (  const Value *  box  )  [inline]
 

Initialise a ValueID to refer to a Value.

Parameters:
box - the Value.
Returns:
a ValueID referring to the box.

ValueID::ValueID (  const ValueID &  pointer  )  [inline]
 

Initialise a ValueID to alias another ValueID.

Parameters:
pointer - the other ValueID.
Returns:
a ValueID referring to the box.

ValueID::ValueID (  Boolean  value  )  [inline]
 

Initialise a ValueID to refer to a Boolean value.

Parameters:
value - the Boolean value.
Returns:
a ValueID referring to a boxed-up Boolean.

ValueID::ValueID (  Character  value  )  [inline]
 

Initialise a ValueID to refer to a Character value.

Parameters:
value - the Character value.
Returns:
a ValueID referring to a boxed-up Character.

ValueID::ValueID (  Natural  number  )  [inline]
 

Initialise a ValueID to refer to a Natural number.

Parameters:
number - the Natural number.
Returns:
a ValueID referring to a Natural number.

ValueID::ValueID (  Integer  number  )  [inline]
 

Initialise a ValueID to refer to an Integer number.

Parameters:
number - the Integer number.
Returns:
a ValueID referring to an Integer number.

ValueID::ValueID (  Decimal  number  )  [inline]
 

Initialise a ValueID to refer to a Decimal number.

Parameters:
number - the Decimal number.
Returns:
a ValueID referring to a Decimal number.

Member Function Documentation

Value * ValueID::operator-> (   )  const
 

Invoke a method on this ValueID.

Returns:
the result of the method.

Reimplemented from ObjectID.

ValueID & ValueID::operator= (  const ValueID &  pointer  )  [inline]
 

Reassign this ValueID to alias another ValueID.

Parameters:
pointer - the other ValueID.
Returns:
a ValueID referring to the same Value as the other ValueID.

ValueID & ValueID::operator= (  const Value *  box  )  [inline]
 

Reassign this ValueID to refer to a Value.

Parameters:
box - the Value.
Returns:
a ValueID referring to the box.

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