Имя | Описание | Тип данных |
in_utility_network | Инженерная сеть, которая будет содержать новую именованную конфигурацию трассировки. | Utility Network; Utility Network Layer |
trace_config_name | Имя конфигурации трассировки. | String |
trace_type | Задает тип настраиваемой трассировки. - CONNECTED—Будет использоваться подключенная трассировка, которая начинается в одной или нескольких начальных точек и распространяется наружу вдоль связанных объектов. Это значение по умолчанию
- SUBNETWORK—Будет использоваться трассировка подсети, которая начинается с одной или более начальных точек и разворачивается наружу, охватывая весь экстент подсети.
- SUBNETWORK_CONTROLLERS—Будет использоваться трассировка контроллеров подсети, которая определяет источники и приемники на контроллерах подсети, связанных с подсетью.
- UPSTREAM—Будет использоваться трассировка вверх по течению, которая обнаруживает объекты выше по течению от местоположения в сети.
- DOWNSTREAM—Будет использоваться трассировка вниз по течению, которая обнаруживает объекты ниже по течению от местоположения в сети.
- LOOPS—Петли - это районы сети, где направление потока не определено. Будет использоваться трассировка петель, которая разворачивается наружу от начальной точки на основе связности.
- SHORTEST_PATH—Будет использоваться трассировка кратчайшего пути, которая определяет кратчайший путь между двумя начальными точками.
- ISOLATION—Будет использоваться трассировка изоляции, которая находит объекты, изолирующие некоторую область сети.
| String |
description (Дополнительный) | Описание именованной конфигурации трассировки. | String |
tags [tags,...] (Дополнительный) | Набор тегов, используемых для идентификации именованной конфигурации трассировки. Теги могут использоваться в поиске и индексировании. | String |
domain_network (Дополнительный) | Имя специализированной сети, где будет выполняться трассировка. Этот параметр необходим для выполнения таких типов трассировки, как трассировка подсети, контроллеров подсети, а также вверх против течения и вниз по течению. | String |
tier (Дополнительный) | Имя уровня, в котором начинается трассировка. Этот параметр необходим для выполнения таких типов трассировки, как трассировка подсети, контроллеров подсети, а также вверх против течения и вниз по течению. | String |
target_tier (Дополнительный) | Имя целевого уровня, в сторону которого перетекает входной уровень. Если для трассировок вверх и вниз по течению этот параметр не указан, эти трассировки будут прекращены, когда они достигнут границы начальной подсети. Данный параметр используется для того, чтобы эти трассировки могли быть продолжены далее, либо вверх, либо вниз по иерархии. | String |
subnetwork_name (Дополнительный) | Имя подсети, где будет выполняться трассировка. Этот параметр можно использовать при запуске трассировки с типом трассировка подсети. Если указано имя подсети, то параметр starting_points не требуется. | String |
shortest_path_network_attribute_name (Дополнительный) | Имя атрибута сети, используемого для вычисления кратчайшего пути. При запуске трассировки типа кратчайший путь, кратчайший путь вычисляется с помощью числового атрибута сети, такого как Длина объекта. Могут быть вычислены пути как на основе стоимости, так и на основе расстояния. Этот параметр является обязательным при запуске трассировки кратчайшего пути. | String |
include_containers (Дополнительный) | Определяет, будут ли объекты-контейнеры включены в результаты трассировки. - INCLUDE_CONTAINERS—Объекты-контейнеры будут включены в результаты трассировки.
- EXCLUDE_CONTAINERS—Объекты-контейнеры не будут включаться в результаты трассировки. Это значение по умолчанию
| Boolean |
include_content (Дополнительный) | Определяет, будет ли трассировка возвращать содержание контейнеров в качестве результатов. - INCLUDE_CONTENT—Содержимое объектов-контейнеров будет включено в результаты трассировки.
- EXCLUDE_CONTENT—Содержимое объектов-контейнеров не будет включаться в результаты трассировки. Это значение по умолчанию
| Boolean |
include_structures (Дополнительный) | Определяет, будут ли структурные объекты и другие объекты включены в результаты трассировки. - INCLUDE_STRUCTURES—Структурные объекты и другие объекты будут включены в результаты трассировки.
- EXCLUDE_STRUCTURES—Структурные объекты и другие объекты не будут включаться в результаты трассировки. Это значение по умолчанию
| Boolean |
include_barriers (Дополнительный) | Определяет, будут ли объекты барьеров проходимости включаться в результаты трассировки. Включение барьеров проходимости является дополнительной опцией, даже если они представлены в определении подсети. Этот параметр не применяется к объектам-устройствам с терминалами. - INCLUDE_BARRIERS—Объекты барьеров проходимости будут включаться в результаты трассировки. Это значение по умолчанию
- EXCLUDE_BARRIERS—Объекты барьеров проходимости не будут включаться в результаты трассировки.
| Boolean |
validate_consistency (Дополнительный) | Определяет, будет ли возвращаться ошибка в случае обнаружения измененных областей для любого из пройденных объектов. Это единственный способ гарантировать, что трассировка проходит через объекты со статусом целостности в сети. Для удаления измененных областей проверьте топологию сети. - VALIDATE_CONSISTENCY—Трассировка возвратит ошибку в случае обнаружения измененных областей для любого из пройденных объектов. Это значение по умолчанию
- DO_NOT_VALIDATE_CONSISTENCY—Трассировка возвращает результаты независимо от обнаружения измененных областей для любых из пройденных объектов.
| 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 (Дополнительный) | Определяет, будет ли применяться проходимость к соединениям, ребрам или к тем и другим. Например, если условный барьер задан для остановки трассировки в случае, когда Device Status равно Open и область проходимости задано только по ребрам, трассировка не остановится, даже при обнаружении открытого устройства, поскольку Device Status применимо только к узлам. Другими словами, этот параметр указывает трассировке, следует ли игнорировать ребра, соединения, или и то и другое. - 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 |
functions [[Function, Attribute, Filter Name, Filter Operator, Filter Type, Filter Value],...] (Дополнительный) | Применяет функцию вычисления к результатам трассировки.
Компоненты функций следующие: - Function – выбрать среди различных функций вычисления.
- Attribute – фильтрация по любому из атрибутов сети, определенному в системе.
- Filter Name – фильтрация результатов функции по имени атрибута.
- Filter Operator – выбрать среди различных операторов.
- Filter Type – выбрать из различных типов фильтра.
- Filter Value – указать определенное значение входного атрибута фильтра.
Опции значения Function функций следующие: - AVERAGE—Будет рассчитано среднее входных значений.
- COUNT—Будет определено количество объектов.
- MAX—Будет определено максимальное из входных значений.
- MIN—Будет определено минимальное из входных значений.
- ADD—Будет рассчитана сумма значений.
- SUBTRACT—Будет рассчитана разность между значениями.Контроллеры подсети и циклические трассировки не поддерживаются функцией вычитания.
Например, имеется начальная точка со значением 20. Следующий объект имеет значение 30. Если вы используете функцию MINIMUM, результат равен 20, MAXIMUM – 30, ADD – 50, AVERAGE – 25, COUNT – 2 и SUBTRACT – -10. Опции значения Filter 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).
Более подробно о побитовых операторах Опции значения Filter Type функций следующие: - SPECIFIC_VALUE—Фильтр по заданному значению.
- NETWORK_ATTRIBUTE—Фильтр по сетевому атрибуту.
| Value Table |
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 |
output_assettypes [output_assettypes,...] (Дополнительный) | Отфильтруйте выходные типы оборудования, которые должны быть включены в результаты, например – только навесные трансформаторы. | String |
output_conditions [[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_INCLUDE_ANY—Побитовая операция AND, где ни один из битов в значении не присутствует в атрибуте (побитовый AND == False).
Более подробно о побитовых операторах Опции значения Type выходных условий следующие: - SPECIFIC_VALUE—Фильтр по заданному значению.
- NETWORK_ATTRIBUTE—Фильтр по сетевому атрибуту.
Опции значения Combine Using выходных условий следующие: - AND—Комбинировать условия.
- OR—Использовать, если выполняется любое из условий.
Более подробно об использовании множественных условных выражений | Value Table |
include_isolated_features (Дополнительный) | Определяет, будут ли изолированные объекты включаться в результаты трассировки. Этот параметр используется только при запуске трассировки изоляции. - INCLUDE_ISOLATED_FEATURES—Изолированные объекты будут включаться в результаты трассировки.
- EXCLUDE_ISOLATED_FEATURES—Изолированные объекты не будут включаться в результаты трассировки. Это значение по умолчанию
Для типа трассировки Изоляция требуется ArcGIS Enterprise 10.7 или более поздней версии, если используется многопользовательская база геоданных. | Boolean |
ignore_barriers_at_starting_points (Дополнительный) | Определяет, будут ли в конфигурации трассировки игнорироваться динамические барьеры для начальных точек. Это может быть полезным при выполнении трассировки защитных устройств в направлении вверх по течению с использованием обнаруженных защитных устройств (барьеров) в качестве начальных точек для поиска последующих защитных устройств выше по течению. - IGNORE_BARRIERS_AT_STARTING_POINTS—Барьеры в начальных точках будут проигнорированы при трассировке.
- DO_NOT_IGNORE_BARRIERS_AT_STARTING_POINTS—Барьеры в начальных точках не будут проигнорированы при трассировке. Это значение по умолчанию
| Boolean |
include_up_to_first_spatial_container (Дополнительный) | Указывает, будут ли в результатах трассировки среди возвращаемых только те контейнеры, которые встречались до первого пространственного контейнера, включая его самого, для каждого сетевого элемента. Если пространственные контейнеры не встречаются, но для данного элемента сети присутствуют не пространственные контейнеры, то все не пространственные контейнеры будут включены в результаты. Параметр доступен, когда Include Containers – INCLUDE_CONTAINERS. - INCLUDE_UP_TO_FIRST_SPATIAL_CONTAINER—Только контейнеры, встречающиеся до первого пространственного контейнера включительно, будут включены в результаты, если на пути трассировки встретятся вложенные связи содержания. Если пространственных контейнеров не существует, то все не пространственные контейнеры будут включены в результаты для данного элемента сети.
- DO_NOT_INCLUDE_UP_TO_FIRST_SPATIAL_CONTAINER—В результаты попадут все контейнеры. Это значение по умолчанию
| Boolean |
result_types [result_types,...] (Дополнительный) | Задает тип результатов, которые будет возвращать данная трассировка. - SELECTION—Результаты трассировки будут возвращаться в виде набора выборки соответствующих сетевых объектов. Это значение по умолчанию
- AGGREGATED_GEOMETRY—Результаты трассировки будут агрегированы по типу геометрии и сохранены в составных классах объектов, отображающихся в виде слоев активной карты.
| String |
allow_indeterminate_flow (Дополнительный) | Определяет, будут ли трассироваться объекты с неопределенным потоком. Этот параметр используется только при запуске трассировки вверх или вниз по течению, или для трассировки изолирования. - TRACE_INDETERMINATE_FLOW—Объекты с неопределенным потоком будут трассироваться . Это значение по умолчанию
- IGNORE_INDETERMINATE_FLOW—Объекты с неопределенным потоком будут останавливать трассировку и сами по себе трассироваться не будут.
| Boolean |
validate_locatability (Дополнительный) | Указывает, будет ли возвращена ошибка, если обнаружатся объекты непространственных соединений или ребер без связанного контейнера или структуры в иерархии связей для пройденных объектов. Этот параметр указывает на то, что непространственные объекты, возвращаемые трассировкой, связаны с пространственными объектами. - VALIDATE_LOCATABILITY—Трассировка возвратит ошибку, если обнаружатся объекты непространственных соединений или ребер без связанного контейнера или структуры в иерархии связей для пройденных объектов.
- DO_NOT_VALIDATE_LOCATABILITY—Не отмечено – Трассировка не будет выполнять проверку на наличие неразмещаемых объектов и возвратит результаты независимо от того, присутствуют ли неразмещаемые объекты в иерархии связей пройденных объектов или нет. Это значение по умолчанию
| Boolean |
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 |
synthesize_geometries (Дополнительный) | Указывает, будет ли выводиться и создаваться (синтезироваться) геометрия для ассоциаций и объектов ребер, проходимых в ходе операции трассировки. Этот параметр применим только для типа результатов Агрегированная геометрия. - DO_NOT_SYNTHESIZE_GEOMETRIES—Геометрии не будут синтезироваться для пройденных ассоциаций и объектов ребер. Это значение по умолчанию
- SYNTHESIZE_GEOMETRIES—Геометрия будет выведена и создана для пройденных ассоциаций и объектов ребер в выходном классе объектов Trace_Results_Aggregated_Lines.
Для этого параметра требуется ArcGIS Enterprise 11.3 или более поздней версии, если используется многопользовательская база геоданных. | Boolean |