University of Sheffield   

    The Simons
    Component Library

Introduction   Class Hierarchy   Class Listing   Index of Classes   Index of Methods   Header Files  

WebOutputID Class Reference

#include <WebOutputID.h>

Inheritance diagram for WebOutputID:

TextOutputID OutputID FileStreamID StreamID ObjectID List of all members.

Detailed Description

WebOutputID: a typed reference to a WebOutput.

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


Public Member Functions

 WebOutputID ()
 Declare a WebOutputID.

 ~WebOutputID ()
 Release a WebOutputID.

 WebOutputID (const Null *)
 Initialise a WebOutputID to refer explicitly to null.

 WebOutputID (const WebOutput *)
 Initialise a WebOutputID to refer to a WebOutput.

 WebOutputID (const WebOutputID &)
 Initialise a WebOutputID to alias another WebOutputID.

WebOutputID & operator= (const WebOutput *)
 Reassign this WebOutputID to refer to a WebOutput.

WebOutputID & operator= (const WebOutputID &)
 Reassign this WebOutputID to alias another WebOutputID.

WebOutputoperator-> () const
 Invoke a method on this WebOutputID.


Constructor & Destructor Documentation

WebOutputID::WebOutputID  )  [inline]
 

Declare a WebOutputID.

Returns:
a null WebOutputID.

WebOutputID::~WebOutputID  )  [inline]
 

Release a WebOutputID.

WebOutputID::WebOutputID const Null null  )  [inline]
 

Initialise a WebOutputID to refer explicitly to null.

Parameters:
null - the null reference.
Returns:
a WebOutputID referring to null.

WebOutputID::WebOutputID const WebOutput stream  )  [inline]
 

Initialise a WebOutputID to refer to a WebOutput.

Parameters:
stream - the WebOutput.
Returns:
a WebOutputID referring to the stream.

WebOutputID::WebOutputID const WebOutputID &  pointer  )  [inline]
 

Initialise a WebOutputID to alias another WebOutputID.

Parameters:
pointer - the other WebOutputID.
Returns:
a WebOutputID referring to the stream.


Member Function Documentation

WebOutput * WebOutputID::operator->  )  const
 

Invoke a method on this WebOutputID.

Returns:
the result of the method.

Reimplemented from TextOutputID.

WebOutputID & WebOutputID::operator= const WebOutputID &  pointer  )  [inline]
 

Reassign this WebOutputID to alias another WebOutputID.

Parameters:
pointer - the other WebOutputID.
Returns:
a WebOutputID referring to the same WebOutput as the other WebOutputID.

WebOutputID & WebOutputID::operator= const WebOutput stream  )  [inline]
 

Reassign this WebOutputID to refer to a WebOutput.

Parameters:
stream - the WebOutput.
Returns:
a WebOutputID referring to the stream.


The documentation for this class was generated from the following files:
Generated on Fri May 5 17:17:20 2006 for The Simons Component Library by doxygen1.3