arcgis-maps-kotlin/com.arcgismaps.tasks.networkanalysis/PolygonBarrier

PolygonBarrier

class PolygonBarrier

A polygon barrier object is used to restrict route solving. A class that represents a polygon feature to be avoided (or penalized) by a route. A polygon barrier may represent a regional area of interest within the network to be avoided (i.e., not entered) by a route (e.g., a flood zone) or to penalize/delay a route within any portions of the area traversed by the route (e.g., a busy downtown area or a bad neighborhood).

The polygon barrier class is derived from the graphic class.

Since

200.1.0

Constructors

constructor(polygon: Polygon)

Creates a polygon barrier instance.

Properties

var barrierId: Int

Polygon barrier ID. This is a caller supplied foreign key that can be used to associate output polygon barriers with input polygon barriers.

var geometry: Polygon?

Polygon barrier's geometry. The polygon geometry of a Polygon barrier.

var name: String

The name of a polygon barrier.

var type: BarrierType

Polygon barrier's type.

Functions

fun clone(): PolygonBarrier

Clones the PolygonBarrier.

getScaleFactorForCost

fun getScaleFactorForCost(attributeName: String): Double

Gets scale factor for cost.

setScaleFactorForCost

fun setScaleFactorForCost(attributeName: String, scaleFactor: Double)

Sets scale factor for cost.