Skip To Content

Historical Traffic Data

Summary

Provides information about the historical traffic information stored in the network dataset such as the speed profile table and time slice durations.

Properties

PropertyExplanationData Type
timeInterval
(Read Only)

The time interval of the traffic data.

Double
timeIntervalUnits
(Read Only)

The units of the time interval of the traffic data. This property returns the following keywords:

  • Milliseconds
  • Seconds
  • Minutes
  • Hours
  • Days
  • Weeks
  • Months
  • Years
  • Decades
  • Centuries
  • Unknown

String
firstTimeSliceFieldName
(Read Only)

The field name of the first time slice of the given period in the profile table.

String
lastTimeSliceFieldName
(Read Only)

The field name of the last time slice of the given period in the profile table.

String
firstTimeSliceStartTime
(Read Only)

The start time of valid period of day for traffic data.

String
timeSliceDurationInMinutes
(Read Only)

The duration of time slice in minutes.

Integer
profilesTableName
(Read Only)

The name of the table containing profiles.

String
joinTableName
(Read Only)

The name of the join table between edges and profiles.

String
joinTableBaseTravelTimeFieldName
(Read Only)

The field name for base travel time in the join table.

String
joinTableBaseTravelTimeUnits
(Read Only)

The units for the base travel time in the join table. This property returns the following keywords:

  • Seconds
  • Minutes
  • Hours
  • Days

String
joinTableProfileIDFieldNames
(Read Only)

A Python list containing field names of the join table pointing to speed profiles.

List
joinTableBaseSpeedFieldName
(Read Only)

The field name for base speed in the join table.

String
joinTableBaseSpeedUnits
(Read Only)

The units for the base speed in the join table. This property returns the following keywords:

  • MilesPerHour
  • KilometersPerHour
  • Unknown

String
lengthAttributeName
(Read Only)

The name of the network cost attribute used to define the length along the elements of the network. This attribute is used to calculate the travel time for a given edge based on the speed if the historical traffic data is speed based. This property can be used to determine if a network dataset has been configured using a speed-based or time-based profile type. If the historical traffic data is time based, this property returns an empty string.

String

Code sample

Historical Traffic Data Properties Example

Display a summary of the historical traffic information for the network dataset.

# Name: NDSHistoricalTrafficDataProperties_ex01.py
# Description: Print historical traffic information for the network dataset.

import arcpy
import sys

# Set the workspace
arcpy.env.workspace = "C:/Data/SanFrancisco.gdb/Transportation"

# Create Describe object for the network dataset
desc = arcpy.Describe("Streets_ND")

#Get the historical traffic data object
if desc.supportsHistoricalTrafficData:
    traffic = desc.historicalTrafficData
else:
    #If the directions are not set for the network dataset, exit
    print("No historical traffic information")
    sys.exit()

print("Historical Traffic Information ----")
print("Time interval: " , traffic.timeInterval)
print("Time interval units: " , traffic.timeIntervalUnits)
print("First time slice field name: " , traffic.firstTimeSliceFieldName)
print("Last time slice field name: " , traffic.lastTimeSliceFieldName)
print("First time slice start time: " , traffic.firstTimeSliceStartTime)
print("Time slice duration in minutes: ",traffic.timeSliceDurationInMinutes)
print("Profiles table name: ", traffic.profilesTableName)
print("Join table name: ", traffic.joinTableName)
print("Join table base travel time field name: ", traffic.joinTableBaseTravelTimeFieldName)
print("Join table base travel time units: ", traffic.joinTableBaseTravelTimeUnits)
print("Join table ProfileID field names: ", traffic.joinTableProfileIDFieldNames)