GetTravelModes

Summary

Returns a dictionary of travel mode objects that are available with the network data source. The dictionary keys are the names of the travel modes, and the dictionary values are the travel mode objects.

Discussion

One or more travel modes can be defined on a local network dataset or on a network data source from an ArcGIS Enterprise or ArcGIS Online portal or stand-alone ArcGIS Server site. This function can be used to populate a value list with the available travel modes given a network data source. For example, a geoprocessing script tool may have a parameter of type String called Travel Modes that can be populated with a list of travel mode names when a network dataset has been selected on the tool dialog box.

Syntax

GetTravelModes (network_dataset_path)

Parameter	Explanation	Data Type
network_dataset_path	The network dataset or service from which to retrieve travel modes. The argument can be specified using one of the following options: The catalog path to the network dataset A network dataset layer object The string name of the network dataset layer The URL for ArcGIS Online or an ArcGIS Enterprise portal with routing services A dictionary specifying connection information for a routing service on a stand-alone ArcGIS Server site	String

Return Value

Data Type	Explanation
Dictionary	A dictionary whose keys are the travel mode names and whose values are the travel mode objects.

Code sample

GetTravelModes example 1

Get the travel modes in a network dataset and print the walking time travel mode.

import arcpy

nds = 'C:/Data/SanDiego.gdb/Transportation/Streets_ND'
travel_modes = arcpy.nax.GetTravelModes(nds)
print(travel_modes['Walking Time'])

GetTravelModes example 2

Create a list of travel mode names on ArcGIS Online. The names could be localized, depending on the user's account setting.

import arcpy

travel_modes = arcpy.nax.GetTravelModes("https://www.arcgis.com/")
travel_mode_names = [travel_modes[mode].name for mode in travel_modes]

GetTravelModes example 3

This sample shows how to get a travel mode from a network and print some of its properties.

import arcpy

network = r"C:/Data/SanFrancisco.gdb/Transportation/Streets_ND"
# Get all travel modes from the network dataset
travel_modes = arcpy.nax.GetTravelModes(network)

# Print the impedance attribute and restrictions used for each travel mode
for travel_mode_name in travel_modes:
    travel_mode = travel_modes[travel_mode_name]
    print(travel_mode_name)
    print("Impedance:", travel_mode.impedance)
    print("Restrictions:", ", ".join(travel_mode.restrictions))
    print("")

GetTravelModes example 4

This sample shows how to clone a travel mode from a network, update its properties, and use it in an analysis.

import arcpy

network = r"C:/Data/SanFrancisco.gdb/Transportation/Streets_ND"
# Get all travel modes from the network dataset
travel_modes = arcpy.nax.GetTravelModes(network)
# Construct a new TravelMode object from the existing Driving Time travel mode
new_travel_mode = arcpy.nax.TravelMode(travel_modes["Driving Time"])
# Update the useHierarchy property to turn hierarchy off, and update the name
new_travel_mode.name = "Driving Time without Hierarchy"
new_travel_mode.useHierarchy = "NO_HIERARCHY"
# Use the new travel mode object when constructing an OD cost matrix analysis
od_object = arcpy.nax.OriginDestinationCostMatrix(network)
od_object.travelMode = new_travel_mode

GetTravelModes example 5

The following code sample shows how to call GetTravelModes for a routing service on a stand-alone ArcGIS Server site.

Learn more about how to specify a routing service info dictionary

travel_modes = arcpy.nax.GetTravelModes(
    {
        "utilityUrl": f"https://mysite.mydomain.com/:6443/arcgis/rest/services/MyRouting/NetworkAnalysisUtilities/GPServer",
        "authenticationInfo": {
            "username": "my_username",
            "password": "my_password"
        }
    }
)