Class SBCReferenceToOwnerSingleton

ClassList > SBCReferenceToOwnerSingleton

Inherits the following classes: SBCReferenceToOwner

Protected Attributes

Type	Name
SBCReferenceOwnerSingleton *	referenceOwnerSingleton Pointer to the reference owner singleton.

Protected Functions

Type	Name
	SBCReferenceToOwnerSingleton () Constructs a SBCReferenceToOwnerSingleton with no associated owner.
	SBCReferenceToOwnerSingleton (SBCReferenceOwnerSingleton * referenceOwnerSingleton) Constructs a SBCReferenceToOwnerSingleton referencing the specified owner singleton.
virtual SBCReferenceOwner *	getReferenceOwner () override const Returns the reference owner singleton.
virtual void	print (std::ostream & os) override const Prints debugging information.
virtual void	print () override const Prints debugging information.
virtual void	stopReferencing () override Stops referencing the index.
virtual	~SBCReferenceToOwnerSingleton () Destroys the SBCReferenceToOwnerSingleton.

Protected Attributes Documentation

variable referenceOwnerSingleton

Pointer to the reference owner singleton.

SBCReferenceOwnerSingleton* SBCReferenceToOwnerSingleton::referenceOwnerSingleton;

---

Protected Functions Documentation

function SBCReferenceToOwnerSingleton [1/2]

Constructs a SBCReferenceToOwnerSingleton with no associated owner.

SBCReferenceToOwnerSingleton::SBCReferenceToOwnerSingleton () 

---

function SBCReferenceToOwnerSingleton [2/2]

Constructs a SBCReferenceToOwnerSingleton referencing the specified owner singleton.

SBCReferenceToOwnerSingleton::SBCReferenceToOwnerSingleton (
    SBCReferenceOwnerSingleton * referenceOwnerSingleton
) 

Parameters:

• r Pointer to the SBCReferenceOwnerSingleton to be referenced.

---

function getReferenceOwner

Returns the reference owner singleton.

virtual SBCReferenceOwner * SBCReferenceToOwnerSingleton::getReferenceOwner () override const

Retrieves the referenced owner singleton.

Returns:

Pointer to the SBCReferenceOwner (owner singleton) or nullptr if none.

---

function print [1/2]

Prints debugging information.

virtual void SBCReferenceToOwnerSingleton::print (
    std::ostream & os
) override const

Prints debugging information about this reference to the given output stream.

The output includes the address of the referenced owner singleton, or indicates that no owner is referenced.

Parameters:

• os Output stream to which the debugging information will be written.

---

function print [2/2]

Prints debugging information.

virtual void SBCReferenceToOwnerSingleton::print () override const

Prints debugging information about this reference to the standard output stream.

---

function stopReferencing

Stops referencing the index.

virtual void SBCReferenceToOwnerSingleton::stopReferencing () override

Stops referencing the associated owner singleton, if any.

This method detaches the reference from the owner singleton and clears the stored pointer.

---

function ~SBCReferenceToOwnerSingleton

Destroys the SBCReferenceToOwnerSingleton.

virtual SBCReferenceToOwnerSingleton::~SBCReferenceToOwnerSingleton () 

---