Class SBCReferenceToOwnerList

ClassList > SBCReferenceToOwnerList

Inherits the following classes: SBCReferenceToOwner

Protected Attributes

Type	Name
SBCReferenceListLinkPointer	referenceListLinkInOwner Pointer to the referenceListLink in the owner (for fast removal)
SBCReferenceOwnerList *	referenceOwnerList Pointer to the reference owner list.

Protected Functions

Type	Name
	SBCReferenceToOwnerList () Constructs an empty SBCReferenceToOwnerList.
	SBCReferenceToOwnerList (SBCReferenceOwnerList * referenceOwnerList) Constructs an SBCReferenceToOwnerList referencing the given owner list.
virtual SBCReferenceOwner *	getReferenceOwner () override const Returns the reference owner list.
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	~SBCReferenceToOwnerList () Destroys the SBCReferenceToOwnerList.

Protected Attributes Documentation

variable referenceListLinkInOwner

Pointer to the referenceListLink in the owner (for fast removal)

SBCReferenceListLinkPointer SBCReferenceToOwnerList::referenceListLinkInOwner;

---

variable referenceOwnerList

Pointer to the reference owner list.

SBCReferenceOwnerList* SBCReferenceToOwnerList::referenceOwnerList;

---

Protected Functions Documentation

function SBCReferenceToOwnerList [1/2]

Constructs an empty SBCReferenceToOwnerList.

SBCReferenceToOwnerList::SBCReferenceToOwnerList () 

Initializes the internal pointers to null.

---

function SBCReferenceToOwnerList [2/2]

Constructs an SBCReferenceToOwnerList referencing the given owner list.

SBCReferenceToOwnerList::SBCReferenceToOwnerList (
    SBCReferenceOwnerList * referenceOwnerList
) 

Initializes the reference to the provided owner list.

Parameters:

• m Pointer to the SBCReferenceOwnerList to reference.

---

function getReferenceOwner

Returns the reference owner list.

virtual SBCReferenceOwner * SBCReferenceToOwnerList::getReferenceOwner () override const

Returns the referenced owner.

Retrieves the owner list that this reference points to, or nullptr if no owner is referenced.

Returns:

Pointer to the referenced SBCReferenceOwner, or nullptr if none.

---

function print [1/2]

Prints debugging information.

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

Prints debugging information to the given output stream.

Outputs the state of the reference, including the owner list pointer and the back reference if present.

Parameters:

• os Output stream to which the debugging information is written.

---

function print [2/2]

Prints debugging information.

virtual void SBCReferenceToOwnerList::print () override const

Prints debugging information to the standard output stream.

Calls the overload that takes an std::ostream with std::cout.

---

function stopReferencing

Stops referencing the index.

virtual void SBCReferenceToOwnerList::stopReferencing () override

Stops referencing the owner list and removes the back reference.

If the reference owner list is set, deletes the associated back reference and clears the internal pointers.

---

function ~SBCReferenceToOwnerList

Destroys the SBCReferenceToOwnerList.

virtual SBCReferenceToOwnerList::~SBCReferenceToOwnerList () 

---