MapLink Pro 11.1.1.0.
Envitia MapLink Pro: The Ultimate Mapping Application Toolkit
Loading...
Searching...
No Matches
TSLEntityImpactDescription Class Reference

Detailed Description

This class describes the impact of an island set on an entity within the entity set passed to the TSLImpactAssessorOperation.

Public Member Functions

const TSLEntityentity () const
 
TSLImpactEnum impact () const
 
const TSLEntitySetimpactGeometries () const
 
const TSLIslandislandThatImpacts (int nth) const
 
int numIslandsThatImpact () const
 

Member Function Documentation

◆ entity()

const TSLEntity * TSLEntityImpactDescription::entity ( ) const

Returns the entity that is describes by this object. Note that this will not be a TSLEntitySet, since only leaf entities are described.

◆ impact()

TSLImpactEnum TSLEntityImpactDescription::impact ( ) const

Returns how the entity is impacted by the island set.

◆ impactGeometries()

const TSLEntitySet * TSLEntityImpactDescription::impactGeometries ( ) const

Returns geometries which describe the locations of the impacts for this entity.

This will typically be either

a) a single TSLSymbol, representing the changing point object which impacts the entity set. b) a single TSLPolyline, representing either a changing line feature which impacts the entity set, or the portions of the changing outer or inner ring which impact the entity. c) a TSLEntitySet containing combinations of the above.

The returned object should not be deleted.

◆ islandThatImpacts()

const TSLIsland * TSLEntityImpactDescription::islandThatImpacts ( int nth) const
Parameters
nthreturn data for the nth island, from 0 to numIslandsThatImpact() - 1
Returns
the nth island which impacts this entity set.

◆ numIslandsThatImpact()

int TSLEntityImpactDescription::numIslandsThatImpact ( ) const

Returns the number of islands that impact this entity.