Краткая информация
Предоставляет доступ к свойствам из слоя задачи выбора маршрута транспорта Network Analyst. Функция GetSolverProperties используется для получения объекта VehicleRoutingProblemSolverProperties из слоя задачи выбора маршрута транспорта Network Analyst.
Обсуждение
Объект VehicleRoutingProblemSolverProperties предоставляет доступ для чтения и записи ко всем свойствам слоя задачи выбора маршрута транспорта Network Analyst. Этот объект можно использовать для изменения свойств анализа слоя задачи выбора маршрута транспорта, а соответствующий слой можно повторно рассчитать для получения необходимых результатов. Новый слой задачи выбора маршрута транспорта можно создать с помощью инструмента геообработки Создать слой анализа задачи маршрута транспортного средства. Получение объекта VehicleRoutingProblemSolverProperties из нового слоя задачи выбора маршрута транспорта позволяет повторно использовать существующий слой для последующего анализа, а не создавать новый слой для каждого анализа, что может замедлять работу.
После изменения свойств объекта VehicleRoutingProblemSolverProperties, соответствующий слой можно немедленно использовать с другими функциями и инструментами геообработки. Обновлять слой для внесения изменения не требуется.
Свойства
| Свойство | Описание | Тип данных |
| attributeParameters (чтение и запись) | Дает возможность получать или задавать параметризированные атрибуты для использования их в анализе. Это свойство возвращает словарь Python. Ключом в словаре является кортеж двух значений – имени атрибута и имени параметра. Значение каждого элемента в словаре является значением параметра. Параметризованные сетевые атрибуты используются для моделирования некоторого динамического аспекта значения атрибута. Например, туннель с ограничением высоты 12 футов может быть смоделирован с использованием параметра. В этом случае высоту транспорта в футах нужно указать как значение параметра. Если транспортное средство выше 12 футов (3,7 м), то это ограничение будет оценено как True, ограничивающее, таким образом, проезд по туннелю. Подобным образом у моста может быть параметр, указывающий ограничение по весу. Попытка изменить непосредственно свойство attributeParameters не приведет к обновлению значений. Вместо этого следует всегда использовать для установки значений этого свойства новый объект словаря. Различие между этими подходами проиллюстрировано следующими двумя блоками кода. Не стоит изменять свойство attributeParameters на месте; этот метод кодировки не будет работать. Измените свойство attributeParameters, используя новый объект словаря. | Dictionary |
| defaultDate (чтение и запись) | Дает возможность получать или задавать дату, принимаемую для тех полей временных значений, в которых указано только время. Если поле времени для какого-либо объекта заказов, например, поле TimeWindowStart1, имеет значение времени без даты, принимается дата по умолчанию из свойства defaultDate. Например, если для параметра TimeWindowStart1 задано 9:00 утра, а defaultDate установлено на datetime.date(2012, 3, 6), то все значения времени будут иметь вид 9:00 a.m., March 6, 2012. Дата по умолчанию не влияет на значения в поле времени, для которых указана дата. Также в качестве даты по умолчанию можно указать день недели, при помощи следующих условных дат:
Например, если в качестве неявной даты для полей времени должен выступать день недели – вторник, следует указать для этого свойства значение 1/2/1900. | DateTime |
| distanceAttribute (чтение и запись) | Дает возможность получать или задавать атрибут стоимости расстояния, используемый для определения длин элементов сети. | String |
| distanceFieldUnits (чтение и запись) | Дает возможность получать или задавать единицы расстояния, используемые в полях расстояния подслоев и таблиц слоя анализа (классов сетевого анализа). Эти единицы не обязательно должны совпадать с единицами сетевого атрибута стоимости, указанного в свойстве timeAttribute.
| String |
| excessTransitTimeImportance (чтение и запись) | Дает возможность получать или задавать степень важности уменьшения избыточного времени в пути. Избыточное время в пути – это затрачиваемое сверх необходимого время для перемещения от одного заказа к другому. Лишнее время может возникать по причине перерывов или возвращения в гараж между вызовами. Этот параметр имеет значение только при использовании Пары заказов.
| String |
| ignoreInvalidLocations (чтение и запись) | Указывает, будут ли игнорироваться неверные входные местоположения. Обычно местоположения недействительны, если они не могут быть обнаружены в сети. Когда недопустимые местоположения игнорируются, решатель пропустит их и попытается выполнить анализ, используя оставшиеся местоположения.
| String |
| outputPathShape (чтение и запись) | Дает возможность получать или задавать тип формы для объектов маршрута, получаемых в результате расчета.
| String |
| restrictions (чтение и запись) | Дает возможность получать или задавать список атрибутов ограничения, применяемых в ходе данного анализа. Пустой список, [], означает, что в ходе анализа не применяются никакие атрибуты ограничения. | String |
| solverName (только чтение) | Возвращает название механизма расчета, на который ссылается слой Network Analyst, использующийся для получения объекта свойств механизма расчета. Это свойство всегда возвращает строковое значение Vehicle Routing Problem Solver при обращении к нему из объекта VehicleRoutingProblemSolverProperties. | String |
| streetDirectionsProperties (чтение и запись) | Обеспечивает доступ на чтение и запись StreetDirectionsProperties, позволяя настраивать выходные данные слоя выбора маршрута транспорта. | Object |
| timeAttribute (чтение и запись) | Дает возможность получать или задавать атрибут стоимости на основе времени, используемый для определения времени пути по элементам сети. При решении задачи этот атрибут стоимости сводится к минимуму. | String |
| timeFieldUnits (чтение и запись) | Дает возможность получать или задавать единицы измерения времени, используемые во временных полях подслоев и таблиц слоя анализа (классов сетевого анализа). Эти единицы не обязательно должны совпадать с единицами сетевого атрибута стоимости, указанного в свойстве timeAttribute.
| String |
| timeWindowViolationImportance (чтение и запись) | Дает возможность получать или задавать степень значимости временных окон в анализе. Нарушение временного окна происходит в случае прибытия транспортного средства по вызову, в гараж или на остановку после своего временного окна. Нарушение – это интервал времени между моментом окончания временного окна и моментом прибытия. Список возможных значений следующий:
| String |
| timeZoneUsageForTimeFields (чтение и запись) |
Устанавливает часовой пояс полей даты-времени во входных данных, в том числе полей, которые используются для временных окон.
| String |
| spatialClustering (чтение и запись) | Указывает, будет ли использоваться пространственная кластеризация.
| Boolean |
| travelMode (только чтение) | Доступ к режиму движения устанавливается для слоя сетевого анализа как объект arcpy.na.TravelMode. | Object |
| useHierarchy (чтение и запись) | Отвечает за использование атрибута иерархии при проведении анализа. Список возможных значений следующий:
| String |
| uTurns (чтение и запись) | Предоставляет возможность получать или устанавливать политику, которая указывает, как решатель управляет разворотами на перекрестках, которые могут возникать в ходе прохода по сети между остановками. Список возможных значений следующий:
| String |
Обзор метода
| Метод | Описание |
| applyTravelMode (travel_mode) | Обновляет свойства анализа слоя network analyst на основе объекта режима передвижения. После этого обновленный слой network analyst может быть рассчитан для завершения анализа. |
Методы
applyTravelMode (travel_mode)
| Параметр | Описание | Тип данных |
travel_mode | Переменная, ссылающаяся на объект режима передвижения, который был получен на основе слоя сетевых данных. Список объектов режима передвижения можно получить, вызвав функцию arcpy.na.GetTravelModes. VRP выполняет расчет только с временным импедансом, поэтому будут разрешены только режимы перемещения на основе временного импеданса. | Object |
При создании слоя network analyst он получит значения по умолчанию для всех своих свойств анализа. Отдельные свойства анализа можно обновлять с помощью объекта свойств механизма расчета, полученного из слоя network analyst. Режим перемещения сохраняет предопределенный набор настроек анализа, который помогает выполнять определенные виды анализа – например, режим передвижения пешком сохраняет настройки анализа, необходимые для выполнения по-временного анализа передвижения пешим ходом.
Используя метод applyTravelMode, за один раз могут применяться сразу все настройки анализа, заданные для режима передвижения. После того, как свойства анализа будут обновлены, слой network analyst может быть рассчитан для завершения анализа.
Если при обновлении свойств механизма расчета, например – когда режим передвижения ссылается на свойства, которые не существуют в текущем наборе сетевых данных, или же ссылается на свойства, которые уже не применяются к набору сетевых данных, использовавшемуся для создания слоя network analyst, соответствующего объекту свойств механизма расчета, исключительных ситуаций не возникает. Этот метод будет с успехом работать, но вы получите ошибки при попытке расчёта такого слоя network analyst.
Если параметр travel_mode не привязан к объекту режима передвижения или строке, возникает исключительная ситуация TypeError. Если параметр travel_mode привязан к строке, но строка не может быть внутренне конвертирована в строковое представление объекта режима передвижения, возникает исключительная ситуация ValueError.
Пример кода
Скрипт показывает, как создать слой задачи выбора маршрута транспорта, добавить данные, и вычислить его, используя текущую дату как дату по умолчанию. Затем он обновляет дату по умолчанию на четверг и повторяет вычисления. Основан на учебном наборе данных по региону Сан-Франциско.
# Name: VehicleRoutingProblemSolverProperties_Workflow.py
# Description: Find the optimal VRP solution solving for today or a day of the
# week. Uses the SolverProperties to update the existing VRP layer
# before re-running the analysis.
# Requirements: Network Analyst Extension
# Import system modules
import arcpy
from arcpy import env
import os
import datetime
try:
# Check out the Network Analyst license if available.
# Fail if the Network Analyst
# license is not available.
if arcpy.CheckExtension("network") == "Available":
arcpy.CheckOutExtension("network")
else:
raise arcpy.ExecuteError("Network Analyst Extension license is not available.")
# Set environment settings
output_dir = "C:\Data"
# The NA layer's data will be saved to the workspace specified here
env.workspace = os.path.join(output_dir, "Output.gdb")
env.overwriteOutput = True
# Set local variables
input_gdb = "C:/Data/SanFrancisco.gdb"
network = os.path.join(input_gdb, "Transportation", "Streets_ND")
layer_name = "StoreDeliveryRoute"
travel_mode = "Driving Time"
time_units = "Minutes"
distance_units = "Miles"
in_orders = os.path.join(input_gdb, "Analysis/Stores")
in_depots = os.path.join(input_gdb, "Analysis/DistributionCenter")
in_routes = os.path.join(input_gdb, "Analysis/Routes")
routes_today = os.path.join(output_dir, "Output.gdb", "Routes_Today")
routes_tuesday = os.path.join(output_dir, "Output.gdb", "Routes_Tuesday")
# Create a new Vehicle Routing Problem (VRP) layer. Since the time-based
# attributes such as ServiceTime on orders and CostPerUnitTime on routes is
# recorded in minutes, we use minutes for time_units parameter. As we are
# using cost per unit distance in routes, we have to specify a distance
# attribute. The values for CosterPerUnitDistance are in miles, so we
# specify miles for distance units parameter
result_object = arcpy.na.MakeVehicleRoutingProblemAnalysisLayer(network,
layer_name, travel_mode,
time_units, distance_units,
line_shape="STRAIGHT_LINES")
# Get the layer object form the result object. The route layer can now be
# referenced using the layer object.
layer_object = result_object.getOutput(0)
# Get the names of all the sublayers within the VRP layer.
sub_layer_names = arcpy.na.GetNAClassNames(layer_object)
# Store the layer names that we will use later
orders_layer_name = sub_layer_names["Orders"]
depots_layer_name = sub_layer_names["Depots"]
routes_layer_name = sub_layer_names["Routes"]
# Load the store locations as orders. Using field mappings we map the
# TimeWindowStart1, TimeWindowEnd1, and DeliveryQuantities properties
# for Orders from the fields of store features and assign a value of
# 0 to MaxViolationTime1 property. The Name and ServiceTime properties
# have the correct mapped field names when using the candidate fields
# from store locations feature class.
candidate_fields = arcpy.ListFields(in_orders)
order_field_mappings = arcpy.na.NAClassFieldMappings(layer_object,
orders_layer_name,
False, candidate_fields)
order_field_mappings["TimeWindowStart1"].mappedFieldName = "TimeStart1"
order_field_mappings["TimeWindowEnd1"].mappedFieldName = "TimeEnd1"
order_field_mappings["DeliveryQuantities"].mappedFieldName = "Demand"
order_field_mappings["MaxViolationTime1"].defaultValue = 0
arcpy.na.AddLocations(layer_object, orders_layer_name, in_orders,
order_field_mappings, "")
# Load the depots from the distribution center features. Using field mappings
# we map the Name properties for Depots from the fields of distribution
# center features and assign a value of 8 AM for TimeWindowStart1 and a
# value of 5 PM for TimeWindowEnd1 properties
depot_field_mappings = arcpy.na.NAClassFieldMappings(layer_object,
depots_layer_name)
depot_field_mappings["Name"].mappedFieldName = "Name"
depot_field_mappings["TimeWindowStart1"].defaultValue = "8 AM"
depot_field_mappings["TimeWindowEnd1"].defaultValue = "5 PM"
arcpy.na.AddLocations(layer_object, depots_layer_name, in_depots,
depot_field_mappings, "")
# Load the routes from a table containing information about routes. In this
# case, since the fields on the routes table and property names for Routes
# are the same, we will just use the default field mappings
arcpy.na.AddLocations(layer_object, routes_layer_name, in_routes, "", "")
# Solve the VRP layer
arcpy.na.Solve(layer_object)
# Save the resulting Routes sublayer
arcpy.management.CopyFeatures(routes_layer_name, routes_today)
# Get the solver properties object from the vehicle routing problem layer
solverProps = arcpy.na.GetSolverProperties(layer_object)
# Update the default date to tuesday using the specified day in the above
# doc (Tuesday - 1/2/1900) for the vehicle routing problem layer using the
#solver properties object
solverProps.defaultDate = datetime.date(1900, 1, 2)
# Solve the VRP layer
arcpy.na.Solve(layer_object)
# Save the resulting Routes sublayer
arcpy.management.CopyFeatures(routes_layer_name, routes_tuesday)
except Exception as e:
# If an error occurred, print line number and error message
import traceback
import sys
tb = sys.exc_info()[2]
print ("An error occurred on line %i" % tb.tb_lineno)
print (str(e))Этот скрипт показывает, как находить маршруты для группы грузовых автомобилей, используя режим передвижения Время в пути грузового транспорта.
#Get the VRP layer object from a layer named "VRP" in the map
doc = arcpy.mp.ArcGISProject('current')
map_obj = doc.listMaps()[0]
vrp_layer = map_obj.listLayers('VRP')[0]
#Get the Trucking Time travel mode from the network dataset
desc = arcpy.Describe(vrp_layer)
travel_modes = arcpy.na.GetTravelModes(desc.network.catalogPath)
trucking_mode = travel_modes["Trucking Time"]
#Apply the travel mode to the analysis layer
solver_properties = arcpy.na.GetSolverProperties(vrp_layer)
solver_properties.applyTravelMode(trucking_mode)