AGSPolylineBarrier Class Reference

Description

A polyline barrier to constrain routes.

Instances of this class represent a polyline barrier that can be used to constrain routes generated by AGSRouteTask or service areas generated by AGSServiceAreaTask.

Barriers serve to temporarily restrict, add impedance (cost) to, and scale impedance on parts of the transportation network.

Since

100

See also

http://desktop.arcgis.com/en/arcmap/latest/extensions/network-analyst/barriers.htm

Inheritance diagram for AGSPolylineBarrier:

Instance Methods
(instancetype)	- initWithPolyline:
(double)	- scaleFactorForCostAttribute:
(void)	- setScaleFactor:forCostAttribute:

Class Methods
(instancetype)	+ barrierWithPolyline:

Properties
NSInteger	barrierID
AGSPolyline *	geometry
NSString *	name
AGSBarrierType	type

Method Documentation

barrierWithPolyline:

+ (instancetype) barrierWithPolyline:

(AGSPolyline *)

polyline

Initialize the polyline barrier with provided geometry

Parameters

polyline

defining the shape and location of the barrier

Returns

Initialized polyline barrier

Since

100

initWithPolyline:

- (instancetype) initWithPolyline:

(AGSPolyline *)

polyline

Initialize the polyline barrier with provided geometry

Parameters

polyline

defining the shape and location of the barrier

Returns

Initialized polyline barrier

Since

100

scaleFactorForCostAttribute:

- (double) scaleFactorForCostAttribute:

(NSString *)

attributeName

The scale factor for a cost attribute of the barrier. The factor can be used to increase or decrease the cost of traveling across the barrier

Parameters

attributeName

name of the cost attribute

Returns

scale factor

Since

100.2

setScaleFactor:forCostAttribute:

- (void) setScaleFactor:		(double)	scaleFactor
forCostAttribute:		(NSString *)	attributeName

Sets the scale factor for a cost attribute of the barrier. The factor can be used to increase or decrease the cost of traveling across the barrier

Parameters

scaleFactor	by which to increase or decrease the cost
attributeName	name of the cost attribute

Since

100.2

Property Documentation

barrierID

- (NSInteger) barrierID

readwritenonatomicassign

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

See also

- setPolylineBarriersWithFeatureTable:queryParameters: (AGSRouteParameters), AGSRouteResult::polylineBarriers, - setPolylineBarriersWithFeatureTable:queryParameters: (AGSClosestFacilityParameters), AGSClosestFacilityResult::polylineBarriers, - setPolylineBarriersWithFeatureTable:queryParameters: (AGSServiceAreaParameters), AGSServiceAreaResult::polylineBarriers

Since

100.6

geometry

- (AGSPolyline*) geometry

readwritenonatomicstrong

The shape and location of the barrier

Since

100

name

- (NSString*) name

readwritenonatomiccopy

The name of the polyline barrier.

Since

100.3

type

- (AGSBarrierType) type

readwritenonatomicassign

The type of the barrier, whether it fully restricts travel accross it, or merely increases the cost of travel

Since

100