The Simons     Component Library

           

---

SetID Class Reference

#include <SetID.h>

Inheritance diagram for SetID:

List of all members.

---

Detailed Description

SetID: a typed reference to a Set.

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

Public Member Functions
	SetID ()
	Declare a SetID.
	~SetID ()
	Release a SetID.
	SetID (const Null *)
	Initialise a SetID to refer explicitly to null.
	SetID (const Set *)
	Initialise a SetID to refer to a Set.
	SetID (const SetID &)
	Initialise a SetID to alias another SetID.
SetID &	operator= (const Set *)
	Reassign this SetID to refer to a Set.
SetID &	operator= (const SetID &)
	Reassign this SetID to alias another SetID.
Set *	operator-> () const
	Invoke a method on this SetID.

---

Constructor & Destructor Documentation

SetID::SetID (   )  [inline]

Declare a SetID. Returns: a null SetID.

SetID::~SetID (   )  [inline]

Release a SetID.

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

Initialise a SetID to refer explicitly to null. Parameters: null  - the null reference. Returns: a SetID referring to null.

SetID::SetID (  const Set *  set  )  [inline]

Initialise a SetID to refer to a Set. Parameters: set  - the Set. Returns: a SetID referring to the set.

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

Initialise a SetID to alias another SetID. Parameters: pointer  - the other SetID. Returns: a SetID referring to the set.

---

Member Function Documentation

Set * SetID::operator-> (   )  const

Invoke a method on this SetID. Returns: the result of the method. Reimplemented from UnorderedID. Reimplemented in MapID.

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

Reassign this SetID to alias another SetID. Parameters: pointer  - the other SetID. Returns: a SetID referring to the same Set as the other SetID.

SetID & SetID::operator= (  const Set *  set  )  [inline]

Reassign this SetID to refer to a Set. Parameters: set  - the Set. Returns: a SetID referring to the set.

---

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

• SetID.h
• Set.cc
• Set.h

---