The Simons     Component Library

           

---

ListID Class Reference

#include <ListID.h>

Inheritance diagram for ListID:

List of all members.

---

Detailed Description

ListID: a typed reference to a List.

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

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

---

Constructor & Destructor Documentation

ListID::ListID (   )  [inline]

Declare a ListID. Returns: a null ListID.

ListID::~ListID (   )  [inline]

Release a ListID.

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

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

ListID::ListID (  const List *  list  )  [inline]

Initialise a ListID to refer to a List. Parameters: list  - the List. Returns: a ListID referring to the list.

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

Initialise a ListID to alias another ListID. Parameters: pointer  - the other ListID. Returns: a ListID referring to the list.

---

Member Function Documentation

List * ListID::operator-> (   )  const

Invoke a method on this ListID. Returns: the result of the method. Reimplemented from SequenceID.

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

Reassign this ListID to alias another ListID. Parameters: pointer  - the other ListID. Returns: an ListID referring to the same List as the other ListID.

ListID & ListID::operator= (  const List *  list  )  [inline]

Reassign this ListID to refer to a List. Parameters: list  - the List. Returns: a ListID referring to the list.

---

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

• ListID.h
• List.cc
• List.h

---