The Simons     Component Library

           

---

StreamID Class Reference

#include <StreamID.h>

Inheritance diagram for StreamID:

List of all members.

---

Detailed Description

StreamID: a typed reference to a Stream.

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

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

---

Constructor & Destructor Documentation

StreamID::StreamID (   )  [inline]

Declare a StreamID. Returns: a null StreamID.

StreamID::~StreamID (   )  [inline]

Release a StreamID.

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

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

StreamID::StreamID (  const Stream *  stream  )  [inline]

Initialise a StreamID to refer to a Stream. Parameters: stream  - the Stream. Returns: a StreamID referring to the stream.

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

Initialise a StreamID to alias another StreamID. Parameters: pointer  - the other StreamID. Returns: a StreamID referring to the stream.

---

Member Function Documentation

Stream * StreamID::operator-> (   )  const

Invoke a method on this StreamID. Returns: the result of the method. Reimplemented from ObjectID. Reimplemented in CGIReaderID, FileStreamID, FormatStreamID, InputID, OutputID, ReaderID, TextInputID, TextOutputID, WebOutputID, WriterID, XMLReaderID, and XMLWriterID.

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

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

StreamID & StreamID::operator= (  const Stream *  stream  )  [inline]

Reassign this StreamID to refer to a Stream. Parameters: stream  - the Stream. Returns: a StreamID referring to the stream.

---

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

• StreamID.h
• Stream.cc
• Stream.h

---