Class SBCReferenceList::iterator#

ClassList > SBCReferenceList > iterator

Inherits the following classes: SBCReferenceListLinkPointer

Inherited by the following classes: SBCReferenceOwnerList::iterator

Public Functions#

Type	Name
SBCReferenceTarget *	getReferenceTarget () const Retrieves the reference target associated with this iterator.
SBCReferenceToTarget *	getReferenceToTarget () const Retrieves the reference-to-target object associated with this iterator.
	iterator () Default constructs an iterator that does not point to any link.
	iterator (SBCReferenceListLink * referenceListLink) Constructs an iterator that points to the specified list link.
	iterator (const iterator & i) Copy constructs an iterator from another iterator.
bool	operator!= (const iterator & i) noexcept const Checks if two iterators refer to different reference targets.
SBCReferenceTarget *	operator* () const Dereferences the iterator to obtain the referenced target.
iterator &	operator++ () Advances the iterator to the next element in the list.
iterator	operator++ (int) Advances the iterator to the next element, returning the original iterator.
iterator &	operator-- () Moves the iterator to the previous element in the list.
iterator	operator-- (int) Moves the iterator to the previous element, returning the original iterator.
iterator &	operator= (SBCReferenceListLink * referenceListLink) Assigns a new list link to the iterator.
iterator &	operator= (const iterator & i) Copies the iterator from another iterator.
bool	operator== (const iterator & i) noexcept const Checks if two iterators refer to the same reference target.
virtual	~iterator () Destroys the iterator.

Public Functions Documentation#

function getReferenceTarget#

Retrieves the reference target associated with this iterator.

SBCReferenceTarget * SBCReferenceList::iterator::getReferenceTarget () const

Returns:

Pointer to the reference target.

function getReferenceToTarget#

Retrieves the reference-to-target object associated with this iterator.

SBCReferenceToTarget * SBCReferenceList::iterator::getReferenceToTarget () const

Returns:

Pointer to the reference-to-target object.

function iterator [1/3]#

Default constructs an iterator that does not point to any link.

SBCReferenceList::iterator::iterator ()

function iterator [2/3]#

Constructs an iterator that points to the specified list link.

SBCReferenceList::iterator::iterator (
    SBCReferenceListLink * referenceListLink
)

Parameters:

l Pointer to the list link that the iterator will refer to.

function iterator [3/3]#

Copy constructs an iterator from another iterator.

SBCReferenceList::iterator::iterator (
    const iterator & i
)

Parameters:

i Reference to the iterator to copy.

function operator!=#

Checks if two iterators refer to different reference targets.

bool SBCReferenceList::iterator::operator!= (
    const iterator & i
) noexcept const

Parameters:

i Iterator to compare with.

Returns:

true if the iterators refer to different targets, false otherwise.

function operator*#

Dereferences the iterator to obtain the referenced target.

SBCReferenceTarget * SBCReferenceList::iterator::operator* () const

Returns:

Pointer to the reference target.

function operator++#

Advances the iterator to the next element in the list.

iterator & SBCReferenceList::iterator::operator++ ()

Returns:

Reference to the incremented iterator.

function operator++#

Advances the iterator to the next element, returning the original iterator.

iterator SBCReferenceList::iterator::operator++ (
    int
)

Returns:

Iterator value before the increment.

function operator--#

Moves the iterator to the previous element in the list.

iterator & SBCReferenceList::iterator::operator-- ()

Returns:

Reference to the decremented iterator.

function operator--#

Moves the iterator to the previous element, returning the original iterator.

iterator SBCReferenceList::iterator::operator-- (
    int
)

Returns:

Iterator value before the decrement.

function operator=#

Assigns a new list link to the iterator.

iterator & SBCReferenceList::iterator::operator= (
    SBCReferenceListLink * referenceListLink
)

Parameters:

l Pointer to the new list link.

Returns:

Reference to this iterator after assignment.

function operator=#

Copies the iterator from another iterator.

iterator & SBCReferenceList::iterator::operator= (
    const iterator & i
)

Parameters:

i Iterator to copy from.

Returns:

Reference to this iterator after assignment.

function operator==#

Checks if two iterators refer to the same reference target.

bool SBCReferenceList::iterator::operator== (
    const iterator & i
) noexcept const

Parameters:

i Iterator to compare with.

Returns:

true if both iterators refer to the same target, false otherwise.

function ~iterator#

Destroys the iterator.

virtual SBCReferenceList::iterator::~iterator ()