University of Sheffield   

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

RelationID Class Reference

#include <RelationID.h>

Inheritance diagram for RelationID:

BagID UnorderedID CollectionID ObjectID List of all members.

Detailed Description

RelationID: a typed reference to a Relation.

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


Public Member Functions

 RelationID ()
 Declare a RelationID.

 ~RelationID ()
 Release a RelationID.

 RelationID (const Null *)
 Initialise a RelationID to refer explicitly to null.

 RelationID (const Relation *)
 Initialise a RelationID to refer to a Relation.

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

RelationID & operator= (const Relation *)
 Reassign this RelationID to refer to a Relation.

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

Relation * operator-> () const
 Invoke a method on this RelationID.

Constructor & Destructor Documentation

RelationID::RelationID (   )  [inline]
 

Declare a RelationID.

Returns:
a null RelationID.

RelationID::~RelationID (   )  [inline]
 

Release a RelationID.

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

Initialise a RelationID to refer explicitly to null.

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

RelationID::RelationID (  const Relation *  relation  )  [inline]
 

Initialise a RelationID to refer to a Relation.

Parameters:
relation - the Relation.
Returns:
a RelationID referring to the relation.

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

Initialise a RelationID to alias another RelationID.

Parameters:
pointer - the other RelationID.
Returns:
a RelationID referring to the relation.

Member Function Documentation

Relation * RelationID::operator-> (   )  const
 

Invoke a method on this RelationID.

Returns:
the result of the method.

Reimplemented from BagID.

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

Reassign this RelationID to alias another RelationID.

Parameters:
pointer - the other RelationID.
Returns:
an RelationID referring to the same Relation as the other RelationID.

RelationID & RelationID::operator= (  const Relation *  relation  )  [inline]
 

Reassign this RelationID to refer to a Relation.

Parameters:
relation - the Relation.
Returns:
a RelationID referring to the relation.

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