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

TravelMode

An object that represents a travel mode. Travel modes on a network dataset define how a pedestrian, car, truck, or other medium of transportation moves through the network. A travel mode consists of a collection of network dataset settings that define actions that are allowed on the network and how the actions can be performed. Selecting a predefined travel mode allows you to efficiently and consistently set a number of properties that are appropriate for the mode of travel you intend to model. Since a travel mode is a collection of properties that work together it is recommended to have a full understanding of how these properties interact before altering them on the fly for a particular analysis. A best practice would be to create a new travel mode in the network dataset in ArcGIS Desktop or ArcGIS Pro that is fully tested to ensure that is returns the required solution.

Since

200.1.0

Constructors

TravelMode

constructor()

Creates a travel mode. Creates a travel mode object.

Properties

attributeParameterValues

val attributeParameterValues: MutableList<AttributeParameterValue>

Attribute parameter values. The attribute parameter values e.g. Vehicle Weight, Vehicle Height, etc. Attribute parameter values are useful for customizing individual restrictions ("Don't travel on a roads weight limits below 6 tons").

description

var description: String

Travel mode's description. A short text description of the travel mode.

distanceAttributeName

var distanceAttributeName: String

Distance attribute name. Specifies the distance-based cost attribute for reporting directions, total length.

impedanceAttributeName

var impedanceAttributeName: String

Impedance attribute name. The impedance attribute (i.e. the cost attribute to be minimized on solve). For example: "TravelTime" or "Distance".

name

var name: String

Travel mode's name. The unique name of the travel mode.

outputGeometryPrecision

var outputGeometryPrecision: Double

Output geometry precision in meters. Precision is useful for reducing the response size while sacrificing route shape or directions geometry quality. This parameter makes sense only for online services and doesn't affect local tasks.

restrictionAttributeNames

val restrictionAttributeNames: MutableList<String>

Restriction attribute names. Indicates the restriction attributes that are respected during solve.

timeAttributeName

var timeAttributeName: String

Time attribute name. Specifies the time-based cost attribute for reporting directions, total time, travel time and wait or late times.

type

var type: String

Travel mode's type. Indicates the category of travel or vehicle represented by the travel mode.

useHierarchy

var useHierarchy: Boolean

Use hierarchy. Indicates whether the travel mode uses the network hierarchy in an analysis. Sets whether or not to solve using a hierarchy. A hierarchical solve tends to prefer higher-order streets such a freeways.

uTurnPolicy

var uTurnPolicy: UTurnPolicy

Uturn policy. Indicates where the travel mode is allowed to make U-turns. Returns the enumeration value for the u-turn policy e.g. no u-turns, u-turns at stops, etc.