Сводка
Добавляет правило схемы, чтобы автоматически выполнять трассировку инженерной сети или трассировку сети во время построения схем на основе существующего шаблона. Полученные после трассировки элементы и объекты сети используются для построения содержимого схемы.
Более подробно об использовании правила трассировки для построения схем сети
Внимание:
Этот инструмент является инструментом настройки и администрирования.
Примечание:
Этот инструмент влияет на согласованность всех существующих схем, основанных на шаблоне входной схемы. Все существующие схемы становятся несогласованными и открываются со значком нарушения целостности до момента обновления.
Использование
Инструмент не поддерживается для сервиса инженерной сети. Вы должны работать с инженерной сетью или с сетью трассировки в файловой базе геоданных, либо с подключением базы данных к инженерной сети в многопользовательской базе геоданных. При работе с многопользовательской базой геоданных подключение к базе данных должно быть установлено от имени владельца базы данных инженерной сети.
При выполнении этой операции с инженерной сетью в многопользовательской базе геоданных, подключенная учетная учетная запись портала ArcGIS Enterprise должна быть владельцем инженерной сети на портале.
Элемент данных сети, указанный для параметра входной сети, должен быть либо из инженерной сети или из сети трассировки в файловой базе геоданных, либо из подключения базы данных к инженерной сети многопользовательской базы геоданных.
Правило Трассировка используется для запуска трассировки по элементам инженерной сети или сети трассировки, представленным на схеме в текущий момент.
В зависимости от указанного типа трассировки начальные точки могут или должны быть предварительно настроены в схеме для выполнения правила трассировки:
- Для типов трассировки Подключенная, Подсеть, Трассировка вверх по течению и Трассировка вниз по течению все элементы инженерной сети и сети трассировки, представленные на схеме в момент начала правила трассировки, рассматриваются как начальные точки трассировки, если только в шаблоне схемы не задано правило Установить начальную точку для точной идентификации начальных точек.
- Для типа трассировки Кратчайший путь в шаблоне схемы должно быть настроено правило Установить начальную точку, чтобы определить две начальные точки среди всех элементов сети трассировки, которые в настоящий момент представлены на схеме, и между которыми должен быть найден кратчайший путь.
Когда вы настраиваете шаблон на основании правила Трассировка, трассировка сети будет систематически заново выполняться при каждом обновлении схемы. Это значит, что любая схема, основанная на этом шаблоне, при обновлении всегда будет отражать результат текущей трассировки.
Синтаксис
AddTraceRule(in_utility_network, template_name, is_active, trace_type, {domain_network}, {tier}, {target_tier}, {include_structures}, {include_barriers}, {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}, {propagators}, {description}, {allow_indeterminate_flow}, {path_direction}, {path_network_weight_name})
Parameter | Объяснение | Тип данных |
in_utility_network | Инженерная сеть или сеть трассировки, в которой находится изменяемый шаблон схемы. | Utility Network; Trace Network |
template_name | Имя изменяемого шаблона схемы. | String |
is_active | Указывает, будет ли правило включено при создании и обновлении схем на основе указанного шаблона:
| Boolean |
trace_type | Определяет тип трассировки, выполняемой правилом для построения содержания схемы.
| String |
domain_network (Дополнительный) | Имя специализированной сети, где будет выполняться трассировка. Этот параметр требуется при запуске трассировки подсети, трассировки вверх и вниз по течению. | String |
tier (Дополнительный) | Имя уровня, где будет выполняться начало трассировки инженерной сети. Этот параметр является дополнительным, когда запускается тип трассировки Связанное; он является обязательным при запуске типов трассировки Посети, Вверх по течению и Вниз по течению. | String |
target_tier (Дополнительный) | Имя целевого уровня, в сторону которого перетекает входной уровень инженерной сети. Если для трассировок вверх против течения и вниз по течению этот параметр отсутствует, то эти трассировки будут остановлены, когда они достигнут границы начальной подсети. Данный параметр используется для того, чтобы эти трассировки могли быть продолжены далее, либо вверх, либо вниз по иерархии. | String |
include_structures (Дополнительный) | Определяет, будут ли структурные объекты и другие объекты включены в результаты трассировки.
| Boolean |
include_barriers (Дополнительный) | Определяет, будут ли объекты барьеров проходимости включаться в результаты трассировки. Включение барьеров проходимости являются дополнительной опцией, даже если они представлены в определении подсети. Этот параметр не применяется для объектов устройств с терминалами.
| 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 (Дополнительный) | Тип проходимости для применения. Область проходимости определяет, будут ли применены настройки проходимости для соединений, ребер или для обоих. Например, если барьер условия определен на остановку трассировки, если Статус устройства равен значению Открыто и область действия проходимости задана только для ребер, то даже в случае, если трассировка встретит открытое устройство, она не будет остановлена, поскольку Статус устройства применим только к соединениям. Другими словами, параметр показывает, что трассировка должна игнорировать ребра, соединения, или и то и другое.
| 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 является True. | Long |
nearest_cost_network_attribute (Дополнительный) | Числовой атрибут сети, который будет использоваться для вычисления степени близости, стоимости или расстояния, когда filter_nearest – True, например, длина объекта. | String |
nearest_categories [nearest_categories,...] (Дополнительный) | Возвращаемые категории, когда filter_nearest – True, например – Protective. | String |
nearest_assets [nearest_assets,...] (Дополнительный) | Группы оборудования и типы оборудования, возвращаемые когда filter_nearest – True, например – ElectricDistributionDevice/Transformer/Step Down. | String |
propagators [[Attribute, Substitution Attribute, Function, Operator, Value],...] (Дополнительный) | Задает распространяющиеся атрибуты сети, а также способ распространения в процессе трассировки. Класс распространяющихся атрибутов определяет ключевое значение для контроллеров подсети, которое будет распределено по остальным объектам подсети. Например, в модели электрической сети вы можете распространить значение фазы. Используются следующие компоненты распространения:
Варианты значений распространителей function следующие:
Варианты значений распространителей operator следующие:
Более подробно о побитовых операторах Примечание:Этот параметр доступен только в Python. | Value Table |
description (Дополнительный) | Описание правила. | String |
allow_indeterminate_flow (Дополнительный) | Определяет, будет ли выполняться трассировка объектов с неопределенным или неинициализированным потоком. Этот параметр используется только при запуске трассировки вверх или вниз по течению.
| Boolean |
path_direction (Дополнительный) | Определяет направление пути в сети трассировки. Стоимость прохождения пути определяется на основе значения, заданного для path_network_attribute_name. Этот параметр используется только при запуске трассировки типа PATH.
| String |
path_network_weight_name (Дополнительный) | Атрибут сети, используемый для вычисления кратчайшего пути в сети трассировки. При запуске трассировки типа кратчайший путь, кратчайший путь вычисляется с помощью числового атрибута сети, такого как Длина объекта. Могут быть вычислены пути как на основе стоимости, так и на основе расстояния. Этот параметр является обязательным при запуске трассировки кратчайшего пути. | String |
Производные выходные данные
Name | Объяснение | Тип данных |
out_utility_network | Обновленная инженерная сеть или сеть трассировки. | Инженерная сеть; Трассировка сети |
out_template_name | Имя шаблона схемы. | Строковое |
Пример кода
Добавляет правило Трассировки в шаблон MyTemplate1, заданный в данной инженерной сети, для построения схем на основе трассировки подсетей с уровнем Medium Voltage в домене ElectricDistribution.
import arcpy
input_Network = "D:/MyProjectLocation/MyDatabaseConnection.sde/MyDatabase.MAP.Electric/MyDatabase.MAP.Electric"
input_DiagramTemplate = "MyTemplate1"
arcpy.AddTraceRule_nd(input_Network, input_DiagramTemplate, "ACTIVE",
"SUBNETWORK", "ElectricDistribution", "Medium Voltage",
"Low Voltage Mesh")
Environments
Информация о лицензиях
- Basic: Нет
- Standard: Да
- Advanced: Да