AGSTravelMode Class Reference

Description

Travel options for routes generated by AGSRouteTask.

Instances of this class represent options that can be used to customize the routes generated by AGSRouteTask, AGSClosestFacilityTask, or AGSServiceAreaTask.

A default list of travel modes is available on AGSRouteTaskInfo::travelModes, AGSClosestFacilityTaskInfo::travelModes or AGSServiceAreaTaskInfo::travelModes based on the options supported by the underlying network analyst service or transportation network dataset.

Since

100

Inheritance diagram for AGSTravelMode:

Instance Methods
(instancetype)	- init

Class Methods
(instancetype)	+ travelMode

Properties
NSArray< AGSAttributeParameterValue * > *	attributeParameterValues
NSString *	distanceAttributeName
NSString *	impedanceAttributeName
NSString *	name
double	outputGeometryPrecision
NSArray< NSString * > *	restrictionAttributeNames
NSString *	timeAttributeName
NSString *	travelModeDescription
NSString *	type
BOOL	useHierarchy
AGSUTurnPolicy	uTurnPolicy

Method Documentation

init

- (instancetype) init

travelMode

+ (instancetype) travelMode

Property Documentation

attributeParameterValues

- (NSArray<AGSAttributeParameterValue*>*) attributeParameterValues

readwritenonatomiccopy

Overrides to the attribute values of a cost attribute specified in impedanceAttributeName, or to the attribute values of a restriction attribute specified in restrictionAttributeNames.

Since

100

distanceAttributeName

- (NSString*) distanceAttributeName

readwritenonatomiccopy

The name of the attribute that can be set as impedanceAttributeName to optimize routes based on distance travelled.

Since

100

impedanceAttributeName

- (NSString*) impedanceAttributeName

readwritenonatomiccopy

The name of the attribute to use as the impedance. Routes will be optimized in order to minimize this impedance along the route. To minimize time taken by the route, use timeAttributeName. To minimize distance travelled by the route, use distanceAttributeName.

You can also use other attributes that are available in AGSRouteTaskInfo::costAttributes as the impedance.

Since

100

name

- (NSString*) name

readwritenonatomiccopy

Name of the travel mode

Since

100

outputGeometryPrecision

- (double) outputGeometryPrecision

readwritenonatomicassign

The desired precision (in Meters) of the output route geometry after generalization.

Since

100

restrictionAttributeNames

- (NSArray<NSString*>*) restrictionAttributeNames

readwritenonatomiccopy

The list of network attribute names to be used as restrictions while computing the route. Possible values are specified in AGSRouteTaskInfo::restrictionAttributes

Since

100

timeAttributeName

- (NSString*) timeAttributeName

readwritenonatomiccopy

The name of the attribute that can be set as impedanceAttributeName to optimize routes based on time taken.

Since

100

travelModeDescription

- (NSString*) travelModeDescription

readwritenonatomiccopy

Description of this travel mode

Since

100

type

- (NSString*) type

readwritenonatomiccopy

The type of travel mode this instance represents

Since

100

useHierarchy

- (BOOL) useHierarchy

readwritenonatomicassign

Specifies whether hierarchy of elements in the transportation network should be considered.

Since

100

See also

https://desktop.arcgis.com/en/arcmap/latest/extensions/network-analyst/network-analysis-with-hierarchy.htm

uTurnPolicy

- (AGSUTurnPolicy) uTurnPolicy

readwritenonatomicassign

Specifies how U-Turns should be handled. U-turns can be allowed everywhere, nowhere, only at dead ends, or only at intersections and dead ends. Allowing U-turns implies the vehicle can turn around at a junction and double back on the same street.

Since

100