The Simons     Component Library

           

---

XMLReaderID Class Reference

#include <XMLReaderID.h>

Inheritance diagram for XMLReaderID:

List of all members.

---

Detailed Description

XMLReaderID: a typed reference to an XMLReader.

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

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

---

Constructor & Destructor Documentation

XMLReaderID::XMLReaderID (   )  [inline]

Declare an XMLReaderID. Returns: a null XMLReaderID.

XMLReaderID::~XMLReaderID (   )  [inline]

Release an XMLReaderID.

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

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

XMLReaderID::XMLReaderID (  const XMLReader *  stream  )  [inline]

Initialise an XMLReaderID to refer to an XMLReader. Parameters: stream  - the XMLReader. Returns: an XMLReaderID referring to the stream.

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

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

---

Member Function Documentation

XMLReader * XMLReaderID::operator-> (   )  const

Invoke a method on this XMLReaderID. Returns: the result of the method. Reimplemented from ReaderID.

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

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

XMLReaderID & XMLReaderID::operator= (  const XMLReader *  stream  )  [inline]

Reassign this XMLReaderID to refer to an XMLReader. Parameters: stream  - the XMLReader. Returns: an XMLReaderID referring to the stream.

---

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

• XMLReaderID.h
• XMLReader.cc
• XMLReader.h

---