The Simons     Component Library

           

---

CGIReaderID Class Reference

#include <CGIReaderID.h>

Inheritance diagram for CGIReaderID:

List of all members.

---

Detailed Description

CGIReaderID: a typed reference to an CGIReader.

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

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

---

Constructor & Destructor Documentation

CGIReaderID::CGIReaderID (   )  [inline]

Declare an CGIReaderID. Returns: a null CGIReaderID.

CGIReaderID::~CGIReaderID (   )  [inline]

Release an CGIReaderID.

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

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

CGIReaderID::CGIReaderID (  const CGIReader *  stream  )  [inline]

Initialise an CGIReaderID to refer to an CGIReader. Parameters: stream  - the CGIReader. Returns: an CGIReaderID referring to the stream.

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

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

---

Member Function Documentation

CGIReader * CGIReaderID::operator-> (   )  const

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

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

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

CGIReaderID & CGIReaderID::operator= (  const CGIReader *  stream  )  [inline]

Reassign this CGIReaderID to refer to an CGIReader. Parameters: stream  - the CGIReader. Returns: an CGIReaderID referring to the stream.

---

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

• CGIReaderID.h
• CGIReader.cc
• CGIReader.h

---