The Simons     Component Library

           

---

FileStreamID Class Reference

#include <FileStreamID.h>

Inheritance diagram for FileStreamID:

List of all members.

---

Detailed Description

FileStreamID: a typed reference to a FileStream.

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

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

---

Constructor & Destructor Documentation

FileStreamID::FileStreamID (   )  [inline]

Declare a FileStreamID. Returns: a null FileStreamID.

FileStreamID::~FileStreamID (   )  [inline]

Release a FileStreamID.

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

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

FileStreamID::FileStreamID (  const FileStream *  stream  )  [inline]

Initialise a FileStreamID to refer to a FileStream. Parameters: stream  - the FileStream. Returns: a FileStreamID referring to the stream.

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

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

---

Member Function Documentation

FileStream * FileStreamID::operator-> (   )  const

Invoke a method on this FileStreamID. Returns: the result of the method. Reimplemented from StreamID. Reimplemented in InputID, OutputID, TextInputID, TextOutputID, and WebOutputID.

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

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

FileStreamID & FileStreamID::operator= (  const FileStream *  stream  )  [inline]

Reassign this FileStreamID to refer to a FileStream. Parameters: stream  - the FileStream. Returns: a FileStreamID referring to the stream.

---

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

• FileStreamID.h
• FileStream.cc
• FileStream.h

---