RouteResult

Краткая информация

Объект с результатами анализа маршрутов, который можно использовать для доступа к выходным данным и сообщениям механизма расчета.

Обсуждение

Экземпляры этого класса нельзя создавать напрямую. Но они возвращаются методом solve класса Route.

Более подробно о том, как использовать объект результата для доступа и работы с результатами анализа.

Свойства

СвойствоОписаниеТип данных
isPartialSolution
(только чтение)

Возвращает True, если механизм расчета выполнил частичное решение, что означает, что не все входные данные были включены в результаты. Это может произойти, если если одно из входных местоположение не размещено, и значение свойства ignoreInvalidLocations класса механизма расчета равно True.

Boolean
solveSucceeded
(только чтение)

Возвращает True, если выполнение механизма расчета было успешным.

Boolean
spatialReference
(только чтение)

Возвращает пространственную привязку выходных объектов. Например, классы пространственных объектов, созданные с помощью метода export, и объекты геометрии, полученные из метода searchCursor, будут иметь эту пространственную привязку. Значение spatialReference обычно является пространственной привязкой набора сетевых данных или сервиса, используемого в анализе.

SpatialReference

Обзор метода

МетодОписание
count (output_type)

Возвращает количество строк для выходного типа.

export (output_type, output_features)

Выходные объекты будут созданы в пространственной привязке набора сетевых данных, используемого для анализа. Если установлен параметр среды arcpy.env.outputCoordinateSystem, выходные объекты будут созданы с указанной системой координат.

Экспортирует результаты анализа в класс пространственных объектов или таблицу.

extent ({output_type})

Возвращает экстент выходных данных анализа.

Метод возвращает исключение RuntimeError, если не удалось выполнить анализ.

fieldNames (output_type)

Получает список имен полей, поддерживаемых заданным выходным типом.

saveAsLayerFile (file_name)

Сохраните результат анализа и настройки в файле слоя или пакете слоев. Файл слоя или пакет можно открыть в ArcGIS Pro как запись настроек анализа или для визуализации результатов. Файл слоя также можно открыть в ArcGIS Desktop.

Это метод возвращает исключение RuntimeError, если свойство allowSaveLayerFile объекта-механизма расчета задан как False.

Прежние версии:

Маршрутизация сервисов на основе портала с версией ArcGIS Enterprise старше, чем 10.9 не поддерживает сохранение пакетов слоя. Этот метод возвращает исключение RuntimeError, если это именно этот случай.

saveRouteData (file_name)

Сохранение результатов анализа в файл .zip. Файл .zip можно использовать для публикации маршрутов из анализа в качестве элементов слоя маршрутов в ArcGIS Online или ArcGIS Enterprise с помощью инструмента Опубликовать как слои маршрутов.

Элемент слоя маршрута можно использовать в разных приложениях, например, в ArcGIS Navigator, чтобы предоставить маршруты для полевых сотрудников, на панели Путевых листов Map Viewer Classic для дальнейшей настройки маршрута, содержащегося в слое маршрута и в ArcGIS Pro для создания нового аналитического слоя маршрута из слоя маршрута.

Выходные объекты будут созданы в пространственной привязке набора сетевых данных, используемого для анализа. Если был установлен параметр среды arcpy.env.outputCoordinateSystem, выходные данные будут созданы в этой пространственной привязке.

Если не удается решить, saveRouteData возвращает исключение RuntimeError.

Это метод возвращает исключение RuntimeError, если параметр allowSaveRouteData объекта-механизма расчета задан как False.

searchCursor (output_type, field_names, {where_clause})

Задает курсор поиска для заданного типа выходных данных. Этот курсор предназначен для считывания строк непосредственно из выходных данных.

solverMessages (severity)

Получает сообщения об ошибках, предупреждениях и информационные сообщения, возвращаемые механизмом расчета.

Методы

count (output_type)
ПараметрОписаниеТип данных
output_type

Тип подсчитываемых выходных объектов.

Параметр должен быть задан с помощью перечисления RouteOutputDataType.

Object
Возвращаемое значение
Тип данныхОписание
Integer

