The Simons     Component Library

           

---

WriterID Class Reference

#include <WriterID.h>

Inheritance diagram for WriterID:

List of all members.

---

Detailed Description

WriterID: a typed reference to a Writer.

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

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

---

Constructor & Destructor Documentation

WriterID::WriterID (   )  [inline]

Declare a WriterID. Returns: a null WriterID.

WriterID::~WriterID (   )  [inline]

Release a WriterID.

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

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

WriterID::WriterID (  const Writer *  stream  )  [inline]

Initialise a WriterID to refer to a Writer. Parameters: stream  - the Writer. Returns: a WriterID referring to the stream.

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

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

---

Member Function Documentation

Writer * WriterID::operator-> (   )  const

Invoke a method on this WriterID. Returns: the result of the method. Reimplemented from FormatStreamID. Reimplemented in XMLWriterID.

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

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

WriterID & WriterID::operator= (  const Writer *  stream  )  [inline]

Reassign this WriterID to refer to a Writer. Parameters: stream  - the Writer. Returns: a WriterID referring to the stream.

---

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

• WriterID.h
• Writer.cc
• Writer.h

---