Добавить правило трассировки (Схема сети)

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

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

Более подробно об использовании правила трассировки для построения схем сети

Внимание:

Этот инструмент является инструментом настройки и администрирования.

Примечание:

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

Использование

  • Этот инструмент не поддерживается при работе с сервисом инженерной сети или сети трассировки. Вы должны работать с инженерной сетью или с сетью трассировки в файловой или мобильной базе геоданных, либо с подключением базы данных к инженерной сети или сети трассировки в многопользовательской базе геоданных. При работе с многопользовательской базой геоданных необходимо соблюдать следующие требования:

  • Правило Трассировка используется для запуска трассировки по элементам инженерной сети или сети трассировки, представленным на схеме в текущий момент.

    В зависимости от указанного типа трассировки начальные точки могут или должны быть предварительно настроены в схеме для выполнения правила трассировки:

    • Для типов трассировки Подключенная, Подсеть, Трассировка вверх по течению и Трассировка вниз по течению все элементы инженерной сети и сети трассировки, представленные на схеме в момент начала правила трассировки, рассматриваются как начальные точки трассировки, если только в шаблоне схемы не задано правило Установить начальную точку для точной идентификации начальных точек.
    • Для типа трассировки Кратчайший путь в шаблоне схемы может быть настроено правило Установить начальную точку, чтобы определить две начальные точки среди всех элементов сети трассировки, которые в настоящий момент представлены на схеме, и между которыми должен быть найден кратчайший путь.

  • Когда вы настраиваете шаблон на основании правила Трассировка, трассировка сети будет систематически заново выполняться при каждом обновлении схемы. Это значит, что любая схема, основанная на этом шаблоне, при обновлении всегда будет отражать результат текущей трассировки.

Параметры

ПодписьОписаниеТип данных
Входная сеть

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

Utility Network; Trace Network
Входной шаблон схемы

Имя шаблона схемы, который будет изменяться.

String
Активный

Указывает, активно ли будет правило при создании и обновлении схем на основе указанного шаблона:

  • Отмечено – Добавляемое правило станет активным во время создания и обновления любых схем на основе входного шаблона. Это значение по умолчанию
  • Не отмечено – Добавляемое правило не будет активным во время создания и обновления любых схем на основе входного шаблона.

Boolean
Тип трассировки

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

  • ПодключеннаяСоединенная трассировка будет запускаться из элементов инженерной сети или сети трассировки, в данный момент представленных в схеме, когда правило запускается и распространяется вдоль соединенных элементов. Это значение по умолчанию
  • ПодсетьТрассировка подсети будет запускаться от элементов инженерной сети, в данный момент представленных в схеме, когда правило запускается и распространяется вдоль соединенных объектов для поиска источников или приемников, из которых она распространяется дальше, вдоль связанной подсети.
  • Вверх по течениюТрассировка вверх по течению будет запускаться от элементов инженерной сети или сети трассировки, в данный момент представленных в схеме, когда правило запускается для обнаружения элементов вверх по течению.
  • Вниз по течениюТрассировка вниз по течению будет запускаться из элементов инженерной сети или сети трассировки, в данный момент представленных в схеме, когда правило запускается для обнаружения объектов вниз по течению.
  • Кратчайший путьТрассировка кратчайшего пути будет выполняться от объектов инженерной сети или сети трассировки, в данный момент указанных в схеме как начальные точки, когда правило начинает исследовать объекты вдоль кратчайшего пути между этими начальными точками. Стоимость прохождения пути определяется на основе сетевого атрибута, заданного для значения параметра Имя сетевого атрибута кратчайшего пути, независимо от направления потока.
String
Специализированная сеть
(Дополнительный)

Имя специализированной сети, где будет выполняться трассировка для инженерной сети. Этот параметр требуется при запуске трассировки подсети, трассировки вверх и вниз по течению.

String
Уровень
(Дополнительный)

Имя уровня, где будет выполняться начало трассировки инженерной сети. Этот параметр является дополнительным, когда запускается тип трассировки Связанное; он является обязательным при запуске типов трассировки Посети, Вверх по течению и Вниз по течению.

String
Целевой уровень
(Дополнительный)

Имя целевого уровня, в сторону которого будет перетекать входной уровень инженерной сети. Если для трассировок вверх и вниз по течению этот параметр отсутствует, то эти трассировки будут остановлены, когда они достигнут границы начальной подсети. Данный параметр используется для того, чтобы эти трассировки могли быть продолжены далее, либо вверх, либо вниз по иерархии.

String
Включить структуры
(Дополнительный)

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

  • Отмечено – структурные объекты и другие объекты будут включены в результаты трассировки.
  • Не отмечено – структурные объекты и другие объекты не будут включаться в результаты трассировки. Это значение по умолчанию

Boolean
Включить объекты барьеров
(Дополнительный)

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

  • Отмечено – объекты барьеров проходимости будут включены в результаты трассировки. Используется по умолчанию.
  • Не отмечено – объекты барьеров проходимости не будут включены в результаты трассировки.

Boolean
Барьеры условий
(Дополнительный)

Задает условия проходимости барьеров в объекте на основании сравнения с сетевым атрибутом или проверки строки категории. Барьер условия использует атрибут сети, оператор и тип, а также значение атрибута. Например, остановите трассировку, если атрибут Device Status объекта равен определенному значению Open. Если объект удовлетворяет этому условию, трассировка остановится. При использовании более одного атрибута, можно применить параметр Комбинировать использование, чтобы задать условие И или Или.

