The Simons     Component Library

           

---

TypeID Class Reference

#include <TypeID.h>

Inheritance diagram for TypeID:

List of all members.

---

Detailed Description

TypeID: a typed reference to a Type.

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

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

---

Constructor & Destructor Documentation

TypeID::TypeID (   )  [inline]

Declare a TypeID. Returns: a null TypeID.

TypeID::~TypeID (   )  [inline]

Release a TypeID.

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

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

TypeID::TypeID (  const Type *  type  )  [inline]

Initialise a TypeID to refer to a Type. Parameters: type  - the Type. Returns: a TypeID referring to the type.

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

Initialise a TypeID to alias another TypeID. Parameters: pointer  - the other TypeID. Returns: a TypeID referring to the type.

---

Member Function Documentation

Type * TypeID::operator-> (   )  const

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

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

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

TypeID & TypeID::operator= (  const Type *  type  )  [inline]

Reassign this TypeID to refer to a Type. Parameters: type  - the Type. Returns: a TypeID referring to the type.

---

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

• TypeID.h
• Type.cc
• Type.h

---