Disponible con una licencia Standard o Advanced.
Resumen
Crea una configuración de trazado de red en la red de servicios.
Las configuraciones de trazado de red le permiten configurar y almacenar las propiedades de trazados complejos para su reutilización y uso compartido. Las configuraciones de trazado de red almacenadas en una red de servicios se pueden cargar y ejecutar desde la herramienta Trazado o compartir para que las consuma un mapa web o una aplicación de campo.
Más información sobre cómo agregar una configuración de trazado de red
Uso
La Red de servicios de entrada debe ser una versión 5 o posterior.
Al trabajar con una geodatabase corporativa, la red de servicios de entrada debe proceder de un servicio de la red de servicios.
La cuenta del portal conectada se define como la creadora de la configuración del trazado de red.
La autenticación del sistema operativo se utiliza para almacenar el creador de una configuración de trazado cuando se trabaja con una red de servicios en una geodatabase de archivos.
Sintaxis
arcpy.un.AddTraceConfiguration(in_utility_network, trace_config_name, trace_type, {description}, {tags}, {domain_network}, {tier}, {target_tier}, {subnetwork_name}, {shortest_path_network_attribute_name}, {include_containers}, {include_content}, {include_structures}, {include_barriers}, {validate_consistency}, {condition_barriers}, {function_barriers}, {traversability_scope}, {filter_barriers}, {filter_function_barriers}, {filter_scope}, {filter_bitset_network_attribute_name}, {filter_nearest}, {nearest_count}, {nearest_cost_network_attribute}, {nearest_categories}, {nearest_assets}, {functions}, {propagators}, {output_assettypes}, {output_conditions}, {include_isolated_features}, {ignore_barriers_at_starting_points}, {include_up_to_first_spatial_container}, {result_types}, {allow_indeterminate_flow}, {validate_locatability})
Parámetro | Explicación | Tipo de datos |
in_utility_network | La red de servicios que contendrá la nueva configuración de trazado de red. | Utility Network; Utility Network Layer |
trace_config_name | El nombre de la configuración del trazado de red. | String |
trace_type | Especifica el tipo de trazado de red que se configurará.
| String |
description (Opcional) | La descripción de la configuración del trazado de red. | String |
tags [tags,...] (Opcional) | Un conjunto de etiquetas utilizadas para identificar la configuración del trazado de red. Las etiquetas se pueden utilizar en búsquedas e indexación. | String |
domain_network (Opcional) | El nombre de la red de dominio en la que se ejecutará el trazado. Este parámetro es obligatorio para ejecutar los tipos de trazado de subred, controladores de subred, aguas arriba y aguas abajo. | String |
tier (Opcional) | El nombre del nivel para iniciar el rastreo. Este parámetro es obligatorio para ejecutar los tipos de trazado de subred, controladores de subred, aguas arriba y aguas abajo. | String |
target_tier (Opcional) | El nombre del nivel de destino hacia el que fluye el nivel de entrada. Si este parámetro está presente en los trazados aguas arriba y aguas abajo, estos rastreos se detienen tan pronto como alcanzan el límite de la subred de partida. Este parámetro puede usarse para permitir que estos trazados continúen, ya sea más arriba o más abajo en la jerarquía. | String |
subnetwork_name (Opcional) | El nombre de la subred en la que se ejecutará el rastreo. Este parámetro puede usarse al ejecutar un tipo de trazado de subred. Si se especifica un nombre de subred, no se requiere el parámetro Puntos de partida (el parámetro starting_points en Python). | String |
shortest_path_network_attribute_name (Opcional) | El atributo de red utilizado para calcular la ruta más corta. Al ejecutar el tipo de trazado de ruta más corta, la ruta más corta se calcula utilizando un atributo de red, por ejemplo, la longitud de forma. Es posible conseguir rutas basadas tanto en el coste como en la distancia. Este parámetro es obligatorio si se ejecuta un trazado de ruta más corta. | String |
include_containers (Opcional) | Especifica si las entidades de contenedor se incluirán en los resultados del trazado.
| Boolean |
include_content (Opcional) | Especifica si el trazado devolverá el contenido de los contenedores como parte de los resultados.
| Boolean |
include_structures (Opcional) | Especifica si las entidades de estructura y objetos se incluirán en los resultados del trazado.
| Boolean |
include_barriers (Opcional) | Especifica si las entidades de barrera de transitabilidad se incluirán en los resultados del trazado. Las barreras de transitabilidad son opcionales incluso si se han predefinido en la definición de subred. Este parámetro no se aplica a las entidades del dispositivo con terminales.
| Boolean |
validate_consistency (Opcional) | Especifica si se devuelve un error si se encuentran áreas sin validar en cualquiera de las entidades recorridas. Esta es la única forma de garantizar que un trazado pase por las entidades que presentan un estado coherente en la red. Para eliminar áreas sin validar, valide la topología de red.
| Boolean |
condition_barriers [[Name, Operator, Type, Value, Combine Using],...] (Opcional) | Define una condición de barrera de transitabilidad en entidades basadas en una comparación con un atributo de red o busque una cadena de categoría. Una barrera de condición utiliza un atributo de red, un operador y un tipo, y un valor de atributo. Por ejemplo, el trazado se detiene cuando una entidad tiene el atributo Device Status igual que el valor específico de Open. Cuando una entidad cumple esta condición, el seguimiento se detiene. Si está utilizando más de un atributo, puede usar el parámetro Combinar usando para definir una condición Y u O. Los componentes de condición de barrera son los siguientes:
Las opciones del valor operator de las barreras de condición son las siguientes:
Más información sobre los operadores bitwise Las opciones del valor Type de las barreras de condición son las siguientes:
Las opciones del valor Combine Using de las barreras de condición son las siguientes:
Más información sobre el uso de varias expresiones condicionales | Value Table |
function_barriers [[Function, Attribute, Operator, Value, Use Local Values],...] (Opcional) | Define una barrera de transitabilidad en entidades basadas en una función. Las barreras de función se pueden utilizar para hacer cosas como restringir cuánto se desplaza el seguimiento desde el punto de partida o definir un valor máximo en el que se detiene un seguimiento. Por ejemplo, la longitud de cada línea recorrida se suma a la distancia total recorrida hasta ese momento. Cuando la longitud total recorrida alcanza el valor especificado, el seguimiento se detiene. Los componentes de barrera de función son los siguientes:
Las opciones de valor de barrera de función de function son las siguientes:
Las opciones de valor de barrera de función de operator son las siguientes:
Más información sobre los operadores bitwise Las opciones de barrera de función de Use Local Values son las siguientes:
| Value Table |
traversability_scope (Opcional) | El tipo de transitabilidad que se va a aplicar. El alcance de la transitabilidad dicta si esta se aplica en los cruces, los ejes o en ambos. Por ejemplo, si se define que una condición de barrera detenga el seguimiento si Estado de dispositivo equivale a Abierto y el alcance de transitabilidad se establece solo en los ejes, el seguimiento no se detendrá, aunque se encuentre con un dispositivo abierto, porque Estado de dispositivo solo se aplica a los cruces. Es decir, este parámetro indica al trazado debe ignorar los cruces, ejes o ambos.
| String |
filter_barriers [[Name, Operator, Type, Value, Combine Using],...] (Opcional) | Especifica cuándo se detendrá un trazado con una categoría o un atributo de red específicos. Por ejemplo, el trazado se detiene en las entidades que presentan un atributo de estado de ciclo igual a un determinado valor. Este parámetro se utiliza para definir un terminador basado en un valor de un atributo de red que está definido en el sistema. Si está utilizando más de un atributo, puede usar la opción Combine Using para definir una condición Y u O. Los componentes de barrera de filtro son los siguientes:
Las opciones de valor de barrera de filtro de operator son las siguientes:
Más información sobre los operadores bitwise Las opciones de valor de barrera de filtro de Type son las siguientes:
Las opciones de valor de barrera de filtro de Combine Using son las siguientes:
Más información sobre el uso de varias expresiones condicionales | Value Table |
filter_function_barriers [[Function, Attribute, Operator, Value, Use Local Values],...] (Opcional) | Filtra los resultados del rastreo para una categoría específica. Los componentes de barrera de función de filtro son los siguientes:
Las opciones de valor de barrera de función de filtro de function son las siguientes:
Las opciones de valor de barrera de función de filtro de operator son las siguientes:
Más información sobre los operadores bitwise Las opciones de barrera de función de filtro de Use Local Values son las siguientes:
| Value Table |
filter_scope (Opcional) | Especifica si el filtro de una categoría específica se impondrá en los cruces, los ejes o ambos. Por ejemplo, si se define que una barrera de filtro detenga el trazado si Estado de dispositivo equivale a Abierto y el alcance de transitabilidad se establece solo en los ejes, el trazado no se detendrá aunque se encuentre con un dispositivo abierto porque Estado de dispositivo solo se aplica a los cruces. Es decir, este parámetro indica al trazado debe ignorar los cruces, ejes o ambos.
| String |
filter_bitset_network_attribute_name (Opcional) | El nombre del atributo de red que se usará para filtrar por conjunto de bits. Este parámetro solo es aplicable a los tipos de trazado de aguas arriba, aguas abajo y bucles. Este parámetro puede usarse para agregar una lógica especial durante un trazado, de modo que el trazado refleje más fielmente las situaciones reales. Por ejemplo, en un trazado de bucles, el atributo de red Fases actuales permite determinar si el bucle es un bucle eléctrico real (se alimenta la misma fase en todo el bucle, es decir, A) y devuelve solo los bucles eléctricos reales de los resultados del trazado de red. Un ejemplo de un trazado aguas arriba es que, durante el trazado de una red de distribución eléctrica, se especifica el atributo de red Fases actuales y el resultado del trazado solo contendrá las rutas válidas que se especifiquen en el atributo de red, no todas las rutas. | String |
filter_nearest (Opcional) | Especifica si el algoritmo k-vecinos más cercanos se usará para devolver un número de entidades de un tipo concreto dentro de una distancia determinada. Si se utiliza este parámetro, es posible especificar un recuento, un coste y una colección de categorías, además de un tipo de activos, o ambos.
| Boolean |
nearest_count (Opcional) | El número de entidades que se devolverán cuando filter_nearest sea FILTER_BY_NEAREST. | Long |
nearest_cost_network_attribute (Opcional) | El atributo de red numérico que se utilizará para calcular la cercanía, el coste o la distancia cuando filter_nearest sea FILTER_BY_NEAREST, por ejemplo, Shape length. | String |
nearest_categories [nearest_categories,...] (Opcional) | Las categorías que se devolverán cuando filter_nearest sea FILTER_BY_NEAREST, por ejemplo, Protective. | String |
nearest_assets [nearest_assets,...] (Opcional) | Los tipos y grupos de activos que se devolverán cuando filter_nearest sea FILTER_BY_NEAREST, por ejemplo, ElectricDistributionDevice/Transformer/Step Down. | String |
functions [[Function, Attribute, Filter Name, Filter Operator, Filter Type, Filter Value],...] (Opcional) | Aplica a función de cálculo al resultado del trazado. Los componentes de funciones son los siguientes:
Las opciones de valor de funciones de Function son las siguientes:
Por ejemplo, una entidad de punto de partida tiene un valor de 20. La siguiente entidad tiene el valor 30. Si está usando la función MINIMUM, el resultado es 20. MAXIMUM es 30, ADD es 50, AVERAGE es 25, COUNT es 2 y SUBTRACT es -10. Las opciones de valor de Filter Operator son las siguientes:
Más información sobre los operadores bitwise Las opciones de valor de funciones de Filter Type son las siguientes:
| Value Table |
propagators [[Attribute, Substitution Attribute, Function, Operator, Value],...] (Opcional) | Especifica qué atributos de red propagar y cómo se producirá dicha propagación durante un seguimiento. Los atributos de clase propagados indican los valores clave en controladores de subred que se difunden al resto de las entidades de la subred. Por ejemplo, en un modelo de distribución eléctrica, puede propagar el valor de fase. Los componentes propagadores son los siguientes:
Las opciones de valor de propagadores de function son las siguientes:
Las opciones de valor de propagadores de operator son las siguientes:
Más información sobre los operadores bitwise Nota:Este parámetro está disponible solo a través de Python. | Value Table |
output_assettypes [output_assettypes,...] (Opcional) | Filtra los tipos de activo de salida para su inclusión en el resultado, por ejemplo, devolver únicamente transformadores suspendidos. | String |
output_conditions [[Name, Operator, Type, Value, Combine Using],...] (Opcional) | Especifica los tipos de entidades que se devolverán en función de una categoría o atributo de red. Por ejemplo, en un trazado configurado para excluir todo excepto las entidades Toma, las entidades procesadas por el trazado que no tengan asignada la categoría Toma no se incluyen en el resultado. Las entidades procesadas por el trazado que sí la tengan se devuelven en el conjunto de selección de resultado. Si está utilizando más de un atributo, puede usar la opción Combine Using para definir una condición Y u O. Los componentes de condiciones de salida son los siguientes:
Las opciones del valor operator de las condiciones de salida son las siguientes:
Más información sobre los operadores bitwise Las opciones de valor de las condiciones de salida de Type son las siguientes:
Las opciones de valor de las condiciones de salida de Combine Using son las siguientes:
Más información sobre el uso de varias expresiones condicionales | Value Table |
include_isolated_features (Opcional) | Especifica si las entidades aisladas se incluirán en los resultados del trazado. Este parámetro solo se utiliza al ejecutar un trazado de red de aislamiento.
Nota:El tipo de trazado Aislamiento requiere ArcGIS Enterprise 10.7 o posterior si se utiliza una geodatabase corporativa. | Boolean |
ignore_barriers_at_starting_points (Opcional) | Especifica si las barreras dinámicas de la configuración de trazado se ignorarán en los puntos de partida. Puede resultar útil al realizar un trazado de un dispositivo de protección aguas arriba y al utilizar los dispositivos de protección descubiertos (barreras) como puntos de partida para buscar dispositivos de protección aguas arriba posteriores.
| Boolean |
include_up_to_first_spatial_container (Opcional) | Especifica si se van a limitar los contenedores devueltos solo a aquellos que se encuentren hasta el primer contenedor espacial, este incluido, para cada elemento de red en los resultados del trazado. Si no se encontraran contenedores espaciales sino contenedores no espaciales para un elemento de red determinado, todos los contenedores no espaciales se incluirán en los resultados. Este parámetro solo es aplicable cuando Include Containers está enabled.
| Boolean |
result_types [result_types,...] (Opcional) | Especifica el tipo de resultados que devuelve el trazado.
| String |
allow_indeterminate_flow (Opcional) | Especifica si se realizará un trazado de las entidades con flujo indeterminado. Este parámetro solo se respeta al ejecutar un trazado aguas arriba o aguas abajo.
| Boolean |
validate_locatability (Opcional) | Especifica si se devolverá un error si se encuentran objetos de cruce o eje no espaciales sin un contenedor o estructura asociados en la jerarquía de asociación de las entidades recorridas. Esta opción garantiza que los objetos no espaciales devueltos por un trazado de red estén asociados a entidades espaciales.
| Boolean |
Salida derivada
Nombre | Explicación | Tipo de datos |
out_utility_network | La red de servicios actualizada. | Red de servicios |
Muestra de código
El siguiente script de la ventana de Python muestra cómo utilizar la herramienta AddTraceConfiguration.
import arcpy
arcpy.AddTraceConfiguration_un(
r"SampleUNService\Elec Utility Network", "Upstream_RMT002", "UPSTREAM",
"Upstream trace on RMT002", "Upstream;RMT002", "ElectricDistribution",
"Medium Voltage", '', '', '', "EXCLUDE_CONTAINERS", "EXCLUDE_CONTENT",
"EXCLUDE_STRUCTURES", "INCLUDE_BARRIERS", "VALIDATE_CONSISTENCY", None,
None, "BOTH_JUNCTIONS_AND_EDGES", None, None, "BOTH_JUNCTIONS_AND_EDGES",
'', "DO_NOT_FILTER", None, '', None, None, None, None, None, None,
"EXCLUDE_ISOLATED_FEATURES", "DO_NOT_IGNORE_BARRIERS_AT_STARTING_POINTS",
"DO_NOT_INCLUDE_UP_TO_FIRST_SPATIAL_CONTAINER", None,
"TRACE_INDETERMINATE_FLOW", "DO_NOT_VALIDATE_LOCATABILITY")
Entornos
Información de licenciamiento
- Basic: No
- Standard: Sí
- Advanced: Sí