Применяются следующие компоненты барьера условий:

  • Имя – фильтр по любому сетевому атрибуту, заданному в системе.
  • Оператор – выбрать среди различных операторов.
  • Тип – выбрать определенное значение или сетевой атрибут из значений, указанных в параметре Имя.
  • Значение – задайте определенное значение для типа входного атрибута, которое может вызвать прерывание на основании значения оператора.
  • Комбинировать использование - задайте это значение, если собираетесь добавить несколько атрибутов. Вы можете комбинировать их, используя условие И или Или.

Значения Оператора барьеров условий следующие:

  • Равно – атрибут равен значению.
  • Не равно – атрибут не равен значению.
  • Больше – атрибут больше значения.
  • Больше или равно – атрибут больше или равен значению.
  • Меньше – атрибут меньше значения.
  • Меньше или равно – атрибут меньше или равен значению.
  • Включает значения – побитовая операция AND, где все биты в значении присутствуют в атрибуте (побитовый AND == значение).
  • Не включает значения – побитовая операция AND, где не все биты в значении присутствуют в атрибуте (побитовый AND != значение).
  • Включает любое – побитовая операция AND, в которой хотя бы один бит в значении присутствует в атрибуте (побитовый AND == True).
  • Не включает включает любое – побитовая операция AND, где ни один из битов в значении не присутствует в атрибуте (побитовый AND == False).

Опции значения Тип барьеров условий следующие:

  • Заданное значение – включает фильтр по заданному значению.
  • Сетевые атрибуты – включает фильтр по атрибуту сети.

Value Table
Барьеры функции
(Дополнительный)

Задает барьер проходимости на объектах на основе функции. Барьеры функций можно применять для ограничения того, насколько далеко трассировка может уйти от начальной точки, или установки максимального значения, при котором трассировка остановится. Например, длина каждой пройденной линии добавляется к общему пройденному на данный момент расстоянию. Когда общая пройденная длина достигнет указанного значения, трассировка остановится.

Применяются следующие компоненты барьера функций:

  • Функция – выбрать среди различных функций вычисления.
  • Атрибут – фильтр по любому сетевому атрибуту, заданному в системе.
  • Оператор – выбрать среди различных операторов.
  • Значение – укажите определенное значение типа входного атрибута, которое, если будет найдено, может вызвать прерывание.
  • Использовать локальные значения - вычисляет значения в каждом направлении, в отличие от общего глобального значения, например, имеется барьер функции, вычисляющей сумму Shape length, где трассировка прерывается, если значение больше или равно 4. В общем случае, после прохождения двух ребер со значением 2, вы уже достигнете суммы Shape length, равной 4, и трассировка остановится. Если используются локальные значения, изменяются локальные значения вдоль каждого пути, и трассировка продолжается.
    • Отмечено — будут использоваться локальные значения.
    • Не отмечено — будут использоваться глобальные значения. Используется по умолчанию.

Опции значений Функции барьера функций:

  • Минимум – минимальное из входных значений.
  • Максимум – максимальное из входных значений.
  • Добавить – сумма входных значений.
  • Среднее – среднее входных значений.
  • Количество – количество пространственных объектов.
  • Вычесть – разница между входными значениями.

    Контроллеры подсети и трассировка петель не поддерживают функцию вычитания.

Например, объект начальной точки имеет значение 20. Следующий объект имеет значение 30. Если вы используете функцию минимума, результат равен 20, максимум - 30, добавить - 50, среднее - 25, количество - 2 и разность -10.

Опции значений Оператора барьера функций:

  • Равно – атрибут равен значению.
  • Не равно – атрибут не равен значению.
  • Больше – атрибут больше значения.
  • Больше или равно – атрибут больше или равен значению.
  • Меньше – атрибут меньше значения.
  • Меньше или равно – атрибут меньше или равен значению.
  • Включает значения – побитовая операция AND, где все биты в значении присутствуют в атрибуте (побитовый AND == значение).
  • Не включает значения – побитовая операция AND, где не все биты в значении присутствуют в атрибуте (побитовый AND != значение).
  • Включает любое – побитовая операция AND, в которой хотя бы один бит в значении присутствует в атрибуте (побитовый AND == True).
  • Не включает включает любое – побитовая операция AND, где ни один из битов в значении не присутствует в атрибуте (побитовый AND == False).

Value Table
Применить проходимость к
(Дополнительный)

Определяет тип проходимости, который будет применяться. Область проходимости определяет, будет ли проходимость применяться на соединениях, ребрах или в обоих случаях. Например, если условный барьер задан для остановки трассировки в случае, когда Device Status равно Open и область проходимости задано только по ребрам, трассировка не остановится, даже при обнаружении открытого устройства, поскольку Device Status применимо только к узлам. Другими словами, параметр показывает, что трассировка должна игнорировать ребра, соединения, или и то и другое.

  • Ребра и соединения – настройки проходимости будут применены как к ребрам, так и к соединениям.
  • Только соединения – настройки проходимости будут применены только к соединениям.
  • Только ребра – настройки проходимости будут применены только к ребрам.

  • И соединения, и ребраПроходимость будет применима как к соединениям, так и к ребрам. Это значение по умолчанию
  • Только соединенияПроходимость будет применена только к соединениям.
  • Только ребраПроходимость будет применена только к ребрам.
String
Фильтр барьеров
(Дополнительный)

Определяет, когда должна быть прекращена трассировка для определенной категории или атрибута сети. Например, остановить трассировку на объектах, имеющих атрибут статуса жизненного цикла, равный заданному значению. Этот параметр используется для задания ограничителя на основе значения атрибута сети, определенного в системе. Когда используется более одного атрибута, можно использовать опцию Комбинировать использование, чтобы задать условие И или Или.

