Detailed Description

This class describes the impact on an entity set by an island set.

It describes the overall impact on the entity set, and also a description of how each individual entity within the entity set is impacted by the island set.

Public Member Functions
TSLImpactEnum	overallImpact () const

int	numIslandsThatImpact () const

const TSLIsland *	islandThatImpacts (int nth) const

int	numEntitiesImpacted () const

const TSLEntityImpactDescription *	entityImpacted (int nth) const

Member Function Documentation

◆ entityImpacted()

const TSLEntityImpactDescription * TSLImpactDescription::entityImpacted ( int nth ) const

Parameters

nth	return the description for the nth leaf (i.e. non-TSLEntitySet) entity in the entity set, from 0 to numEntitiesImpacted() - 1.

Returns: the nth entity that was impacted, 0 on error. This object should not be deleted..

◆ islandThatImpacts()

const TSLIsland * TSLImpactDescription::islandThatImpacts ( int nth ) const

Parameters

nth	the nth island for which to return a result, from 0 to numIslandsThat Impact() - 1.

Returns: the nth island that impacts this entity set, 0 on error. This island should not be deleted.

◆ numEntitiesImpacted()

int TSLImpactDescription::numEntitiesImpacted ( ) const

Returns the number of entities impacted.

◆ numIslandsThatImpact()

int TSLImpactDescription::numIslandsThatImpact ( ) const

Returns the number of islands that impact this entity set.

◆ overallImpact()

TSLImpactEnum TSLImpactDescription::overallImpact ( ) const

Returns how the entity set is impacted by the island.