Доступно с лицензией Standard или Advanced.
Сводка
Создает конфигурацию трассировки в инженерной сети.
Конфигурации трассировки позволяют настраивать и сохранять свойства сложных трассировок для повторного использования и совместного использования. Конфигурации трассировок, сохраненные в инженерной сети, можно загружать и выполнять из инструмента Трассировка или публиковать для использования веб-картой или полевым приложением.
Использование
Входная инженерная сеть должна быть версии 5 или более поздней.
При работе с многопользовательской базой геоданных входная инженерная сеть должна быть сервисом инженерной сети.
В качестве создателя конфигурации трассировки указана подключенная учетная запись портала.
При работе с инженерной сетью в файловой базе геоданных для сохранения автора конфигурации трассировки используется аутентификация средствами операционной системы.
Синтаксис
arcpy.un.AddTraceConfiguration(in_utility_network, trace_config_name, trace_type, {description}, {tags}, {domain_network}, {tier}, {target_tier}, {subnetwork_name}, {shortest_path_network_attribute_name}, {include_containers}, {include_content}, {include_structures}, {include_barriers}, {validate_consistency}, {condition_barriers}, {function_barriers}, {traversability_scope}, {filter_barriers}, {filter_function_barriers}, {filter_scope}, {filter_bitset_network_attribute_name}, {filter_nearest}, {nearest_count}, {nearest_cost_network_attribute}, {nearest_categories}, {nearest_assets}, {functions}, {propagators}, {output_assettypes}, {output_conditions}, {include_isolated_features}, {ignore_barriers_at_starting_points}, {include_up_to_first_spatial_container}, {result_types}, {allow_indeterminate_flow}, {validate_locatability})
Parameter | Объяснение | Тип данных |
in_utility_network | Инженерная сеть, которая будет содержать новую конфигурацию трассировки. | Utility Network; Utility Network Layer |
trace_config_name | Имя конфигурации трасссировки. | String |
trace_type | Задает тип настраиваемой трассировки.
| String |
description (Дополнительный) | Описание конфигурации трассировки. | String |
tags [tags,...] (Дополнительный) | Набор тегов, используемых для идентификации конфигурации трассировки. Теги могут использоваться в поиске и индексировании. | String |
domain_network (Дополнительный) | Имя специализированной сети, где будет выполняться трассировка. Этот параметр необходим для выполнения таких типов трассировки, как трассировка подсети, контроллеров подсети, а также вверх по течению и вниз по течению. | String |
tier (Дополнительный) | Имя уровня, в котором начинается трассировка. Этот параметр необходим для выполнения таких типов трассировки, как трассировка подсети, контроллеров подсети, а также вверх по течению и вниз по течению. | String |
target_tier (Дополнительный) | Имя целевого уровня, в сторону которого перетекает входной уровень. Если для трассировок вверх против течения и вниз по течению этот параметр отсутствует, то эти трассировки будут остановлены, когда они достигнут границы начальной подсети. Данный параметр используется для того, чтобы эти трассировки могли быть продолжены далее, либо вверх, либо вниз по иерархии. | String |
subnetwork_name (Дополнительный) | Имя подсети, где будет выполняться трассировка. Этот параметр можно использовать при запуске трассировки с типом трассировка подсети. Если указано имя подсети, параметр Начальные точки (параметр starting_points в Python) не требуется. | String |
shortest_path_network_attribute_name (Дополнительный) | Атрибут сети, используемый для вычисления кратчайшего пути. При запуске трассировки типа кратчайший путь, кратчайший путь вычисляется с помощью числового атрибута сети, такого как Длина объекта. Могут быть вычислены пути как на основе стоимости, так и на основе расстояния. Этот параметр является обязательным при запуске трассировки кратчайшего пути. | String |
include_containers (Дополнительный) | Определяет, будут ли объекты-контейнеры включены в результаты трассировки.
| Boolean |
include_content (Дополнительный) | Определяет, будет ли трассировка возвращать содержание контейнеров в качестве результатов.
| Boolean |
include_structures (Дополнительный) | Определяет, будут ли структурные объекты и другие объекты включены в результаты трассировки.
| Boolean |
include_barriers (Дополнительный) | Определяет, будут ли объекты барьеров проходимости включаться в результаты трассировки. Включение барьеров проходимости являются дополнительной опцией, даже если они представлены в определении подсети. Этот параметр не применяется для объектов устройств с терминалами.
| Boolean |
validate_consistency (Дополнительный) | Определяет, будет ли возвращаться ошибка в случае обнаружения измененных областей для любого из пройденных объектов. Это единственный способ гарантировать, что трассировка проходит через объекты со статусом целостности в сети. Для удаления измененных областей проверьте топологию сети.
| Boolean |
condition_barriers [[Name, Operator, Type, Value, Combine Using],...] (Дополнительный) | Задает условия проходимости барьеров в объекте на основании сравнения с сетевым атрибутом или проверки строки категории. Барьер условия использует атрибут сети, оператор и тип, а также значение атрибута. Например, остановите трассировку, если атрибут Device Status объекта равен определенному значению Open. Если объект удовлетворяет этому условию, трассировка остановится. При использовании более одного атрибута, можно применить параметр Комбинировать использование, чтобы задать условие И или Или. Применяются следующие компоненты барьера условий:
Варианты значений барьеров условий operator следующие:
Более подробно о побитовых операторах Варианты значений барьеров условий Type следующие:
Варианты значений барьеров условий Combine Using следующие:
Более подробно об использовании множественных условных выражений | Value Table |
function_barriers [[Function, Attribute, Operator, Value, Use Local Values],...] (Дополнительный) | Задает барьер проходимости на объектах на основе функции. Барьеры функций можно применять для ограничения того, насколько далеко трассировка может уйти от начальной точки, или установки максимального значения, при котором трассировка остановится. Например, длина каждой пройденной линии добавляется к общему пройденному на данный момент расстоянию. Когда общая пройденная длина достигнет указанного значения, трассировка остановится. Применяются следующие компоненты барьера функций:
Варианты значений барьера функции function следующие:
Варианты значений барьера функции operator следующие:
Более подробно о побитовых операторах Опции барьера функции Use Local Values:
| Value Table |
traversability_scope (Дополнительный) | Тип проходимости для применения. Область проходимости определяет, будут ли применены настройки проходимости для соединений, ребер или для обоих. Например, если условный барьер задан для остановки трассировки в случае, когда Device Status равно Open и область проходимости задано только по ребрам, трассировка не остановится, даже при обнаружении открытого устройства, поскольку Device Status применимо только к узлам. Другими словами, параметр показывает, что трассировка должна игнорировать ребра, соединения, или и то и другое.
| String |
filter_barriers [[Name, Operator, Type, Value, Combine Using],...] (Дополнительный) | Определяет, когда должна быть прекращена трассировка для определенной категории или атрибута сети. Например, остановить трассировку на объектах, имеющих атрибут статуса жизненного цикла, равный заданному значению. Этот параметр используется для задания ограничителя на основе значения атрибута сети, определенного в системе. При использовании более одного атрибута можно применить параметр Combine Using, чтобы задать условие И или Или. Компоненты барьеров фильтра следующие:
Варианты значений барьеров фильтра operator следующие:
Более подробно о побитовых операторах Варианты значений барьеров фильтра Type следующие:
Варианты значений барьеров фильтра Combine Using следующие:
Более подробно об использовании множественных условных выражений | Value Table |
filter_function_barriers [[Function, Attribute, Operator, Value, Use Local Values],...] (Дополнительный) | Фильтрует результаты трассировки на определенную категорию. Фильтруют компоненты барьеров функции следующим образом:
Варианты значений function барьеров функции фильтр следующие:
Варианты значений operator барьеров функции фильтр следующие:
Более подробно о побитовых операторах Варианты значений Use Local Values барьеров функции фильтр следующие:
| Value Table |
filter_scope (Дополнительный) | Определяет, будет ли использоваться фильтр для определенной категории – только для соединений, только для ребер или в обоих перечисленных случаях. Например, если фильтр барьера задан для остановки трассировки, если Состояние устройства - Открыто, а для области проходимости задано «только ребра», трассировка не остановится, даже если обнаружит открытое устройство, так как Статус устройства применим только к соединениям. Другими словами, параметр показывает, что трассировка должна игнорировать ребра, соединения, или и то и другое.
| String |
filter_bitset_network_attribute_name (Дополнительный) | Имя атрибута сети, который может быть использован для фильтрации по битовому множеству. Этот параметр применяется только для трассировки типа вверх против течения, вниз по течению и петли. Этот параметр может быть использован для добавления специальной логики во время трассировки, чтобы трассировка могла полнее отражать сценарии реального мира. Например, при трассировке петель атрибут сети Текущие фазы может определить, является ли петля истинной электрической петлей (та же фаза проходит вдоль всей петли, то есть А) и возвратить для результатов трассировки только реальные электрические петли. Пример трассировки вверх против течения: при трассировке сети электрического распределения, указав атрибут сети Текущие фазы, вы получите в качестве результатов трассировки только корректные пути, которые указаны в атрибуте сети, а не все пути. | String |
filter_nearest (Дополнительный) | Определяет, будет ли использоваться алгоритм K-ближайших соседей для возврата объектов определенного типа в пределах заданного расстояния. Используя этот параметр, вы можете указать количество, стоимость, а также либо набор категорий, либо тип оборудования, либо и то, и другое.
| Boolean |
nearest_count (Дополнительный) | Определяет число возвращаемых объектов, когда значением filter_nearest является FILTER_BY_NEAREST. | Long |
nearest_cost_network_attribute (Дополнительный) | Числовой атрибут сети, который будет использоваться для вычисления степени близости, стоимости или расстояния, когда filter_nearest – FILTER_BY_NEAREST, например, длина объекта. | String |
nearest_categories [nearest_categories,...] (Дополнительный) | Возвращаемые категории, когда filter_nearest – FILTER_BY_NEAREST, например – Protective. | String |
nearest_assets [nearest_assets,...] (Дополнительный) | Группы оборудования и типы оборудования, возвращаемые когда filter_nearest – FILTER_BY_NEAREST, например – ElectricDistributionDevice/Transformer/Step Down. | String |
functions [[Function, Attribute, Filter Name, Filter Operator, Filter Type, Filter Value],...] (Дополнительный) | Применяет функцию вычисления к результатам трассировки. Компоненты функций следующие:
Варианты значений функций Function следующие:
Например, имеется начальная точка со значением 20. Следующий объект имеет значение 30. Если вы применяете функцию MINIMUM, результатом будет 20. MAXIMUM – 30, ADD – 50, AVERAGE – 25, COUNT – 2 и SUBTRACT – -10. Опции значения Filter Operator:
Более подробно о побитовых операторах Варианты значений функций Filter Type следующие:
| Value Table |
propagators [[Attribute, Substitution Attribute, Function, Operator, Value],...] (Дополнительный) | Указывает сетевые атрибуты для распространения, а также то, как это распространение будет происходить во время трассировки. Класс распространяющихся атрибутов определяет ключевое значение для контроллеров подсети, которое будет распределено по остальным объектам подсети. Например, в модели электрической сети вы можете распространить значение фазы. Используются следующие компоненты распространения:
Варианты значений распространителей function следующие:
Варианты значений распространителей operator следующие:
Более подробно о побитовых операторах Примечание:Этот параметр доступен только в Python. | Value Table |
output_assettypes [output_assettypes,...] (Дополнительный) | Отфильтруйте выходные типы оборудования, которые должны быть включены в результаты, например – только навесные трансформаторы. | String |
output_conditions [[Name, Operator, Type, Value, Combine Using],...] (Дополнительный) | Определяет типы возвращаемых объектов в зависимости от сетевого атрибута или категории. Например, если трассировка настроена на фильтрацию всех объектов, кроме Водоотводов, любые трассированные объекты, которым не присвоена категория Водоотвод, не будут включены в результаты. Любые трассированные объекты с этой категорией будут возвращены в итоговом наборе выборки. При использовании более одного атрибута можно применить параметр Combine Using, чтобы задать условие И или Или. Компоненты выходных условий следующие:
Варианты значений выходных условий operator следующие:
Более подробно о побитовых операторах Варианты значений выходных условий Type следующие:
Варианты значений выходных условий Combine Using следующие:
Более подробно об использовании множественных условных выражений | Value Table |
include_isolated_features (Дополнительный) | Определяет, будут ли изолированные объекты включаться в результаты трассировки. Этот параметр используется только при запуске трассировки изоляции.
Примечание:Тип трассировки Изоляция требует ArcGIS Enterprise 10.7 или более поздней версии, если используется многопользовательская база геоданных. | Boolean |
ignore_barriers_at_starting_points (Дополнительный) | Определяет, будут ли в конфигурации трассировки игнорироваться динамические барьеры для начальных точек. Это может быть полезно при выполнении трассировки защитных устройств вверх по течению и использовании найденных защитных устройств (барьеров) в качестве начальных точек для поиска последующих защитных устройств, находящихся вверх по течению.
| Boolean |
include_up_to_first_spatial_container (Дополнительный) | Указывает, следует ли ограничить возвращаемые контейнеры только теми, которые встречались ранее, и включать первый пространственный контейнер для каждого сетевого элемента в результатах трассировки. Если пространственные контейнеры не встречаются, но для данного элемента сети присутствуют не пространственные контейнеры, то все не пространственные контейнеры будут включены в результаты. Этот параметр применяется, только если Include Containers enabled.
| Boolean |
result_types [result_types,...] (Дополнительный) | Задает тип результатов трассировки.
| String |
allow_indeterminate_flow (Дополнительный) | Определяет, будет ли выполняться трассировка объектов с неопределенным потоком. Этот параметр используется только при запуске трассировки вверх или вниз по течению.
| Boolean |
validate_locatability (Дополнительный) | Указывает, будет ли возвращена ошибка, если обнаружатся объекты непространственных соединений или ребер без связанного контейнера или структуры в иерархии связей для пройденных объектов. Эта опция обеспечивает связь непространственных объектов, возвращаемых трассировкой, с пространственными объектами.
| Boolean |
Производные выходные данные
Name | Объяснение | Тип данных |
out_utility_network | Обновленная инженерная сеть | Инженерная сеть |
Пример кода
В следующем скрипте окна Python показано, как используется инструмент AddTraceConfiguration.
import arcpy
arcpy.AddTraceConfiguration_un(
r"SampleUNService\Elec Utility Network", "Upstream_RMT002", "UPSTREAM",
"Upstream trace on RMT002", "Upstream;RMT002", "ElectricDistribution",
"Medium Voltage", '', '', '', "EXCLUDE_CONTAINERS", "EXCLUDE_CONTENT",
"EXCLUDE_STRUCTURES", "INCLUDE_BARRIERS", "VALIDATE_CONSISTENCY", None,
None, "BOTH_JUNCTIONS_AND_EDGES", None, None, "BOTH_JUNCTIONS_AND_EDGES",
'', "DO_NOT_FILTER", None, '', None, None, None, None, None, None,
"EXCLUDE_ISOLATED_FEATURES", "DO_NOT_IGNORE_BARRIERS_AT_STARTING_POINTS",
"DO_NOT_INCLUDE_UP_TO_FIRST_SPATIAL_CONTAINER", None,
"TRACE_INDETERMINATE_FLOW", "DO_NOT_VALIDATE_LOCATABILITY")
Environments
Информация о лицензиях
- Basic: Нет
- Standard: Да
- Advanced: Да