Число строк.

Не вызывает исключение.

export (output_type, output_features)
ПараметрОписаниеТип данных
output_type

Тип выходных данных для экспорта.

Параметр должен быть задан с помощью перечисления RouteOutputDataType.

See descriptions of the fields included in each output type

Object
output_features

Путь каталога к выходному классу объектов или таблице, где будут находиться экспортированные объекты.

String
extent ({output_type})
ПараметрОписаниеТип данных
output_type

The type of output features for which to get the extent.

Параметр должен быть задан с помощью перечисления RouteOutputDataType.

If you do not specify a value, or you specify a value of None, the extent for the combined analysis outputs is returned.

Object
Возвращаемое значение
Тип данныхОписание
Extent

Объект arcpy.Extent с указанием экстента назначенного выходного типа.

fieldNames (output_type)
ПараметрОписаниеТип данных
output_type

Тип выходных данных, для которых возвращается список имен полей.

Параметр должен быть задан с помощью перечисления RouteOutputDataType.

See descriptions of the fields included in each output type

Object
Возвращаемое значение
Тип данныхОписание
String

Список имен полей, поддерживаемых заданным выходным типом.

saveAsLayerFile (file_name)
ПараметрОписаниеТип данных
file_name

The catalog path of the output layer file (.lyr) or layer package (.lpkx) to write.

Внимание:

Layer files with an .lyr extension cannot be saved if the solver object uses a service URL as its network data source. The method returns a RuntimeError exception in this case.

String
saveRouteData (file_name)
ПараметрОписаниеТип данных
file_name

Полный путь к выходному файлу .zip.

String
searchCursor (output_type, field_names, {where_clause})
ПараметрОписаниеТип данных
output_type

The type of output to read.

Параметр должен быть задан с помощью перечисления RouteOutputDataType.

Object
field_names
[field_names,...]

A list of field names of the output type whose values the cursor will return. You can get the names of the fields that are supported by an output type using the fieldNames method.

See descriptions of the fields included in each output type

In addition to regular fields, you can also access the geometry of the output using one of the following geometry tokens:

  • SHAPE@XYA tuple of the feature's centroid's x- and y-coordinates.
  • SHAPE@XYZA tuple of the feature's centroid's x-, y-, and z-coordinates.
  • SHAPE@JSON The Esri JSON string representing the geometry.
  • SHAPE@WKBThe well-known binary (WKB) representation for OGC geometry. It provides a portable representation of a geometry value as a contiguous stream of bytes.
  • SHAPE@WKTThe well-known text (WKT) representation for OGC geometry. It provides a portable representation of a geometry value as a text string.
  • SHAPE@A geometry object for the feature.

The SHAPE@XY and SHAPE@XYZ tokens are only supported for point-based output types. The x-, y-, and z-values returned when using the SHAPE@XY and SHAPE@XYZ tokens are in the spatial reference reported by the solver result object's spatialReference property, and this is typically the same as the spatial reference of the network data source used for the analysis.

String
where_clause

Возвращается дополнительное выражение, которое ограничивает записи. Более подробно об условиях WHERE и выражений SQL см. Основы SQL для выражений запроса, применяемых в ArcGIS.

(Значение по умолчанию — None)

String
Возвращаемое значение
Тип данныхОписание
Object

Объект SolverResultSearchCursor, считывающий строки выходных данных.

solverMessages (severity)
ПараметрОписаниеТип данных
severity

Тип возвращаемых сообщений.

Параметр должен быть задан с помощью перечисления MessageSeverity.

Object
Возвращаемое значение
Тип данныхОписание
List

Сообщения возвращаются в виде списка списков. Внутренний список содержит два значения. Первое из них - число, соответствующее коду сообщения, а второе - его текст.

Пример списка сообщений, который возвращается в случае ошибки анализа матрицы Источник-Назначение.

[[-2147200995, '0 location(s) in "Destinations" are valid.  Need at least 1 valid location(s).'],
 [30024, 'Solve returned a failure.'],
 [-2147200995, 'Insufficient number of valid locations in "Origins" or "Destinations".']]