Компоненты барьеров фильтра следующие:

  • Имя – фильтрация по категории или любому из атрибутов сети, заданному в системе.
  • Оператор – выбрать среди различных операторов.
  • Тип – выбрать определенное значение или сетевой атрибут из значений, указанных в параметре Имя.
  • Значение – задать определенное значение для типа входного атрибута, которое может вызвать прерывание на основании значения оператора.
  • Комбинировать использование – задайте это значение, если собираетесь добавить несколько атрибутов. Их можно комбинировать при помощи условий И или ИЛИ.

Опции значения Оператор барьеров фильтра следующие:

  • Равно – атрибут равен значению.
  • Не равно – атрибут не равен значению.
  • Больше – атрибут больше значения.
  • Больше или равно – атрибут больше или равен значению.
  • Меньше – атрибут меньше значения.
  • Меньше или равно – атрибут меньше или равен значению.
  • Включает значения – побитовая операция AND, где все биты в значении присутствуют в атрибуте (побитовый AND == значение).
  • Не включает значения – побитовая операция AND, где не все биты в значении присутствуют в атрибуте (побитовый AND != значение).
  • Включает любое – побитовая операция AND, в которой хотя бы один бит в значении присутствует в атрибуте (побитовый AND == True).
  • Не включает включает любое – побитовая операция AND, где ни один из битов в значении не присутствует в атрибуте (побитовый AND == False).

Опции значения Тип барьеров фильтра следующие:

  • Заданное значение – включает фильтр по заданному значению.
  • Сетевые атрибуты – включает фильтр по атрибуту сети.

Value Table
Фильтр барьеров функции
(Дополнительный)

Фильтрует результаты трассировки на определенную категорию.

Компоненты барьеров функции фильтра следующие:

  • Функция – выбрать среди различных функций вычисления.
  • Атрибут – фильтрация по любому из атрибутов сети, определенному в системе.
  • Оператор – выбрать среди различных операторов.
  • Значение – указать определенное значение типа входного атрибута, которое, если будет найдено, может вызвать прерывание.
  • Использовать локальные значения – вычисляет значения в каждом направлении, в отличие от общего глобального значения. Например, барьер функций вычисляет сумму длин объектов, при которой трассировка прекращается, если достигнуто значение, большее или равное 4. В общем, после того, как вы пройдете два ребра со значением 2, сумма длин объектов станет равна 4, и поэтому трассировка будет прекращена. Когда используются локальные значения, изменятся локальные значения вдоль каждого пути, или трассировка будет продолжена.
    • Отмечено — будут использоваться локальные значения.
    • Не отмечено — будут использоваться глобальные значения. Это значение по умолчанию

Опции значения Функция барьеров функций фильтра следующие:

  • Минимум – будет использоваться минимальное из входных значений.
  • Максимум – будет использоваться максимальное из входных значений.
  • Добавить – будет использоваться сумма значений.
  • Среднее – будет использоваться среднее входных значений.
  • Количество – будет использоваться количество пространственных объектов.
  • Вычесть – будет использоваться разность значений. Контроллеры подсети и циклические трассировки не поддерживаются функцией вычитания.

Например, имеется объект начальной точки со значением 20. Следующий объект имеет значение 30. Если используется функция Минимум, результатом будет 20. Максимум - 30, добавить - 50, среднее - 25, количество - 2 и разность -10.

Опции значения Оператор барьеров функций фильтра следующие:

  • Равно – атрибут равен значению.
  • Не равно – атрибут не равен значению.
  • Больше – атрибут больше значения.
  • Больше или равно – атрибут больше или равен значению.
  • Меньше – атрибут меньше значения.
  • Меньше или равно – атрибут меньше или равен значению.
  • Включает значения – побитовая операция AND, где все биты в значении присутствуют в атрибуте (побитовый AND == значение).
  • Не включает значения – побитовая операция AND, где не все биты в значении присутствуют в атрибуте (побитовый AND != значение).
  • Включает любое – побитовая операция AND, в которой хотя бы один бит в значении присутствует в атрибуте (побитовый AND == True).
  • Не включает включает любое – побитовая операция AND, где ни один из битов в значении не присутствует в атрибуте (побитовый AND == False).

Value Table
Применить фильтр к
(Дополнительный)

Определяет, будет ли фильтр для определенной категории применяться к соединениям, ребрам или ко всем. Например, если фильтр барьера задан для остановки трассировки в случае, когда Статус устройства - Открыто и задана область проходимости только по ребрам, трассировка не остановится даже при обнаружении открытого устройства, поскольку Статус устройства относится только к узлам. Другими словами, этот параметр указывает трассировке, следует ли игнорировать ребра, соединения, или и то и другое.

  • Ребра и соединения – фильтр будет применен как к соединениям, так и к ребрам. Это значение по умолчанию
  • Только соединения – фильтр будет применен только к соединениям.
  • Только ребра – фильтр будет применен только к ребрам.

  • И соединения, и ребраФильтр будут применен как к соединениям, так и к ребрам. Это значение по умолчанию
  • Только соединенияФильтр будет применен только к соединениям.
  • Только ребраФильтр будет применен только к ребрам.
String
Фильтр по сетевому атрибуту битового множества
(Дополнительный)

