The Simons     Component Library

           

---

ReaderID Class Reference

#include <ReaderID.h>

Inheritance diagram for ReaderID:

List of all members.

---

Detailed Description

ReaderID: a typed reference to a Reader.

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

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

---

Constructor & Destructor Documentation

ReaderID::ReaderID (   )  [inline]

Declare a ReaderID. Returns: a null ReaderID.

ReaderID::~ReaderID (   )  [inline]

Release a ReaderID.

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

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

ReaderID::ReaderID (  const Reader *  stream  )  [inline]

Initialise a ReaderID to refer to a Reader. Parameters: stream  - the Reader. Returns: a ReaderID referring to the stream.

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

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

---

Member Function Documentation

Reader * ReaderID::operator-> (   )  const

Invoke a method on this ReaderID. Returns: the result of the method. Reimplemented from FormatStreamID. Reimplemented in CGIReaderID, and XMLReaderID.

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

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

ReaderID & ReaderID::operator= (  const Reader *  stream  )  [inline]

Reassign this ReaderID to refer to a Reader. Parameters: stream  - the Reader. Returns: a ReaderID referring to the stream.

---

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

• ReaderID.h
• Reader.cc
• Reader.h

---