University of Sheffield   

    The Simons
    Component Library
Introduction   Class Hierarchy   Class Listing   Index of Classes   Index of Methods   Header Files  

SequenceID Class Reference

#include <SequenceID.h>

Inheritance diagram for SequenceID:

CollectionID ObjectID ListID StringID VectorID List of all members.

Detailed Description

SequenceID: a typed reference to a Sequence.

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


Public Member Functions

 SequenceID ()
 Declare a SequenceID.

 ~SequenceID ()
 Release a SequenceID.

 SequenceID (const Null *)
 Initialise a SequenceID to refer explicitly to null.

 SequenceID (const Sequence *)
 Initialise a SequenceID to refer to a Sequence.

 SequenceID (const SequenceID &)
 Initialise a SequenceID to alias another SequenceID.

SequenceID & operator= (const Sequence *)
 Reassign this SequenceID to refer to a Sequence.

SequenceID & operator= (const SequenceID &)
 Reassign this SequenceID to alias another SequenceID.

Sequence * operator-> () const
 Invoke a method on this SequenceID.

Constructor & Destructor Documentation

SequenceID::SequenceID (   )  [inline]
 

Declare a SequenceID.

Returns:
a null SequenceID.

SequenceID::~SequenceID (   )  [inline]
 

Release a SequenceID.

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

Initialise a SequenceID to refer explicitly to null.

Parameters:
null - the null reference.
Returns:
a SequenceID referring to the sequence.

SequenceID::SequenceID (  const Sequence *  sequence  )  [inline]
 

Initialise a SequenceID to refer to a Sequence.

Parameters:
sequence - the Sequence.
Returns:
a SequenceID referring to the sequence.

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

Initialise a SequenceID to alias another SequenceID.

Parameters:
pointer - the other SequenceID.
Returns:
a SequenceID referring to the sequence.

Member Function Documentation

Sequence * SequenceID::operator-> (   )  const
 

Invoke a method on this SequenceID.

Returns:
the result of the method.

Reimplemented from CollectionID.

Reimplemented in ListID, StringID, and VectorID.

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

Reassign this SequenceID to alias another SequenceID.

Parameters:
pointer - the other SequenceID.
Returns:
a SequenceID referring to the same Sequence as the other SequenceID.

SequenceID & SequenceID::operator= (  const Sequence *  sequence  )  [inline]
 

Reassign this SequenceID to refer to a Sequence.

Parameters:
sequence - the Sequence.
Returns:
a SequenceID referring to the sequence.

The documentation for this class was generated from the following files:
Generated on Fri May 5 17:17:19 2006 for The Simons Component Library by doxygen1.3