Имя атрибута сети, который может быть использован для фильтрации по битовому множеству. Этот параметр применяется только для трассировки типа вверх против течения, вниз по течению и петли. Этот параметр может быть использован для добавления специальной логики во время трассировки, чтобы трассировка могла полнее отражать сценарии реального мира. Например, при трассировке петель атрибут сети Текущие фазы может определить, является ли петля истинной электрической петлей (та же фаза проходит вдоль всей петли, то есть А) и возвратить для результатов трассировки только реальные электрические петли. Пример трассировки вверх против течения: при трассировке сети электрического распределения, указав атрибут сети Текущие фазы, вы получите в качестве результатов трассировки только корректные пути, которые указаны в атрибуте сети, а не все пути.

String
Фильтр по ближайшему
(Дополнительный)

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

  • Отмечено – алгоритм K ближайших соседей будет использоваться для возврата объектов в количестве, как указано в параметрах Количество, Стоимость атрибута сети, Категории ближайших или Группы/Типы ближайшего оборудования.
  • Не отмечено – Алгоритм K-ближайших соседей не будет использоваться для фильтрации результатов. Это значение по умолчанию

Boolean
Количество
(Дополнительный)

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

Long
Стоимость атрибута сети
(Дополнительный)

Числовой атрибут сети, который будет использоваться для вычисления степени близости, стоимости или расстояния при включенной опции Фильтр по ближайшему – например, длина объекта.

String
Категории ближайших
(Дополнительный)

Возвращаемые категории, когда включена опция Фильтр по ближайшему, например – Protective.

String
Группы/Типы ближайшего оборудования
(Дополнительный)

Группы оборудования и типы оборудования, возвращаемые при включенной опции Фильтр по ближайшему, например – ElectricDistributionDevice/Transformer/Step Down.

String
Распространители
(Дополнительный)
  • РавноАтрибут равен значению.
  • Не равноАтрибут не равен значению.
  • БольшеАтрибут больше значения.
  • Больше или равноАтрибут больше или равен значению.
  • МеньшеАтрибут меньше значения.
  • Меньше или равноАтрибут меньше или равен значению.
  • Включает значения (побитовый AND равен значению)Побитовая операция AND, где все биты в значении присутствуют в атрибуте (побитовый AND == значение).
  • Не включает значения (побитовый AND не равен значению)Побитовая операция AND, где не все биты в значении присутствуют в атрибуте (побитовый AND != значение).
  • Включает все (побитовый AND равен True)Побитовая операция AND, в которой хотя бы один бит в значении присутствует в атрибуте (побитовый AND == True).
  • Не включает ничего (побитовый AND равен False)Побитовая операция AND, где ни один из битов в значении не присутствует в атрибуте (побитовый AND == False).
Value Table
Описание
(Дополнительный)

Описание правила.

String
Разрешение неопределенного потока
(Дополнительный)

Определяет, будет ли выполняться трассировка объектов с неопределенным или неинициализированным потоком. Этот параметр используется только при запуске трассировки вверх или вниз по течению в сети трассировки.

  • Отмечено — в трассировку будут включаться объекты с неопределенным или неинициализированным направлением потока.
  • Не отмечено — в трассировку не будут включаться объекты с неопределенным или неинициализированным направлением потока. Это значение по умолчанию

Boolean
Направление пути
(Дополнительный)

Определяет направление пути в сети трассировки. Стоимость прохождения пути определяется на основе атрибута сети, заданного в параметре Имя атрибута кратчайшего пути сети. Этот параметр используется только при запуске трассировки типа Кратчайший путь.

  • NO_DIRECTIONПуть будет проходить между двумя начальными точками независимо от направления потока. Это значение по умолчанию
  • PATH_UPSTREAMНаправление пути - вниз по течению между двумя начальными точками.
  • PATH_DOWNSTREAMНаправление пути - вверх по течению между двумя начальными точками.
String
Имя сетевого атрибута кратчайшего пути
(Дополнительный)

Атрибут сети, который будет использоваться для вычисления пути в инженерной сети или сети трассировки. При запуске трассировки типа кратчайший путь, кратчайший путь вычисляется с помощью числового атрибута сети, такого как Длина объекта. Могут быть вычислены пути как на основе стоимости, так и на основе расстояния. Этот параметр является обязательным при запуске трассировки кратчайшего пути.

String

Производные выходные данные

ПодписьОписаниеТип данных
Выходная сеть

Обновленная инженерная сеть или сеть трассировки.

Utility Network; Trace Network
Выходной шаблон схемы

Имя шаблона схемы.

String

arcpy.nd.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})
ИмяОписаниеТип данных
in_utility_network

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

Utility Network; Trace Network
template_name

Имя шаблона схемы, который будет изменяться.

String
is_active

Указывает, будет ли правило включено при создании и обновлении схем на основе указанного шаблона:

  • ACTIVEДобавляемое правило будет включено во время создания и обновления любых схем на основе входного шаблона. Это значение по умолчанию
  • INACTIVEДобавляемое правило не будет включено во время создания и обновления любых схем на основе входного шаблона.
Boolean
trace_type

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

  • CONNECTEDСоединенная трассировка будет запускаться из элементов инженерной сети или сети трассировки, в данный момент представленных в схеме, когда правило запускается и распространяется вдоль соединенных элементов. Это значение по умолчанию
  • SUBNETWORKТрассировка подсети будет запускаться от элементов инженерной сети, в данный момент представленных в схеме, когда правило запускается и распространяется вдоль соединенных объектов для поиска источников или приемников, из которых она распространяется дальше, вдоль связанной подсети.
  • UPSTREAMТрассировка вверх по течению будет запускаться от элементов инженерной сети или сети трассировки, в данный момент представленных в схеме, когда правило запускается для обнаружения элементов вверх по течению.
  • DOWNSTREAMТрассировка вниз по течению будет запускаться из элементов инженерной сети или сети трассировки, в данный момент представленных в схеме, когда правило запускается для обнаружения объектов вниз по течению.
  • SHORTEST_PATHТрассировка кратчайшего пути будет выполняться от объектов инженерной сети или сети трассировки, в данный момент указанных в схеме как начальные точки, когда правило начинает исследовать объекты вдоль кратчайшего пути между этими начальными точками. Стоимость прохождения пути определяется на основе сетевого атрибута, заданного для значения параметра path_network_weight_name, независимо от направления потока.
