The Simons     Component Library

           

---

VectorID Class Reference

#include <VectorID.h>

Inheritance diagram for VectorID:

List of all members.

---

Detailed Description

VectorID: a typed reference to a Vector.

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

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

---

Constructor & Destructor Documentation

VectorID::VectorID (   )  [inline]

Declare a VectorID. Returns: a null VectorID.

VectorID::~VectorID (   )  [inline]

Release a VectorID.

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

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

VectorID::VectorID (  const Vector *  vector  )  [inline]

Initialise a VectorID to refer to a Vector. Parameters: vector  - the Vector. Returns: a VectorID referring to the vector.

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

Initialise a VectorID to alias another VectorID. Parameters: pointer  - the other VectorID. Returns: a VectorID referring to the vector.

---

Member Function Documentation

Vector * VectorID::operator-> (   )  const

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

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

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

VectorID & VectorID::operator= (  const Vector *  vector  )  [inline]

Reassign this VectorID to refer to a Vector. Parameters: vector  - the Vector. Returns: a VectorID referring to the vector.

---

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

• VectorID.h
• Vector.cc
• Vector.h

---