University of Sheffield   

    The Simons
    Component Library
Introduction   Class Hierarchy   Class Listing   Index of Classes   Index of Methods   Header Files  

TextOutputID Class Reference

#include <TextOutputID.h>

Inheritance diagram for TextOutputID:

OutputID FileStreamID StreamID ObjectID WebOutputID List of all members.

Detailed Description

TextOutputID: a typed reference to a TextOutput.

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


Public Member Functions

 TextOutputID ()
 Declare a TextOutputID.

 ~TextOutputID ()
 Release a TextOutputID.

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

 TextOutputID (const TextOutput *)
 Initialise a TextOutputID to refer to a TextOutput.

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

TextOutputID & operator= (const TextOutput *)
 Reassign this TextOutputID to refer to a TextOutput.

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

TextOutput * operator-> () const
 Invoke a method on this TextOutputID.

Constructor & Destructor Documentation

TextOutputID::TextOutputID (   )  [inline]
 

Declare a TextOutputID.

Returns:
a null TextOutputID.

TextOutputID::~TextOutputID (   )  [inline]
 

Release a TextOutputID.

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

Initialise a TextOutputID to refer explicitly to null.

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

TextOutputID::TextOutputID (  const TextOutput *  stream  )  [inline]
 

Initialise a TextOutputID to refer to a TextOutput.

Parameters:
stream - the TextOutput.
Returns:
a TextOutputID referring to the stream.

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

Initialise a TextOutputID to alias another TextOutputID.

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

Member Function Documentation

TextOutput * TextOutputID::operator-> (   )  const
 

Invoke a method on this TextOutputID.

Returns:
the result of the method.

Reimplemented from OutputID.

Reimplemented in WebOutputID.

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

Reassign this TextOutputID to alias another TextOutputID.

Parameters:
pointer - the other TextOutputID.
Returns:
a TextOutputID referring to the same TextOutput as the other TextOutputID.

TextOutputID & TextOutputID::operator= (  const TextOutput *  stream  )  [inline]
 

Reassign this TextOutputID to refer to a TextOutput.

Parameters:
stream - the TextOutput.
Returns:
a TextOutputID 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