String
domain_network
(Дополнительный)

Имя специализированной сети, где будет выполняться трассировка для инженерной сети. Этот параметр требуется при запуске трассировки подсети, трассировки вверх и вниз по течению.

String
tier
(Дополнительный)

Имя уровня, где будет выполняться начало трассировки инженерной сети. Этот параметр является дополнительным, когда запускается тип трассировки Связанное; он является обязательным при запуске типов трассировки Посети, Вверх по течению и Вниз по течению.

String
target_tier
(Дополнительный)

Имя целевого уровня, в сторону которого будет перетекать входной уровень инженерной сети. Если для трассировок вверх и вниз по течению этот параметр отсутствует, то эти трассировки будут остановлены, когда они достигнут границы начальной подсети. Данный параметр используется для того, чтобы эти трассировки могли быть продолжены далее, либо вверх, либо вниз по иерархии.

String
include_structures
(Дополнительный)

Определяет, будут ли структурные объекты и другие объекты включены в результаты трассировки.

  • INCLUDE_STRUCTURESСтруктурные объекты и другие объекты будут включены в результаты трассировки.
  • EXCLUDE_STRUCTURESСтруктурные объекты и другие объекты не будут включаться в результаты трассировки. Это значение по умолчанию
Boolean
include_barriers
(Дополнительный)

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

  • INCLUDE_BARRIERSОбъекты барьеров проходимости будут включаться в результаты трассировки. Это значение по умолчанию
  • EXCLUDE_BARRIERSОбъекты барьеров проходимости не будут включаться в результаты трассировки.
Boolean
condition_barriers
[[Name, Operator, Type, Value, Combine Using],...]
(Дополнительный)

Задает условия проходимости барьеров в объекте на основании сравнения с сетевым атрибутом или проверки строки категории. Барьер условия использует атрибут сети, оператор и тип, а также значение атрибута. Например, остановите трассировку, если атрибут Device Status объекта равен определенному значению Open. Если объект удовлетворяет этому условию, трассировка остановится. При использовании более одного атрибута, можно применить параметр Комбинировать использование, чтобы задать условие И или Или.

Компоненты барьеров условий следующие:

  • Name – фильтрация по любому из атрибутов сети, определенному в системе.
  • Operator – выбрать из нескольких различных операторов.
  • name – выбрать определенное значение или сетевой атрибут из значения, которое задано в параметре Type.
  • Value – задать определенное значение для типа входного атрибута, которое может вызвать прерывание на основании значения оператора.
  • Combine Using– задайте это значение, если собираетесь добавить несколько атрибутов. Их можно комбинировать при помощи условий И или ИЛИ.

Опции значения operator барьеров условий следующие:

  • IS_EQUAL_TOАтрибут равен значению.
  • DOES_NOT_EQUALАтрибут не равен значению.
  • IS_GREATER_THANАтрибут больше значения.
  • IS_GREATER_THAN_OR_EQUAL_TOАтрибут больше или равен значению.
  • IS_LESS_THANАтрибут меньше значения.
  • IS_LESS_THAN_OR_EQUAL_TOАтрибут меньше или равен значению.
  • INCLUDES_THE_VALUESПобитовая операция AND, где все биты в значении присутствуют в атрибуте (побитовый AND == значение).
  • DOES_NOT_INCLUDE_THE_VALUESПобитовая операция AND, где не все биты в значении присутствуют в атрибуте (побитовый AND != значение).
  • INCLUDES_ANYПобитовая операция AND, в которой хотя бы один бит в значении присутствует в атрибуте (побитовый AND == True).
  • DOES_NOT_INCLUDE_ANYПобитовая операция AND, где ни один из битов в значении не присутствует в атрибуте (побитовый AND == False).

Более подробно о побитовых операторах

Опции значения Type барьеров условий следующие:

  • SPECIFIC_VALUEФильтр по заданному значению.
  • NETWORK_ATTRIBUTEФильтр по сетевому атрибуту.

Опции значения Combine Using барьеров условий следующие:

  • ANDКомбинировать барьеры условий.
  • ORИспользовать, если встречается любой из барьеров условий.
Value Table
function_barriers
[[Function, Attribute, Operator, Value, Use Local Values],...]
(Дополнительный)

Задает барьер проходимости на объектах на основе функции. Барьеры функций можно применять для ограничения того, насколько далеко трассировка может уйти от начальной точки, или установки максимального значения, при котором трассировка остановится. Например, длина каждой пройденной линии добавляется к общему пройденному на данный момент расстоянию. Когда общая пройденная длина достигнет указанного значения, трассировка остановится.

