University of Sheffield   

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

FormatStreamID Class Reference

#include <FormatStreamID.h>

Inheritance diagram for FormatStreamID:

StreamID ObjectID ReaderID WriterID CGIReaderID XMLReaderID XMLWriterID List of all members.

Detailed Description

FormatStreamID: a typed reference to a FormatStream.

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


Public Member Functions

 FormatStreamID ()
 Declare a FormatStreamID.

 ~FormatStreamID ()
 Release a FormatStreamID.

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

 FormatStreamID (const FormatStream *)
 Initialise a FormatStreamID to refer to a FormatStream.

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

FormatStreamID & operator= (const FormatStream *)
 Reassign this FormatStreamID to refer to a FormatStream.

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

FormatStream * operator-> () const
 Invoke a method on this FormatStreamID.

Constructor & Destructor Documentation

FormatStreamID::FormatStreamID (   )  [inline]
 

Declare a FormatStreamID.

Returns:
a null FormatStreamID.

FormatStreamID::~FormatStreamID (   )  [inline]
 

Release a FormatStreamID.

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

Initialise a FormatStreamID to refer explicitly to null.

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

FormatStreamID::FormatStreamID (  const FormatStream *  stream  )  [inline]
 

Initialise a FormatStreamID to refer to a FormatStream.

Parameters:
stream - the FormatStream.
Returns:
a FormatStreamID referring to the stream.

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

Initialise a FormatStreamID to alias another FormatStreamID.

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

Member Function Documentation

FormatStream * FormatStreamID::operator-> (   )  const
 

Invoke a method on this FormatStreamID.

Returns:
the result of the method.

Reimplemented from StreamID.

Reimplemented in CGIReaderID, ReaderID, WriterID, XMLReaderID, and XMLWriterID.

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

Reassign this FormatStreamID to alias another FormatStreamID.

Parameters:
pointer - the other FormatStreamID.
Returns:
an FormatStreamID referring to the same FormatStream as the other FormatStreamID.

FormatStreamID & FormatStreamID::operator= (  const FormatStream *  stream  )  [inline]
 

Reassign this FormatStreamID to refer to a FormatStream.

Parameters:
stream - the FormatStream.
Returns:
a FormatStreamID referring to the stream.

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