The Simons     Component Library

           

---

XMLWriterID Class Reference

#include <XMLWriterID.h>

Inheritance diagram for XMLWriterID:

List of all members.

---

Detailed Description

XMLWriterID: a typed reference to an XMLWriter.

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

Public Member Functions
	XMLWriterID ()
	Declare an XMLWriterID.
	~XMLWriterID ()
	Release an XMLWriterID.
	XMLWriterID (const Null *)
	Initialise an XMLWriterID to refer explicitly to null.
	XMLWriterID (const XMLWriter *)
	Initialise an XMLWriterID to refer to an XMLWriter.
	XMLWriterID (const XMLWriterID &)
	Initialise an XMLWriterID to alias another XMLWriterID.
XMLWriterID &	operator= (const XMLWriter *)
	Reassign this XMLWriterID to refer to an XMLWriter.
XMLWriterID &	operator= (const XMLWriterID &)
	Reassign this XMLWriterID to alias another XMLWriterID.
XMLWriter *	operator-> () const
	Invoke a method on this XMLWriterID. Returns: the result of the method.

---

Constructor & Destructor Documentation

XMLWriterID::XMLWriterID (   )  [inline]

Declare an XMLWriterID. Returns: a null XMLWriterID.

XMLWriterID::~XMLWriterID (   )  [inline]

Release an XMLWriterID.

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

Initialise an XMLWriterID to refer explicitly to null. Parameters: null  - the null reference. Returns: an XMLWriterID referring to null.

XMLWriterID::XMLWriterID (  const XMLWriter *  stream  )  [inline]

Initialise an XMLWriterID to refer to an XMLWriter. Parameters: stream  - the XMLWriter. Returns: an XMLWriterID referring to the stream.

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

Initialise an XMLWriterID to alias another XMLWriterID. Parameters: pointer  - the other XMLWriterID. Returns: an XMLWriterID referring to the stream.

---

Member Function Documentation

XMLWriter * XMLWriterID::operator-> (   )  const

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

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

Reassign this XMLWriterID to alias another XMLWriterID. Parameters: pointer  - the other XMLWriterID. Returns: an XMLWriterID referring to the same XMLWriter as the other XMLWriterID.

XMLWriterID & XMLWriterID::operator= (  const XMLWriter *  stream  )  [inline]

Reassign this XMLWriterID to refer to an XMLWriter. Parameters: stream  - the XMLWriter. Returns: an XMLWriterID referring to the stream.

---

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

• XMLWriterID.h
• XMLWriter.cc
• XMLWriter.h

---