Компоненты барьеров функции следующие:

  • Function – выбрать среди различных функций вычисления.
  • Attribute – фильтрация по любому из атрибутов сети, определенному в системе.
  • Operator – выбрать из нескольких различных операторов.
  • Value – указать определенное значение для типа входного атрибута, которое вызовет прекращение трассировки, если будет обнаружено.
  • Use Local Values – вычислить значения в каждом направлении, в противоположность общему глобальному значению. Например, барьер функций, который вычисляет сумму Длин объектов, при которой трассировка прекращается, если достигнуто значение, большее или равное 4. В общем, после того, как вы пройдете два ребра со значением 2, сумма длин объектов станет равна 4, и поэтому трассировка будет прекращена. Если используются локальные значения, изменяются локальные значения вдоль каждого пути, и трассировка продолжается дальше.

Опции значения Function барьеров функций следующие:

  • AVERAGEБудет использовано среднее входных значений.
  • COUNTБудет использоваться число объектов.
  • MAXБудет использоваться максимальное из входных значений.
  • MINБудет использоваться минимальное из входных значений.
  • ADDБудет использоваться сумма значений.
  • SUBTRACTБудет использоваться разность значений. Контроллеры подсети и циклические трассировки не поддерживаются функцией вычитания.

Опции значения Operator барьеров функций следующие:

  • IS_EQUAL_TOАтрибут равен значению.
  • DOES_NOT_EQUALАтрибут не равен значению.
  • IS_GREATER_THANАтрибут больше значения.
  • IS_GREATER_THAN_OR_EQUAL_TOАтрибут больше или равен значению.
  • IS_LESS_THANАтрибут меньше значения.
  • IS_LESS_THAN_OR_EQUAL_TOАтрибут меньше или равен значению.
  • INCLUDES_THE_VALUESПобитовая операция AND, где все биты в значении присутствуют в атрибуте (побитовый AND == значение).
  • DOES_NOT_INCLUDE_THE_VALUESПобитовая операция AND, где не все биты в значении присутствуют в атрибуте (побитовый AND != значение).
  • INCLUDES_ANYПобитовая операция AND, в которой хотя бы один бит в значении присутствует в атрибуте (побитовый AND == True).
  • DOES_NOT_INCLUDE_ANYПобитовая операция AND, где ни один из битов в значении не присутствует в атрибуте (побитовый AND == False).

Более подробно о побитовых операторах

Опции барьера функции Use Local Values следующие:

  • TRUEБудут использоваться локальные значения.
  • FALSEБудут использоваться глобальные значения. Это значение по умолчанию
Value Table
traversability_scope
(Дополнительный)

Тип проходимости для применения. Область проходимости определяет, будут ли применены настройки проходимости для соединений, ребер или для обоих. Например, если задан барьер условия, который должен прекращать трассировку в случае, когда Статус устройства равен значению Открыто, и область действия проходимости задана только для ребер, то даже в случае, если эта трассировка обнаружит открытое устройство, она не будет прекращена, поскольку Статус устройства применяется только к соединениям. Другими словами, этот параметр указывает трассировке, следует ли игнорировать ребра, соединения, или и то и другое.

  • BOTH_JUNCTIONS_AND_EDGESПроходимость будет применима как к соединениям, так и к ребрам. Это значение по умолчанию
  • JUNCTIONS_ONLYПроходимость будет применена только к соединениям.
  • EDGES_ONLYПроходимость будет применена только к ребрам.
String
filter_barriers
[[Name, Operator, Type, Value, Combine Using],...]
(Дополнительный)

Определяет, когда должна быть прекращена трассировка для определенной категории или атрибута сети. Например, остановить трассировку на объектах, имеющих атрибут статуса жизненного цикла, равный заданному значению. Этот параметр используется для задания ограничителя на основе значения атрибута сети, определенного в системе. Если используется более одного атрибута, можно использовать опцию Combine Using, чтобы задать условие И или Или.

Компоненты барьеров фильтра следующие:

  • Name – фильтрация по категории или любому сетевому атрибуту, заданному в системе.
  • Operator – выбрать из нескольких различных операторов.
  • name – выбрать определенное значение или сетевой атрибут из значения, которое задано в параметре Type.
  • Value – указать определенное значение типа входного атрибута, которое может вызвать прекращение трассировки на основании значения оператора.
  • Combine Using– задайте это значение, если собираетесь добавить несколько атрибутов. Их можно комбинировать при помощи условий И или ИЛИ.

Опции значения Operator барьеров фильтра следующие:

  • IS_EQUAL_TOАтрибут равен значению.
  • DOES_NOT_EQUALАтрибут не равен значению.
  • IS_GREATER_THANАтрибут больше значения.
  • IS_GREATER_THAN_OR_EQUAL_TOАтрибут больше или равен значению.
  • IS_LESS_THANАтрибут меньше значения.
  • IS_LESS_THAN_OR_EQUAL_TOАтрибут меньше или равен значению.
  • INCLUDES_THE_VALUESПобитовая операция AND, где все биты в значении присутствуют в атрибуте (побитовый AND == значение).
  • DOES_NOT_INCLUDE_THE_VALUESПобитовая операция AND, где не все биты в значении присутствуют в атрибуте (побитовый AND != значение).
  • INCLUDES_ANYПобитовая операция AND, в которой хотя бы один бит в значении присутствует в атрибуте (побитовый AND == True).
  • DOES_NOT_INLCUDE_ANYПобитовая операция AND, где ни один из битов в значении не присутствует в атрибуте (побитовый AND == False).

Более подробно о побитовых операторах

Опции значения Type барьеров фильтра следующие:

  • SPECIFIC_VALUEФильтр по заданному значению.
  • NETWORK_ATTRIBUTEФильтр по сетевому атрибуту.

Опции значения Combine Using барьеров фильтра следующие:

  • ANDКомбинировать барьеры условий.
  • ORИспользовать, если встречается любой из барьеров условий.
