The Simons     Component Library

           

---

EntryID Class Reference

#include <EntryID.h>

Inheritance diagram for EntryID:

List of all members.

---

Detailed Description

EntryID: a typed reference to an Entry.

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

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

---

Constructor & Destructor Documentation

EntryID::EntryID (   )  [inline]

Declare an EntryID. Returns: a null EntryID.

EntryID::~EntryID (   )  [inline]

Release an EntryID.

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

Initialise an EntryID to refer explicitly to null. Parameters: null  - the null reference. Returns: an EntryID referring to null.

EntryID::EntryID (  const Entry *  entry  )  [inline]

Initialise an EntryID to refer to an Entry. Parameters: entry  - the Entry. Returns: an EntryID referring to the entry.

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

Initialise an EntryID to alias another EntryID. Parameters: pointer  - the other EntryID. Returns: an EntryID referring to the entry.

---

Member Function Documentation

Entry * EntryID::operator-> (   )  const

Invoke a method on this EntryID. Returns: the result of the method. Reimplemented from ObjectID.

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

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

EntryID & EntryID::operator= (  const Entry *  entry  )  [inline]

Reassign this EntryID to refer to an Entry. Parameters: entry  - the Entry. Returns: an EntryID referring to the entry.

---

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

• EntryID.h
• Entry.cc
• Entry.h

---