Имя | Описание | Тип данных |
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 – выбрать из нескольких различных операторов.
- Type – выбрать определенное значение или сетевой атрибут из значения, которое задано в параметре name.
- 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 – выбрать из нескольких различных операторов.
- Type – выбрать определенное значение или сетевой атрибут из значения, которое задано в параметре name.
- 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_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 |
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 |
use_trace_config (Дополнительный) | Указывает, будет ли использоваться существующая именованная конфигурация трассировки для определения свойств трассировки. Этот параметр доступен только для инженерной сети версии 7 и выше. - USE_TRACE_CONFIGURATION—Существующая именованная конфигурация трассировки будет использоваться для определения свойств трассировки.
- DO_NOT_USE_TRACE_CONFIGURATION—Существующая именованная конфигурация трассировки не будет использоваться для определения свойств трассировки. Это значение по умолчанию
| Boolean |
trace_config_name (Дополнительный) | Имя существующей именованной конфигурации трассировки, которое будет использоваться для определения свойств трассировки. Этот параметр включается только, когда параметр use_trace_config имеет значение USE_TRACE_CONFIGURATION. | String |
use_digitized_direction (Дополнительный) | Указывает, будут ли операции трассировки вверх и вниз по течению определять поток с использованием оцифрованного направления линии и атрибута Flow direction. Этот параметр доступен и активен только для инженерной сети версии 7 и более поздних версий, если для параметра trace_type задано значение UPSTREAM или DOWNSTREAM. - USE_DIGITIZED_DIRECTION—Операции трассировки будут определять направление потока, используя оцифрованное направление линии и атрибут направления потока. С помощью этой опции параметры domain_network, tier и target_tier игнорируются.
- IGNORE_DIGITIZED_DIRECTION—Операции трассировки будут определять направление потока на основе местоположения контроллеров подсети. Это значение по умолчанию
Для этого параметра требуется ArcGIS Enterprise 11.3 или более поздней версии, если используется многопользовательская база геоданных. | Boolean |