Value Table
filter_function_barriers
[[Function, Attribute, Operator, Value, Use Local Values],...]
(Дополнительный)

Фильтрует результаты трассировки на определенную категорию.

Компоненты барьеров функции фильтра следующие:

  • Function – выбрать среди различных функций вычисления.
  • Attribute – фильтрация по любому из атрибутов сети, определенному в системе.
  • Operator – выбрать из нескольких различных операторов.
  • Value – указать определенное значение для типа входного атрибута, которое вызовет прекращение трассировки, если будет обнаружено.
  • Use Local Values – вычислить значения в каждом направлении, в противоположность общему глобальному значению. Например, барьер функций вычисляет сумму длин объектов, при которой трассировка прекращается, если достигнуто значение, большее или равное 4. В общем, после того, как вы пройдете два ребра со значением 2, сумма длин объектов станет равна 4, и поэтому трассировка будет прекращена. Когда используются локальные значения, изменятся локальные значения вдоль каждого пути, или трассировка будет продолжена.

Опции значения Function барьеров функций фильтра следующие:

  • AVERAGEБудет использовано среднее входных значений.
  • COUNTБудет использоваться число объектов.
  • MAXБудет использоваться максимальное из входных значений.
  • MINБудет использоваться минимальное из входных значений.
  • ADDБудет использоваться сумма значений.
  • SUBTRACTБудет использоваться разность значений. Контроллеры подсети и циклические трассировки не поддерживаются функцией вычитания.

Опции значения Operator барьеров функций фильтра следующие:

  • IS_EQUAL_TOАтрибут равен значению.
  • DOES_NOT_EQUALАтрибут не равен значению.
  • IS_GREATER_THANАтрибут больше значения.
  • IS_GREATER_THAN_OR_EQUAL_TOАтрибут больше или равен значению.
  • IS_LESS_THANАтрибут меньше значения.
  • IS_LESS_THAN_OR_EQUAL_TOАтрибут меньше или равен значению.
  • INCLUDES_THE_VALUESПобитовая операция AND, где все биты в значении присутствуют в атрибуте (побитовый AND == значение).
  • DOES_NOT_INCLUDE_THE_VALUESПобитовая операция AND, где не все биты в значении присутствуют в атрибуте (побитовый AND != значение).
  • INCLUDES_ANYПобитовая операция AND, в которой хотя бы один бит в значении присутствует в атрибуте (побитовый AND == True).
  • DOES_NOT_INCLUDE_ANYПобитовая операция AND, где ни один из битов в значении не присутствует в атрибуте (побитовый AND == False).

Более подробно о побитовых операторах

Опции барьеров функций фильтра Use Local Values следующие:

  • TRUEБудут использоваться локальные значения.
  • FALSEБудут использоваться глобальные значения. Это значение по умолчанию
Value Table
filter_scope
(Дополнительный)

Определяет, будет ли фильтр для определенной категории применяться к соединениям, ребрам или ко всем. Например, если фильтр барьера задан для остановки трассировки, если Состояние устройства - Открыто, а для области проходимости задано «только ребра», трассировка не остановится, даже если обнаружит открытое устройство, так как Статус устройства применим только к соединениям. Другими словами, этот параметр указывает трассировке, следует ли игнорировать ребра, соединения, или и то и другое.

  • BOTH_JUNCTIONS_AND_EDGESФильтр будут применен как к соединениям, так и к ребрам. Это значение по умолчанию
  • JUNCTIONS_ONLYФильтр будет применен только к соединениям.
  • EDGES_ONLYФильтр будет применен только к ребрам.
String
filter_bitset_network_attribute_name
(Дополнительный)

Имя атрибута сети, который может быть использован для фильтрации по битовому множеству. Этот параметр применяется только для трассировки типа вверх против течения, вниз по течению и петли. Этот параметр может быть использован для добавления специальной логики во время трассировки, чтобы трассировка могла полнее отражать сценарии реального мира. Например, при трассировке петель атрибут сети Текущие фазы может определить, является ли петля истинной электрической петлей (та же фаза проходит вдоль всей петли, то есть А) и возвратить для результатов трассировки только реальные электрические петли. Пример трассировки вверх против течения: при трассировке сети электрического распределения, указав атрибут сети Текущие фазы, вы получите в качестве результатов трассировки только корректные пути, которые указаны в атрибуте сети, а не все пути.

String
filter_nearest
(Дополнительный)

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

  • FILTER_BY_NEARESTАлгоритм K ближайших соседей будет использоваться для возврата объектов в количестве, указанном в параметрах nearest_count, nearest_cost_network_attribute, nearest_categories или nearest_assets.
  • DO_NOT_FILTERАлгоритм K-ближайших соседей не будет использоваться для фильтрации результатов. Это значение по умолчанию
Boolean
nearest_count
(Дополнительный)

Число объектов, возвращенных, когда filter_nearestFILTER_BY_NEAREST.

Long
nearest_cost_network_attribute
(Дополнительный)

Числовой атрибут сети, который будет использоваться для вычисления степени близости, стоимости или расстояния, когда filter_nearestFILTER_BY_NEAREST, например, длина объекта.

String
nearest_categories
[nearest_categories,...]
(Дополнительный)

Возвращаемые категории, когда для опции filter_nearest задано FILTER_BY_NEAREST, например, Protective.

String
nearest_assets
[nearest_assets,...]
(Дополнительный)

Группы оборудования и типы оборудования, возвращаемые, когда filter_nearestFILTER_BY_NEAREST, например, ElectricDistributionDevice/Transformer/Step Down.

