The Simons     Component Library

           

---

InputID Class Reference

#include <InputID.h>

Inheritance diagram for InputID:

List of all members.

---

Detailed Description

InputID: a typed reference to an Input.

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

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

---

Constructor & Destructor Documentation

InputID::InputID (   )  [inline]

Declare an InputID. Returns: a null InputID.

InputID::~InputID (   )  [inline]

Release an InputID.

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

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

InputID::InputID (  const Input *  stream  )  [inline]

Initialise an InputID to refer to an Input. Parameters: stream  - the Input. Returns: an InputID referring to the stream.

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

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

---

Member Function Documentation

Input * InputID::operator-> (   )  const

Invoke a method on this InputID. Returns: the result of the method. Reimplemented from FileStreamID. Reimplemented in TextInputID.

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

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

InputID & InputID::operator= (  const Input *  stream  )  [inline]

Reassign this InputID to refer to an Input. Parameters: stream  - the Input. Returns: an InputID referring to the stream.

---

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

• InputID.h
• Input.cc
• Input.h

---