Detailed Description

Represents an active iterator for iterating through the collection of merged islands.

Public Member Functions
bool	begin () const

void	destroy ()

TSLIsland *	island ()

bool	more () const

void	next ()

void	previous ()

TSLIsland *	removeIsland ()

TSLIslandSet &	sourceIslands ()

TSLIslandStatusEnum	status ()

Member Function Documentation

◆ begin()

bool TSLIslandMergeIterator::begin ( ) const

Returns true if this iterator is at the beginning of the island set.

◆ destroy()

void TSLIslandMergeIterator::destroy ( )

Used to delete the object.

◆ island()

TSLIsland * TSLIslandMergeIterator::island ( )

Returns the next island.

Note that if the status of the island is TSLIslandStatusDeleted this method will return NULL. In this case the source islands returned from the source Islands() method will contain the island(s) that no longer exist after the merge.

◆ more()

bool TSLIslandMergeIterator::more ( ) const

Returns true if there is another island to retrieve, false otherwise.

◆ next()

void TSLIslandMergeIterator::next ( )

Advances the iterator.

◆ previous()

void TSLIslandMergeIterator::previous ( )

Moves the iterator to the previous island.

◆ removeIsland()

TSLIsland * TSLIslandMergeIterator::removeIsland ( )

Returns the next island whilst relinquishing ownership of it.

Returns 0 if the status is TSLIslandStatusDeleted or TSLIslandStatus Unchanged.

◆ sourceIslands()

TSLIslandSet & TSLIslandMergeIterator::sourceIslands ( )

Returns the next island's source islands.

If the status is TSLIslandStatusUnchanged, then the island's source set will be empty.

◆ status()

TSLIslandStatusEnum TSLIslandMergeIterator::status ( )

Returns the status next island.