String
propagators
[[Attribute, Substitution Attribute, Function, Operator, Value],...]
(Дополнительный)

Указывает сетевые атрибуты для распространения, а также то, как это распространение будет происходить во время трассировки. Класс распространяющихся атрибутов определяет ключевое значение для контроллеров подсети, которое будет распределено по остальным объектам подсети. Например, в модели электрической сети вы можете распространить значение фазы.

Используются следующие компоненты распространения:

  • Attribute - фильтр по любому сетевому атрибуту, заданному в системе.
  • Substitution Attribute - использовать заменяющее значение вместо битового множества атрибутов сети. Замены являются кодированными на основании числа битов в передаваемом сетевом атрибуте. Замена - это сопоставление каждого бита по фазе другого бита. Например, для Фазы AC, одна замена сопоставляет бит A с B, а C с null. В этом примере замена 1010 (Фаза AC) дает 0000-0010-0000-0000 (512). Замена захватывает сопоставление, т.ч. вы знаете, что Фаза A была сопоставлена с B, а Фаза C с null, а не иначе (например, Фаза A не сопоставлялась с null, а Фаза C не сопоставлялась с B).
  • Function - выбрать среди различных функций вычисления.
  • Operator - выбрать среди различных операторов.
  • Value - задайте определенное значение для типа входного атрибута, которое может вызвать прерывание на основании значения оператора.

Опции значения Function распространителей следующие:

  • PROPAGATED_BITWISE_ANDЗначения будут сравниваться - от текущего объекта к следующему.
  • PROPAGATED_MINБудет распространено минимальное значение.
  • PROPAGATED_MAXБудет распространено максимальное значение.

Опции значения Operator распространителей следующие:

  • IS_EQUAL_TOАтрибут равен значению.
  • DOES_NOT_EQUALАтрибут не равен значению.
  • IS_GREATER_THANАтрибут больше значения.
  • IS_GREATER_THAN_OR_EQUAL_TOАтрибут больше или равен значению.
  • IS_LESS_THANАтрибут меньше значения.
  • IS_LESS_THAN_OR_EQUAL_TOАтрибут меньше или равен значению.
  • INCLUDES_THE_VALUESПобитовая операция AND, где все биты в значении присутствуют в атрибуте (побитовый AND == значение).
  • DOES_NOT_INCLUDE_THE_VALUESПобитовая операция AND, где не все биты в значении присутствуют в атрибуте (побитовый AND != значение).
  • INCLUDES_ANYПобитовая операция AND, в которой хотя бы один бит в значении присутствует в атрибуте (побитовый AND == True).
  • DOES_NOT_INCLUDE_ANYПобитовая операция AND, где ни один из битов в значении не присутствует в атрибуте (побитовый AND == False).

Более подробно о побитовых операторах

Примечание:

Этот параметр доступен только в Python.

Value Table
description
(Дополнительный)

Описание правила.

String
allow_indeterminate_flow
(Дополнительный)

Определяет, будет ли выполняться трассировка объектов с неопределенным или неинициализированным потоком. Этот параметр используется только при запуске трассировки вверх или вниз по течению.

  • TRACE_INDETERMINATE_FLOWВ трассировку будут включаться объекты с неопределенным или неинициализированным направлением
  • IGNORE_INDETERMINATE_FLOWВ трассировку не будут включаться объекты с неопределенным или неинициализированным направлением потока. Это значение по умолчанию
Boolean
path_direction
(Дополнительный)

Определяет направление пути в сети трассировки. Стоимость прохождения пути определяется на основе значения параметра path_network_weight_name. Этот параметр учитывается только при запуске трассировки типа SHORTEST_PATH.

  • NO_DIRECTIONПуть будет проходить между двумя начальными точками независимо от направления потока. Это значение по умолчанию
  • PATH_UPSTREAMНаправление пути - вниз по течению между двумя начальными точками.
  • PATH_DOWNSTREAMНаправление пути - вверх по течению между двумя начальными точками.
String
path_network_weight_name
(Дополнительный)

Атрибут сети, который будет использоваться для вычисления пути в инженерной сети или сети трассировки. При запуске трассировки типа кратчайший путь, кратчайший путь вычисляется с помощью числового атрибута сети, такого как Длина объекта. Могут быть вычислены пути как на основе стоимости, так и на основе расстояния. Этот параметр является обязательным при запуске трассировки кратчайшего пути.

String

Производные выходные данные

ИмяОписаниеТип данных
out_utility_network

Обновленная инженерная сеть или сеть трассировки.

Utility Network; Trace Network
out_template_name

Имя шаблона схемы.

String

Пример кода

AddTraceRule, пример (окно Python)

Добавляет правило Трассировки в шаблон MyTemplate1, существующий в заданной инженерной сети, для построения схем на основе трассировки подсетей с уровнем Medium Voltage в домене ElectricDistribution.

import arcpy
input_Network = "D:/MyProjectLocation/MyDatabaseConnection.sde/MyDatabase.MAP.Electric/MyDatabase.MAP.Electric"
input_DiagramTemplate = "MyTemplate1"

arcpy.nd.AddTraceRule(input_Network, input_DiagramTemplate, "ACTIVE", 
                      "SUBNETWORK", "ElectricDistribution", "Medium Voltage", 
                      "Low Voltage Mesh")

Параметры среды

Этот инструмент не использует параметры среды геообработки

Информация о лицензиях

  • Basic: Нет
  • Standard: Да
  • Advanced: Да

Связанные разделы