The Simons     Component Library

           

---

BagID Class Reference

#include <BagID.h>

Inheritance diagram for BagID:

List of all members.

---

Detailed Description

BagID: a typed reference to a Bag.

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

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

---

Constructor & Destructor Documentation

BagID::BagID (   )  [inline]

Declare a BagID. Returns: a null BagID.

BagID::~BagID (   )  [inline]

Release a BagID.

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

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

BagID::BagID (  const Bag *  bag  )  [inline]

Initialise a BagID to refer to a Bag. Parameters: bag  - the Bag. Returns: a BagID referring to the bag.

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

Initialise a BagID to alias another BagID. Parameters: pointer  - the other BagID. Returns: a BagID referring to the bag.

---

Member Function Documentation

Bag * BagID::operator-> (   )  const

Invoke a method on this BagID. Returns: the result of the method. Reimplemented from UnorderedID. Reimplemented in RelationID.

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

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

BagID & BagID::operator= (  const Bag *  bag  )  [inline]

Reassign this BagID to refer to a Bag. Parameters: bag  - the Bag. Returns: a BagID referring to the bag.

---

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

• BagID.h
• Bag.cc
• Bag.h

---