Resumen
Agrega una regla de diagrama para ejecutar automáticamente un trazado en una red de servicios o red de trazado durante la creación de diagramas a partir de una plantilla existente. Las entidades de red de trazado y objetos de red resultantes se utilizan para crear el contenido de diagrama.
Más información sobre cómo utilizar la regla trazado para crear diagramas
Precaución:
Esta herramienta es una herramienta de configuración y administración.
Nota:
Esta herramienta afecta a la coherencia de cualquier diagrama existente basado en la plantilla de diagrama de entrada. Todos los diagramas existentes se vuelven incoherentes y permanecen abiertos con un icono de advertencia de coherencia hasta que se actualicen.
Uso
Esta herramienta no se admite al trabajar con un servicio de red de servicios o red de trazado. Debe utilizar una red de servicios o red de trazado de una geodatabase de archivos o una conexión de base de datos a una red de servicios o red de trazado de una geodatabase corporativa. Al trabajar con una geodatabase corporativa, existen estos requisitos:
- El valor del parámetro Red de entrada debe provenir de una conexión de base de datos establecida como propietaria de la red de servicios de la base de datos o propietaria de la red de trazado de la base de datos.
- La cuenta del portal de ArcGIS Enterprise conectada debe ser la propietaria de la red de servicios del portal o la propietaria de la red de trazado del portal.
- Esta herramienta se debe conectar a la versión predeterminada, que se espera que sea pública y no protegida.
La regla Trazado se utiliza para ejecutar un trazado a partir de elementos de red de servicios o de red de trazado representados actualmente en un diagrama.
En función del tipo de trazado especificado, los puntos de inicio pueden o deben estar predefinidos en el diagrama para ejecutar la regla Trazado:
- Para los tipos de trazado Conectado, Subred, Aguas arriba y Aguas abajo, todos los elementos de red de servicios o de red de trazado representados en el diagrama cuando se inicia la regla Trazado se consideran los puntos de partida del trazado, a menos que se configure una regla Establecer punto de partida en la plantilla de diagrama para identificar claramente puntos de partida específicos de antemano.
- Para el tipo de trazado Ruta más corta, se deben configurar reglas Establecer punto de partida en la plantilla de diagrama para identificar los dos puntos de partida entre todos los elementos de red de trazado representados actualmente en el diagrama, entre las que se debe encontrar la ruta más corta.
Cuando configura una plantilla basada en una regla Trazado, el trazado se volverá a ejecutar sistemáticamente en la red de servicios o la red de trazado en cada actualización del diagrama. Esto significa que cualquier diagrama basado en esa plantilla reflejará siempre el resultado de seguimiento de redes actual cuando se actualice.
Sintaxis
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})
Parámetro | Explicación | Tipo de datos |
in_utility_network | La red de servicios o red de trazado que contiene la plantilla de diagrama que se desea modificar. | Utility Network; Trace Network |
template_name | El nombre de la plantilla de diagrama que se desea modificar. | String |
is_active | Especifica si la regla estará habilitada al generar y actualizar diagramas basándose en la plantilla especificada.
| Boolean |
trace_type | Especifica el tipo de trazado que la regla realizará para generar el contenido del diagrama.
| String |
domain_network (Opcional) | El nombre de la red de dominio en la que se ejecuta el trazado para una red de servicios. Este parámetro es obligatorio para ejecutar los tipos de trazado de subred, aguas arriba y aguas abajo. | String |
tier (Opcional) | El nombre del nivel en el que empieza el trazado para una red de servicios. Este parámetro es opcional al ejecutar el tipo de trazado conectado; es obligatorio para ejecutar los tipos de trazado 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 para una red de servicios. 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 |
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 |
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:
| 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 barrera de condición 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_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 se utiliza 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:
| 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 |
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 |
description (Opcional) | La descripción de la regla. | String |
allow_indeterminate_flow (Opcional) | Especifica si se realizará un trazado de las entidades de red de trazado que presentan un flujo indeterminado o no inicializado. Este parámetro solo se respeta al ejecutar un trazado de tipo aguas arriba o aguas abajo.
| Boolean |
path_direction (Opcional) | Especifica la dirección de la ruta de una red de trazado. El coste de recorrer la ruta se determina en base al valor establecido para el path_network_attribute_name. Este parámetro solo se respeta al ejecutar un trazado de tipo PATH.
| String |
path_network_weight_name (Opcional) | El atributo de red utilizado para calcular la ruta de una red de trazado. 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 |
Salida derivada
Nombre | Explicación | Tipo de datos |
out_utility_network | Red de servicios o red de trazado actualizada. | Red de servicios; red de trazado |
out_template_name | El nombre de la plantilla de diagrama. | Cadena |
Muestra de código
Agregar una regla trazado a la plantilla MyTemplate1 existente para una red determinada, con el fin de generar diagramas a partir del trazado de subredes dentro del nivel de media tensión del dominio ElectricDistribution.
import arcpy
input_Network = "D:/MyProjectLocation/MyDatabaseConnection.sde/MyDatabase.MAP.Electric/MyDatabase.MAP.Electric"
input_DiagramTemplate = "MyTemplate1"
arcpy.AddTraceRule_nd(input_Network, input_DiagramTemplate, "ACTIVE",
"SUBNETWORK", "ElectricDistribution", "Medium Voltage",
"Low Voltage Mesh")
Entornos
Información de licenciamiento
- Basic: No
- Standard: Sí
- Advanced: Sí