Disponible avec une licence Standard ou Advanced.
Résumé
Crée une configuration de trace dans le réseau de distribution.
Les configurations de traces permettent de configurer et de stocker les propriétés de traces complexes à des fins de réutilisation et de partage. Les configurations de traces stockées dans un réseau de distribution peuvent être chargées et exécutées à partir de l’outil Trace ou partagées à des fins de consommation par une carte Web ou une application de terrain.
Utilisation
Le paramètre Input Utility Network (Réseau de distribution en entrée) doit correspondre à un réseau de distribution de version 5 ou ultérieure.
Si une géodatabase d’entreprise est utilisée, le réseau technique en entrée doit provenir d’un service du réseau technique.
Le compte connecté au portail est défini comme créateur de la configuration de trace.
L’authentification du système d’exploitation est utilisée pour stocker le créateur d’une configuration de trace lors de l’utilisation d’un réseau de distribution dans une géodatabase fichier.
Syntaxe
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})
Paramètre | Explication | Type de données |
in_utility_network | Réseau de distribution qui contient la nouvelle configuration de trace. | Utility Network; Utility Network Layer |
trace_config_name | Nom de la configuration de trace. | String |
trace_type | Spécifie le type de trace à configurer.
| String |
description (Facultatif) | Description de la configuration de trace. | String |
tags [tags,...] (Facultatif) | Ensemble de balises utilisées pour identifier la configuration de trace. Les balises peuvent être utilisées pour la recherche et l’indexation. | String |
domain_network (Facultatif) | Le nom du réseau du domaine sur lequel la trace sera exécutée. Ce paramètre est obligatoire lors de l’exécution du sous-réseau, des contrôleurs de sous-réseaux, des types de traçage en amont et en aval. | String |
tier (Facultatif) | Nom du niveau qui débute le traçage. Ce paramètre est obligatoire lors de l’exécution du sous-réseau, des contrôleurs de sous-réseaux, des types de traçage en amont et en aval. | String |
target_tier (Facultatif) | Le nom du niveau cible vers lequel le niveau en entrée s'écoule. Si ce paramètre est manquant pour les traçages en amont ou en aval, ils s’arrêteront lorsqu’ils atteignent la limite du sous-réseau de départ. Ce paramètre peut être utilisé pour permettre à ces traçages de poursuivre en haut ou en bas de la hiérarchie. | String |
subnetwork_name (Facultatif) | Le nom du sous-réseau où le traçage sera exécutée. Ce paramètre peut être utilisé lors de l’exécution d’un type de traçage de sous-réseau. Si un nom de sous-réseau est indiqué, le paramètre Starting Points (Points de début) (paramètre starting_points dans Python) n’est pas requis. | String |
shortest_path_network_attribute_name (Facultatif) | Attribut de réseau utilisé pour calculer le chemin le plus court. Lors de l’exécution d’un type de traçage du chemin le plus court, ce chemin est calculé à l’aide d’un attribut de réseau numérique comme la longueur de forme. Les chemins basés sur le coût et la distance peuvent être atteints. Ce paramètre est requis lors de l’exécution d’un traçage de chemin de type Court. | String |
include_containers (Facultatif) | Indique si les entités de conteneur sont incluses dans les résultats de traçage.
| Boolean |
include_content (Facultatif) | Indique si le traçage renvoie le contenu dans les conteneurs, avec les résultats.
| Boolean |
include_structures (Facultatif) | Indique si les objets et les entités de structure sont inclus dans les résultats de traçage.
| Boolean |
include_barriers (Facultatif) | Indique si les entités d’interruption de capacité à être traversé sont incluses dans les résultats de traçage. Les interruptions de traversabilité sont facultatives même si elles ont été prédéfinies dans la définition de sous-réseau. Ce paramètre ne s’applique pas aux entités de dispositif avec des bornes.
| Boolean |
validate_consistency (Facultatif) | Indique si une erreur est retournée lorsqu’une zone à valider figure dans les entités traversées. C’est la seule façon de garantir qu’un traçage passe via des entités avec un statut cohérent dans le réseau. Pour supprimer les zones à valider, validez la topologie de réseau.
| Boolean |
condition_barriers [[Name, Operator, Type, Value, Combine Using],...] (Facultatif) | Définit une interruption conditionnelle de traversabilité sur les entités en fonction d’une comparaison avec un attribut de réseau ou vérifie une chaîne de catégorie. Une interruption conditionnelle utilise un attribut de réseau, un opérateur et un type, ainsi qu’une valeur attributaire. Par exemple, arrêtez un traçage lorsque l’attribut Device Status d’une entité est égal à la valeur spécifique de Open. Lorsqu’une entité remplit ces conditions, le traçage s’arrête. En cas d’utilisation de plusieurs attributs, vous pouvez définir une condition Et ou une condition Ou à l’aide du paramètre Combine using (Combiner en utilisant). Les composants d’interruptions conditionnelles sont les suivants :
Les options des valeurs operator d’interruptions conditionnelles sont les suivantes :
En savoir plus sur les opérateurs bit à bit Les options des valeurs Type d’interruptions conditionnelles sont les suivantes :
Les options des valeurs Combine Using d’interruptions conditionnelles sont les suivantes :
En savoir plus sur l’utilisation de plusieurs expressions conditionnelles | Value Table |
function_barriers [[Function, Attribute, Operator, Value, Use Local Values],...] (Facultatif) | Définit l’interruption de traversabilité sur les entités en fonction d’une fonction. Les interruptions fonctionnelles peuvent être utilisées pour effectuer des actions comme limiter la distance que le traçage peut parcourir depuis le point de départ, ou définir une valeur maximale à laquelle arrêter un traçage. Par exemple, la longueur de chaque ligne parcourue est ajoutée à la distance totale parcourue jusqu’ici. Lorsque la distance totale parcourue atteint la valeur spécifiée, le traçage s’arrête. Les composants d’interruptions de fonctions sont les suivants :
Les valeurs des options function d’interruptions de fonctions sont les suivantes :
Les valeurs des options operator d’interruptions de fonctions sont les suivantes :
En savoir plus sur les opérateurs bit à bit Les options d’interruption de fonctions de Use Local Values sont les suivantes :
| Value Table |
traversability_scope (Facultatif) | Le type de traversabilité à appliquer. La portée de traversabilité détermine si la traversabilité est appliquée aux jonctions, tronçons, ou aux deux. Si, par exemple, une interruption conditionnelle est définie pour arrêter le parcours lorsque le paramètre Device Status (État du périphérique) est réglé sur Open (Ouvert), avec la portée de capacité à être traversé réglée sur les tronçons uniquement, le parcours ne s’interrompt pas même s’il détecte un dispositif ouvert. En effet, l’état du périphérique ne s’applique qu’aux jonctions. En d’autres termes, ce paramètre indique au traçage d’ignorer ou non les jonctions, les tronçons, voire les deux.
| String |
filter_barriers [[Name, Operator, Type, Value, Combine Using],...] (Facultatif) | Spécifie si un traçage s’interrompt pour une catégorie spécifique ou un attribut de réseau. Par exemple, arrêtez une recherche de parcours au niveau des entités qui ont un attribut de statut de cycle de vie égal à une valeur certaine. Ce paramètre est utilisé pour définir une entité de terminaison selon une valeur d’un attribut de réseau défini dans le système. Si vous utilisez plusieurs attributs, vous pouvez utiliser l’option Combine Using pour définir une condition And (Et) ou Or (Ou). Les composants du Filtre d'interruption sont les suivants :
Les options des valeurs operator des filtres par interruptions sont les suivantes :
En savoir plus sur les opérateurs bit à bit Les options des valeurs Type des filtres par interruptions sont les suivantes :
Les options des valeurs Combine Using des filtres par interruptions sont les suivantes :
En savoir plus sur l’utilisation de plusieurs expressions conditionnelles | Value Table |
filter_function_barriers [[Function, Attribute, Operator, Value, Use Local Values],...] (Facultatif) | Filtre les résultats du traçage pour une catégorie spécifique. Les composants du Filtre par fonctions d'interruption sont les suivants :
Les options de la valeur function du filtre des interruptions de fonction sont les suivantes :
Les options de la valeur operator du filtre des interruptions de fonction sont les suivantes :
En savoir plus sur les opérateurs bit à bit Les options d’interruption de fonctions de Use Local Values sont les suivantes :
| Value Table |
filter_scope (Facultatif) | Spécifie si le filtre pour une catégorie spécifique est forcé aux jonctions, aux tronçons ou les deux. Si, par exemple, une interruption de filtre est définie pour arrêter la trace lorsque le paramètre Device Status (État du périphérique) est réglé sur Open (Ouvert), avec la portée de capacité à être traversé réglée sur les tronçons uniquement, la trace ne s’interrompt pas même si elle détecte un dispositif ouvert. En effet, l’état du périphérique ne s’applique qu’aux jonctions. En d’autres termes, ce paramètre indique au traçage d’ignorer ou non les jonctions, les tronçons, voire les deux.
| String |
filter_bitset_network_attribute_name (Facultatif) | Nom de l’attribut de réseau à utiliser pour filtrer par bitset. Ce paramètre ne s'applique qu'aux traçages de type en amont, en aval ou boucles. Ce paramètre peut être utilisé pour ajouter une logique spéciale pendant un traçage de telle sorte qu’il reflète davantage les scénarios réels. Par exemple, pour un traçage de boucles, l'attribut de réseau Phases - Courant peut déterminer si la boucle est une véritable boucle électrique (la même phase est énergisée tout autour de la boucle, à savoir, A) et ne renvoie que des boucles électriques réelles pour les résultats du traçage. Exemple d’un traçage en amont : lors du traçage d’un réseau de distribution électrique, précisez un attribut de réseau Phases - Courant, pour que les résultats du traçage n’incluent que les chemins valides spécifiés dans l’attribut de réseau, et pas tous les chemins. | String |
filter_nearest (Facultatif) | Indique si l’algorithme k-nearest neighbors (k voisins les plus proches) est utilisé pour renvoyer plusieurs entités d’un certain type dans une distance donnée. Lorsque ce paramètre est utilisé, vous pouvez préciser un nombre et un coût, ainsi qu’un ensemble de catégories, un type de ressource ou ces deux éléments.
| Boolean |
nearest_count (Facultatif) | Nombre d’entités à renvoyer lorsque filter_nearest a pour valeur FILTER_BY_NEAREST. | Long |
nearest_cost_network_attribute (Facultatif) | Attribut de réseau numérique à utiliser pour calculer la proximité, le coût ou la distance lorsque filter_nearest est FILTER_BY_NEAREST—par exemple, Shape length (Longueur de forme). | String |
nearest_categories [nearest_categories,...] (Facultatif) | Catégories à renvoyer lorsque filter_nearest est FILTER_BY_NEAREST—par exemple, Protective (Protection). | String |
nearest_assets [nearest_assets,...] (Facultatif) | Groupes d’actifs et types d’actifs à renvoyer lorsque filter_nearest est FILTER_BY_NEAREST—par exemple, ElectricDistributionDevice/Transformer/Step Down. | String |
functions [[Function, Attribute, Filter Name, Filter Operator, Filter Type, Filter Value],...] (Facultatif) | Applique une fonction de calcul aux résultats de la trace. Les composants des fonction sont les suivants :
Les options de la valeur Function des fonctions sont les suivantes :
Par exemple, une entité de point de départ a une valeur de 20. L’entité suivante a une valeur de 30. Si vous utilisez la fonction MINIMUM, le résultat est 20. MAXIMUM est égal à 30, ADD est 50, AVERAGE est égal à 25, COUNT est 2, et SUBTRACT est -10. Les options de la valeur Filter Operator sont les suivantes :
En savoir plus sur les opérateurs bit à bit Les options de la valeur Filter Type des fonctions sont les suivantes :
| Value Table |
propagators [[Attribute, Substitution Attribute, Function, Operator, Value],...] (Facultatif) | Spécifie les attributs de réseau à propager ainsi que la façon dont cette propagation devra être effectuée pendant un traçage. Les attributs de classe propagés désignent les valeurs clés sur les contrôleurs de sous-réseau qui sont distribuées au reste des entités dans le sous-réseau. Par exemple, dans un modèle de distribution électrique, vous pouvez propager la valeur de phase. Les composants de propagateurs sont les suivants :
Les options de la valeur function des propagateurs sont les suivantes :
Les options de la valeur operator des propagateurs sont les suivantes :
En savoir plus sur les opérateurs bit à bit Remarque :Ce paramètre est uniquement disponible via Python. | Value Table |
output_assettypes [output_assettypes,...] (Facultatif) | Filtre les types de ressources en sortie à inclure dans les résultats (par exemple, retourner uniquement les transformateurs aériens). | String |
output_conditions [[Name, Operator, Type, Value, Combine Using],...] (Facultatif) | Spécifie les types des entités renvoyées selon un attribut de réseau ou une catégorie. Par exemple, une trace configurée pour filtrer toutes les entités sauf les entités Dérivation, toute entité tracée à laquelle la catégorie Dérivation n’est pas attribuée, n’est pas incluse dans les résultats. Toute entité tracée qui n’est pas renvoyée dans l’ensemble de sélections résultant. Si vous utilisez plusieurs attributs, vous pouvez utiliser l’option Combine Using pour définir une condition And (Et) ou Or (Ou). Les composants des Conditions de sortie sont les suivants :
Les options de la valeur operator sont les suivantes :
En savoir plus sur les opérateurs bit à bit Les options de la valeur Type des Conditions de sortie sont les suivantes :
Les options de la valeur Combine Using des Conditions de sortie sont les suivantes :
En savoir plus sur l’utilisation de plusieurs expressions conditionnelles | Value Table |
include_isolated_features (Facultatif) | Indique si les entités isolées sont incluses dans les résultats de traçage. Ce paramètre est utilisé uniquement lors de l’exécution d’un traçage d’isolement.
Remarque :Ce type de traçage d’isolement requiert ArcGIS Enterprise 10.7 ou version ultérieure si vous utilisez une géodatabase d’entreprise. | Boolean |
ignore_barriers_at_starting_points (Facultatif) | Spécifie si les interruptions dynamiques dans la configuration de traçage sont ignorées pour les points de départ. Cela peut être utile lorsque vous effectuez un parcours de dispositifs de protection en amont et que vous utilisez les dispositifs de protection (interruptions) détectés comme points de début pour rechercher les dispositifs de protection en amont suivants.
| Boolean |
include_up_to_first_spatial_container (Facultatif) | Indique de limiter ou non les conteneurs retournés pour n’inclure que ceux rencontrés jusqu’au premier conteneur spatial, et l’incluant, pour chaque élément de réseau dans les résultats de traçage. Si aucun conteneur spatial n’est rencontré mais que des conteneurs non spatiaux sont présents pour un élément de réseau donné, tous les conteneurs non spatiaux sont inclus dans les résultats. Ce paramètre n’est applicable que si Include Containers a la valeur enabled.
| Boolean |
result_types [result_types,...] (Facultatif) | Spécifie le type de résultat renvoyé par la trace.
| String |
allow_indeterminate_flow (Facultatif) | Indique si les entités dont le flux est indéterminé sont tracées. Ce paramètre est respecté uniquement lors de l’exécution d’un traçage en amont ou en aval.
| Boolean |
validate_locatability (Facultatif) | Indique si une erreur est renvoyée si une jonction non spatiale ou des objets de tronçon sont rencontrés sans qu’il existe une structure ou un conteneur associé dans la hiérarchie d’association des entités traversées. Cette option garantit que les objets non spatiaux renvoyés par une trace sont associés à des entités spatiales.
| Boolean |
Sortie dérivée
Nom | Explication | Type de données |
out_utility_network | Réseau technique actualisé. | Utility Network |
Exemple de code
Le script de fenêtre Python ci-dessous illustre l'utilisation de l'outil 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")
Environnements
Informations de licence
- Basic: Non
- Standard: Oui
- Advanced: Oui
Rubriques connexes
Vous avez un commentaire à formuler concernant cette rubrique ?