Сводка
Класс ArcPy, предназначенный для выполнения анализа маршрутов.
Описание
Анализ маршрутов позволяет вычислить кратчайший путь вдоль сети между набором остановок. Более подробно об анализе маршрутов.
Синтаксис
Route (in_network)
| Parameter | Объяснение | Тип данных |
in_network | Набор сетевых данных или сервис, который будет использоваться для сетевого анализа. Аргумент можно задать с помощью пути к каталогу с набором сетевых данных, объекту слоя набора сетевых данных, строки с именем слоя набора сетевых данных или URL-адреса портала для сервиса сетевого анализа. Сеть должна содержать хотя бы один режим перемещения. Для использования URL-адреса портала необходимо выполнить вход на портал под учетной записью с правами на маршрутизацию. Анализ расходует кредиты, если объект использует ArcGIS Online в качестве in_network. Дополнительные сведения см. в разделе Обзор сервисных кредитов. | String |
Свойства
| Владение | Объяснение | Тип данных |
| accumulateAttributeNames (чтение и запись) | Список атрибутов стоимости, который будет суммироваться во время анализа. Эти накопившиеся атрибуты могут использоваться только для сведения; алгоритм решения при выполнении анализа использует только атрибут стоимости в соответствии с используемым режимом передвижения. По умолчанию пустой список. | String |
| allowSaveLayerFile (чтение и запись) | Указывает, разрешается ли сохранение результата анализа в виде файла слоя, используя метод saveAsLayerFile получившегося объекта. True означает, что вы можете сохранить файл слоя. False означает, что сохранить нельзя. Значение по умолчанию True, если в анализе используется набор сетевых данных, и False при использовании сервиса портала. Разрешение сохранения файла слоя может замедлить анализ, если в анализе используется сервис портала. | Boolean |
| allowSaveRouteData (чтение и запись) | Указывает, разрешается ли сохранение результата анализа в файл ZIP, используя метод saveRouteData получившегося объекта. True означает, что вы можете сохранить данные маршрута. False означает, что сохранить нельзя. Значение по умолчанию True, если в анализе используется набор сетевых данных, и False при использовании сервиса портала. Разрешение сохранения данных маршрута может замедлить анализ, если в анализе используется сервис портала. | Boolean |
| directionsDistanceUnits (чтение и запись) | Единицы, используемые для расстояния перемещения в выходных пошаговых направлениях. Свойство возвращается и задается в качестве участвующего в перечислении DistanceUnits и применяется, только если свойство returnDirections – True. По умолчанию используются единицы измерения атрибута расстояния в режиме перемещения, используемом для анализа. | Object |
| directionsLanguage (чтение и запись) | Язык, на котором будет отображаться выходной текст с указаниями пошаговых направлений. Свойство возвращается и устанавливается в виде строки с использованием одного из двух- или пятизначных кодов языков, представляющих поддерживаемые языки направлений. Список доступных языков направлений можно получить с помощью функции arcpy.nax.ListDirectionsLanguages. Значение по умолчанию соответствует en (English) или языку активного в данный момент языкового пакета. Свойство применимо, только если свойство returnDirections имеет значение True. | String |
| directionsStyle (чтение и запись) | Стиль, который будет использоваться для вывода пошаговых инструкций. Свойство возвращается и задается в качестве участвующего в перечислении DirectionsStyle и применяется, только если свойство returnDirections – True. Значение по умолчанию равно Desktop. | Object |
| distanceUnits (чтение и запись) | Единицы, используемые для расстояния перемещения в выходных данных анализа. Независимо от единиц измерения в стоимостных атрибутах набора сетевых данных выходные данные будут трансформированы в единицы, заданные в этом свойстве. Возвращается свойство и задается в качестве значения в перечислении DistanceUnits. По умолчанию – DistanceUnits.Kilometers. | Object |
| findBestSequence (чтение и запись) | Значение False означает, что остановки будут посещаться в порядке, заданном на входе. Значение True означает, что входные остановки должны быть переупорядочены для минимизации общей стоимости передвижения. Этот параметр заменяет задачу поиска кратчайшего пути на задачей движущегося торгового представителя. По умолчанию – False. | Boolean |
| ignoreInvalidLocations (чтение и запись) | Указывает, будут ли игнорироваться неверные входные местоположения. Значение True указывает, что неверные входные местоположения будут игнорироваться, поэтому анализ будет успешным только при использовании допустимых местоположений. Значение False указывает, что недопустимые местоположения не будут проигнорированы и приведут к сбою анализа. | Boolean |
| networkDataSource (только чтение) | Полный путь каталога к набору сетевых данных, используемому для анализа. | String |
| overrides (чтение и запись) | Задайте дополнительные опции, которые смогут повлиять на выполнение расчета при поиске решений задач сетевого анализа. Значение этого параметра должно быть задано в JavaScript Object Notation (JSON). К примеру, корректным значением является следующее: {"overrideSetting1" : "value1", "overrideSetting2" : "value2"}. Замещающее имя всегда заключено в двойные кавычки. Эти значения могут быть числовыми, булевыми или текстовыми. Значение по умолчанию является пустым, что означает отсутствие замещения каких-либо настроек механизма расчета. Замещения – дополнительные настройки, которые должны применяться только по итогам выполнения тщательного анализа результатов, которые будут получены до и после применения таких настроек. Список поддерживаемых настроек замещений для каждого расчета и их доступных значений можно получить, обратившись в службу технической поддержки Esri. | String |
| preserveFirstStop (чтение и запись) | Если порядок остановок был изменен из-за того, что для свойства findBestSequence задано значение True, значение True этого свойства сохраняет порядок первой остановки. Порядок остальных остановок будет изменен для получения оптимального маршрута. Это может быть полезным, если маршрут начинается из депо или станции. По умолчанию – False. | Boolean |
| preserveLastStop (чтение и запись) | Если порядок остановок был изменен из-за того, что для свойства findBestSequence задано значение True, значение True этого свойства сохраняет порядок первой остановки. Порядок остальных остановок будет изменен для получения оптимального маршрута. Это может быть полезным, если маршрут должен заканчиваться в депо или на станции. По умолчанию – False. | Boolean |
| returnDirections (чтение и запись) | Задает, будет ли создаваться пошаговый путевой лист. Значение True означает, что пошаговый путевой лист будет генерироваться при расчете анализа. Значение False означает, что путевой лист генерироваться не будет. Построение путевого листа может замедлить выполнение анализа. Значение по умолчанию равно False. | Boolean |
| returnRouteEdges (чтение и запись) | Определяет, будут ли возвращены ребра маршрутов. Ребра маршрутов – это отдельные сегменты маршрута, указывающие пройденные ребра сети. Значение True означает, что ребра маршрутов будут сохранены и возвращены при решении анализа. Значение False значит, что ребра маршрутов не будут сохраняться. Значением по умолчанию будет True, когда объект Route использует набор сетевых данных, и False, если он использует сервис портала. Возврат ребер маршрута может замедлить анализ, если этот анализ использует сервис портала. | Boolean |
| returnRouteJunctions (чтение и запись) | Указывает, будут ли возвращены соединения сети, пройденные по маршруту. True означает, что узлы маршрутов будут сохранены и возвращены при решении анализа. False означает, что узлы сохраняться не будут. Значением по умолчанию будет True, когда объект Route использует набор сетевых данных, и False, если он использует сервис портала. Сервисы портала не могут возвращать соединения. | Boolean |
| returnRouteTurns (чтение и запись) | Указывает, будут ли возвращены повороты сети, пройденные на маршруте. True означает, что повороты будут сохранены и возвращены при решении анализа. Значение False означает, что повороты сохраняться не будут. Значением по умолчанию будет True, когда объект Route использует набор сетевых данных, и False, если он использует сервис портала. Сервисы портала не могут возвращать повороты. | Boolean |
| returnToStart (чтение и запись) | True означает, что маршрут должен возвратиться в стартовое местоположение в конце маршрута. Значение False означает, что маршрут будет окончен на последней остановке. По умолчанию – False. | Boolean |
| routeShapeType (чтение и запись) | Тип формы, создаваемой для отображения выходных маршрутов. Маршруты всегда вычисляются вдоль сети, но вы можете отобразить их геометриями, не отражающими кривые сети. Возвращается свойство и задается в качестве значения в перечислении RouteShapeType. По умолчанию – RouteShapeType.TrueShapeWithMeasures. | Object |
| searchQuery (чтение и запись) | При размещении входных данных в сети, задает запрос на ограничение поиска поднабора объектов в классе исходных объектов. Эта опция полезна, если вы не хотите находить объекты, которые могут не подходить для сетевого положения. Например, если вы загружаете центроиды полигонов, и не хотите размещать их на дорогах местного значения, вы можете задать запрос, по которому будет выполняться поиск только для основных магистралей. Дополнительные сведения о способе размещения входных данных в сети Значение параметра указывается в виде списка с вложенными списками. Вложенный список состоит из двух значений, указывающих имя и выражение SQL для всех источников сети. Синтаксис выражения SQL несколько различается в зависимости от типа класса объектов источника сети. Например, если вы выполняете запрос к исходному классу объектов, хранящемуся в файловой или многопользовательской базе геоданных, шейп-файлам, SDC, то имена полей необходимо заключить в двойные кавычки: "CFCC". Если вы выполняете запрос к исходному классу объектов, хранящемуся в персональной базе геоданных, заключите поля в квадратные скобки: [CFCC]. Если запрос для конкретного источника указывать не нужно, используйте "#" в качестве значения для выражения SQL, или исключите имя источника и выражение SQL из значения параметра. Если запрос для всех источников сети указывать не нужно, используйте "#" в качестве значения параметра. Например, значение параметра [["Streets","\"CFCC\" = 'A15'"], ["Streets_ND_Junctions",""]] определяет выражение SQL для исходного класса объектов Streets и отсутствие выражения для исходного класса объектов Streets_ND_Junctions. Обратите внимание, что двойные кавычки, окружающие имя поля CFCC, можно проигнорировать, добавив символы обратной косой черты, что позволит избежать ошибки анализа в интерпретаторе Python. По умолчанию запрос не используется. | List |
| searchTolerance (чтение и запись) | Максимальный допуск поиска для расположения входных объектов в сети. Свойство возвращается и устанавливается как двойное, и единицы этого значения доступны через свойство searchToleranceUnits. Значение по умолчанию равно 5000. Дополнительные сведения о способе размещения входных данных в сети | Double |
| searchToleranceUnits (чтение и запись) | Единицы измерения для свойства searchTolerance. Возвращается свойство и задается в качестве значения в перечислении DistanceUnits. По умолчанию – DistanceUnits.Meters. | Object |
| timeOfDay (чтение и запись) | Время суток для использования в анализе. Значение по умолчанию равно None, означающее, что анализ не будет зависеть от времени. | DateTime |
| timeUnits (чтение и запись) | Единицы, используемые для времени перемещения в выходных данных анализа. Независимо от единиц измерения в стоимостных атрибутах набора сетевых данных выходные данные будут трансформированы в единицы, заданные в этом свойстве. Возвращается свойство и задается в качестве значения в перечислении TimeUnits. По умолчанию – TimeUnits.Minutes. | Object |
| timeZone (чтение и запись) | Определяет, будет ли указанное в свойстве timeOfDay время интерпретироваться в местном времени входных местоположений или во всемирном координированном времени (UTC). Свойство возвращается и задается в качестве участвующего в перечислении TimeZoneUsage и применяется, только если свойство timeOfDay – None. По умолчанию – TimeZoneUsage.LocalTimeAtLocations. | Object |
| timeZoneForTimeWindows (чтение и запись) | Определяет, выражаются ли значения во временных окнах входных остановок в локальном местном времени входных местоположений или во всемирном координированном времени (UTC). Возвращается свойство и задается в качестве участвующего в перечислении TimeZoneUsage. По умолчанию – TimeZoneUsage.LocalTimeAtLocations. | Object |
| travelMode (чтение и запись) | Режим передвижения, используемый для анализа. Значение возвращается и устанавливается как объект arcpy.nax.TravelMode, но оно также может быть установлено с использованием текстового имени режима передвижения или строки, содержащей действительное представление JSON режима передвижения. По умолчанию используется режим передвижения, определенный в наборе сетевых данных, используемом для анализа. | Object |
Обзор метода
| Метод | Объяснение |
| addFields (input_type, field_description) | Добавляет пользовательские поля к заданному входному классу. |
| count (input_type) | Возвращает количество строк, добавленных к входному типу. |
| fieldMappings (input_type, {use_location_fields}, {list_candidate_fields}) | Создает словарь, который сопоставляет входной тип с объектами arcpy.nax.NAClassFieldMap, позволяющими вам сопоставлять поля ваших входных данных свойствам механизма расчета. Словарь может использоваться в качестве входных данных аргумента load метода field_mappings. |
| fieldNames (input_type, {use_location_fields}) | Получает список имен полей, поддерживаемых заданным входным типом. |
| insertCursor (input_type, field_names) | Задает курсор записи для заданного типа выходных данных. Этот курсор предназначен для добавления строк непосредственно во входных данных. |
| load (input_type, features, {field_mappings}, {append}, {max_features}) | Задает входные объекты, которые будут участвовать в анализе. |
| solve () | Выполнения анализа построения маршрутов с помощью свойств, заданных для объекта Route и загруженных входных данных. |
Методы
addFields (input_type, field_description)
| Parameter | Объяснение | Тип данных |
input_type | Тип входных данных, к которым добавляются поля. Параметр должен быть задан с помощью перечисления RouteInputDataType. | Object |
field_description [field_description,...] | Поля и их свойства, которые будут добавлены во входной класс. Значение должно быть построено как список, каждая строка которого содержит следующие элементы:
Доступны следующие типы полей:
Метод возвращает ошибку, если поле в таблице уже есть или если любые свойства поля неверны. | List |
count (input_type)
| Parameter | Объяснение | Тип данных |
input_type | Тип подсчитываемых входных объектов. Параметр должен быть задан с помощью перечисления RouteInputDataType. | Object |
| Тип данных | Объяснение |
| Integer | Число строк. |
fieldMappings (input_type, {use_location_fields}, {list_candidate_fields})| Parameter | Объяснение | Тип данных |
input_type | Тип входных данных, для которых возвращаются соответствия полей. Параметр должен быть задан с помощью перечисления RouteInputDataType. См. описания полей, доступных для каждого типа входных данных | Object |
use_location_fields | Определяет, будут ли поля сетевого местоположения включены в возвращаемый словарь соответствия полей. Поля местоположения сети описывают точку сети, в которой расположен объект. Вы можете использовать поля местоположения сети для более точного контроля, как входные данные вашего анализа располагаются в сети в целях сохранения времени при вызове метода solve, поскольку механизм решения не будет вычислять поля местоположения из геометрии входных данных. Поле местоположения для класса объектов можно вычислить при помощи инструмента Вычислить местоположения. Дополнительные сведения о полях местоположения сети и способе размещения входных данных в сети Если значение аргумента - True, возвращаемый словарь сопоставления полей будет содержать только поля местоположения в сети. Значение по умолчанию - False; словарь сопоставления полей не будет содержать поля местоположения в сети. (Значение по умолчанию — False) | Boolean |
list_candidate_fields [list_candidate_fields,...] | Список объектов arcpy.Field для создания сопоставленных имен полей, которые можно получить для класса объектов или таблицы с помощью функции arcpy.ListFields. Имена полей, не сопоставленные полю по входному типу, также будут возвращены на карте. Вызов метода load с этими дополнительными полями добавит их во входные объекты механизма расчета, и поля могут быть переданы и включены в выходные данные. Если аргумент не задан, соответствия полей будут созданы только со значениями соответствующих свойств по умолчанию. (Значение по умолчанию — None) | Field |
| Тип данных | Объяснение |
| Dictionary | Словарь, в котором ключами являются имена полей, а значениями - объекты arcpy.nax.NAClassFieldMap. |
fieldNames (input_type, {use_location_fields})| Parameter | Объяснение | Тип данных |
input_type | Тип входных данных, для которых возвращаются поддерживаемые имена полей. Параметр должен быть задан с помощью перечисления RouteInputDataType. См. описания полей, доступных для каждого типа входных данных | Object |
use_location_fields | Определяет, будут ли поля сетевого местоположения включены в возвращаемый список имён полей. Поля местоположения сети описывают точку сети, в которой расположен объект. Вы можете использовать поля местоположения сети для более точного контроля, как входные данные вашего анализа располагаются в сети в целях сохранения времени при вызове метода solve, поскольку механизм решения не будет вычислять поля местоположения из геометрии входных данных. Поле местоположения для класса объектов можно вычислить при помощи инструмента Вычислить местоположения. Дополнительные сведения о полях местоположения сети и способе размещения входных данных в сети Если значение аргумента - True, возвращаемый словарь сопоставления полей будет содержать только поля местоположения в сети. Значение по умолчанию - False; список имён полей не будет содержать поля местоположения в сети. (Значение по умолчанию — False) | Boolean |
| Тип данных | Объяснение |
| String | Список имен полей, поддерживаемых заданным входным типом. |
insertCursor (input_type, field_names)
| Parameter | Объяснение | Тип данных |
input_type | Тип входных данных, для которых может использоваться курсор для вставки строк. Параметр должен быть задан с помощью перечисления RouteInputDataType. | Object |
field_names [field_names,...] | Список имен полей входного типа, значения в которых вы хотите задать при вставке строк с помощью курсора. Вы можете получить имена полей, которые поддерживаются входным типом с помощью метода fieldNames. См. описания полей, доступных для каждого типа входных данных Помимо обычных полей вы можете задать геометрию входных данных с использованием одного из токенов геометрии:
Токены SHAPE@XY и SHAPE@XYZ поддерживаются только точечными входными типами. При использовании токенов SHAPE@XY и SHAPE@XYZ, значения x, y и z должны быть заданы в пространственной привязке источника сетевых данных, используемого в анализе. | String |
| Тип данных | Объяснение |
| Object | Объект SolverInsertCursor, который можно использовать для записи объектов. |
load (input_type, features, {field_mappings}, {append}, {max_features})| Parameter | Объяснение | Тип данных |
input_type | Тип загружаемого входного объекта. Параметр должен быть задан с помощью перечисления RouteInputDataType. | Object |
features | Загружаемые входные объекты. Этот параметр поддерживает следующие входные типы:
В слой будут загружаться только выбранные пространственные объекты. Если слой содержит определяющий запрос, загрузятся только те объекты, которые будут видны с помощью этого определяющего запроса. Этот метод работает также и в среде геообработки Экстент; Будут загружаться только объекты в заданном экстенте. | String |
field_mappings | Словарь соответствий входных типов и объектов arcpy.nax.NAClassFieldMap отображает соответствие полей входных объектов. Корректные входные данные для этого параметра могут быть созданы с помощью метода fieldMappings. Если отображение полей не задано, то будут отображаться все поля из входных объектов с такими же именами, как у поддерживаемых полей входного типа. (Значение по умолчанию — None) | Dictionary |
append | Определяет, будут ли загружаемые объекты присоединены к имеющемуся набору объектов входного типа. Значение True означает, что новые объекты буду присоединяться при сохранении существующих. Это бывает полезно, когда вы хотите загрузить входные объекты из нескольких классов объектов или таблиц, чтобы использовать их в одном отдельном анализе. Используется по умолчанию. Значение False означает, что имеющиеся объекты для входного типа будут удалены и заменены загружаемыми в настоящий момент. (Значение по умолчанию — True) | Boolean |
max_features | Максимальное число объектов, которые можно загрузить во входной тип. Это полезно, если при создании инструмента или сервиса вы захотите, чтобы выводилась ошибка в случаях, когда размер входных данных превышает доступные ресурсы. Метод load возвратит arcpy.nax.LimitError, если число входных объектов превысит ограничение, равное max_features. Если значение не задано, ограничение по числу входных объектов не устанавливается. (Значение по умолчанию — None) | Integer |
solve ()
| Тип данных | Объяснение |
| Object | Объект arcpy.nax.RouteResult, который можно использовать для доступа к выходным данным и сообщениям механизма расчета. |
Пример кода
Выполняет анализ маршрутов с помощью класса объектов для входных остановок.
# An example showing how to perform route analysis using a feature class for input stops.
import arcpy
arcpy.CheckOutExtension("network")
nds = "C:/data/NorthAmerica.gdb/Routing/Routing_ND"
nd_layer_name = "Routing_ND"
input_stops = "C:/data/io.gdb/Stops"
output_routes = "C:/data/io.gdb/Routes"
# Create a network dataset layer and get the desired travel mode for analysis
arcpy.nax.MakeNetworkDatasetLayer(nds, nd_layer_name)
nd_travel_modes = arcpy.nax.GetTravelModes(nd_layer_name)
travel_mode = nd_travel_modes["Driving Time"]
# Instantiate a Route solver object
route = arcpy.nax.Route(nd_layer_name)
# Set properties
route.timeUnits = arcpy.nax.TimeUnits.Minutes
route.travelMode = travel_mode
route.routeShapeType = arcpy.nax.RouteShapeType.TrueShapeWithMeasures
# Load inputs
route.load(arcpy.nax.RouteInputDataType.Stops, input_stops)
# Solve the analysis
result = route.solve()
# Export the results to a feature class
if result.solveSucceeded:
result.export(arcpy.nax.RouteOutputDataType.Routes, output_routes)
else:
print("Solved failed")
print(result.solverMessages(arcpy.nax.MessageSeverity.All))