The Simons     Component Library

           

---

OutputID Class Reference

#include <OutputID.h>

Inheritance diagram for OutputID:

List of all members.

---

Detailed Description

OutputID: a typed reference to an Output.

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

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

---

Constructor & Destructor Documentation

OutputID::OutputID (   )  [inline]

Declare an OutputID. Returns: a null OutputID.

OutputID::~OutputID (   )  [inline]

Release an OutputID.

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

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

OutputID::OutputID (  const Output *  stream  )  [inline]

Initialise an OutputID to refer to an Output. Parameters: stream  - the Output. Returns: an OutputID referring to the stream.

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

Initialise an OutputID to alias another OutputID. Parameters: pointer  - the other OutputID. Returns: an OutputID referring to the stream.

---

Member Function Documentation

Output * OutputID::operator-> (   )  const

Invoke a method on this OutputID. Returns: the result of the method. Reimplemented from FileStreamID. Reimplemented in TextOutputID, and WebOutputID.

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

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

OutputID & OutputID::operator= (  const Output *  stream  )  [inline]

Reassign this OutputID to refer to an Output. Parameters: stream  - the Output. Returns: an OutputID referring to the stream.

---

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

• OutputID.h
• Output.cc
• Output.h

---