概要
既存のテンプレートに基づいて、ダイアグラム構築中にユーティリティ ネットワークまたはトレース ネットワーク上でトレースを自動的に実行するためのダイアグラム ルールを追加します。トレースの結果として生成されたネットワーク フィーチャおよびネットワーク オブジェクトはダイアグラム コンテンツの構築に使用されます。
注意:
このツールは構成および管理ツールです。
メモ:
このツールは、入力ダイアグラム テンプレートに基づく既存のダイアグラムの一貫性に影響を与えます。更新されるまで、既存のダイアグラムはすべて一貫性なしになり、一貫性警告アイコン が表示されます。
使用法
このツールは、ユーティリティ ネットワーク サービスまたはトレース ネットワーク サービスを使用する場合、サポートされません。ファイル ジオデータベース内のユーティリティ ネットワークまたはトレース ネットワークを使用するか、エンタープライズ ジオデータベース内のユーティリティ ネットワークまたはトレース ネットワークへのデータベース接続を使用する必要があります。エンタープライズ ジオデータベースを操作する場合、次の要件があります。
- [入力ネットワーク] パラメーター値は、データベース ユーティリティ ネットワークの所有者またはデータベース トレース ネットワーク所有者として、確立されたデータベース接続から取得する必要があります。
- 接続された ArcGIS Enterprise ポータル アカウントは、ポータル ユーティリティ ネットワークの所有者またはポータル トレース ネットワーク所有者である必要があります。
- このツールは、パブリックで保護されていないと想定される、デフォルトのバージョンに接続されている必要があります。
トレース ルールは、ダイアグラム内で現在表されているユーティリティ ネットワークまたはトレース ネットワーク エレメントからのトレースの実行に使用されます。
指定したトレース タイプによって、トレース ルールを実行するダイアグラムで始点を事前に設定しておく必要があるかどうかが決まります。
- 接続、サブネットワーク、上流方向、下流方向のトレース タイプの場合、トレース ルールを開始する際にダイアグラムに表示されているすべてのユーティリティ ネットワークまたはトレース ネットワーク エレメントは、ダイアグラム テンプレートで [始点の設定ルール] が構成されていて特定の始点が明確に特定されていない限り、トレースの始点に考慮されます。
- 最短パスのトレース タイプの場合、ダイアグラム テンプレートで [始点の設定ルール] を構成して、ダイアグラムに現在表示されているすべてのトレース ネットワーク エレメント間で、最短パスを検索する 2 つの始点を識別する必要があります。
トレース ルールに基づいてテンプレートを構成した場合、ダイアグラムが更新されるたびに、ユーティリティ ネットワークまたはトレース ネットワーク上で体系的にトレースが再実行されます。つまり、更新時に、必ず最新のネットワーク トレース結果が、そのテンプレートに基づくすべてのダイアグラムに反映されます。
構文
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})
パラメーター | 説明 | データ タイプ |
in_utility_network | 変更するダイアグラム テンプレートを含むユーティリティ ネットワークまたはトレース ネットワーク。 | Utility Network; Trace Network |
template_name | 変更するダイアグラム テンプレートの名前。 | String |
is_active | 指定したテンプレートに基づくダイアグラムの生成および更新時にルールを有効にするかどうかを指定します。
| Boolean |
trace_type | ダイアグラム コンテンツの構築のためにルールを実行するトレースのタイプを指定します。
| String |
domain_network (オプション) | ユーティリティ ネットワークに対してトレースを実行するドメイン ネットワークの名前。サブネットワーク、上流解析、および下流解析トレース タイプを実行する場合、このパラメーターは必須です。 | String |
tier (オプション) | ユーティリティ ネットワークに対してトレースを開始する層の名前。このパラメーターは、接続解析トレース タイプを実行する場合にはオプションであり、サブネットワーク、上流解析、および下流解析トレース タイプを実行する場合には必須です。 | String |
target_tier (オプション) | ユーティリティ ネットワークに対して入力層が流れるターゲット層の名前。上流または下流解析トレースでこのパラメーターを使用しない場合は、開始するサブネットワークの境界に到達するとトレースは停止します。このパラメーターを使用すると、このトレースを階層の上方または下方に継続できます。 | String |
include_structures (オプション) | 構造物フィーチャおよびオブジェクトをトレース結果に含めるかどうかを指定します。
| Boolean |
include_barriers (オプション) | 通過可能性バリア フィーチャをトレース結果に含めるかどうかを指定します。通過可能性バリアは、サブネットワーク定義で事前に設定されている場合でも任意指定です。このパラメーターは、ターミナルを含むデバイス フィーチャには適用されません。
| Boolean |
condition_barriers [[Name, Operator, Type, Value, Combine Using],...] (オプション) | ネットワーク属性との比較またはカテゴリ文字列のチェックに基づいて、フィーチャに対して通過可能性バリア条件を設定します。条件バリアは、ネットワーク属性、演算子とタイプ、および属性値を使用します。たとえば、フィーチャが Device Status の特定の値と等しい Open 属性を持っている場合に、トレースを停止します。フィーチャがこの条件を満たしている場合、トレースが停止します。複数の属性を使用している場合、[結合方法] パラメーターを使用して [And] 条件および [Or] 条件を定義することができます。 条件バリアの構成は次のとおりです。
条件バリアの operator の値オプションは次のとおりです。
条件バリアの Type の値オプションは次のとおりです。
条件バリアの Combine Using の値オプションは次のとおりです。
| Value Table |
function_barriers [[Function, Attribute, Operator, Value, Use Local Values],...] (オプション) | 関数に基づいて、フィーチャに対する通過可能性バリアを設定します。関数バリアを使用して、始点からトレースが移動できる距離の制限としてそのような設定を行うか、トレースを停止するための最大値を設定することができます。たとえば、通過した各ラインの長さが、それまでに移動した合計距離に追加されます。移動した全長が指定された値に達した場合、トレースが停止します。 関数バリアの構成は次のとおりです。
関数バリアの [function] 値のオプションは次のとおりです。
関数バリアの [operator] 値のオプションは次のとおりです。
関数バリアの [Use Local Values] のオプションは次のとおりです。
| Value Table |
traversability_scope (オプション) | 適用する通過可能性のタイプです。通過可能性範囲は、通過可能性がジャンクション、エッジ、またはその両方のいずれに適用されるかを決定します。たとえば、Device Status が Open と等しく、通過可能性の範囲がエッジのみに設定されている場合にトレースを停止するように条件バリアが定義されている場合は、トレースがオープン デバイスを検出した場合でも、Device Status はジャンクションのみに適用されるため、トレースは停止しません。つまり、このパラメーターは、トレースで、ジャンクション、エッジ、またはその両方を無視するかどうかを示します。
| String |
filter_barriers [[Name, Operator, Type, Value, Combine Using],...] (オプション) | いつ特定のカテゴリまたはネットワーク属性のトレースを停止するかを指定します。たとえば、特定の値と等しいライフ サイクル ステータス属性があるフィーチャでトレースを停止します。このパラメーターを使用して、システムに定義されているネットワーク属性の値に基づいてターミネーターを設定します。複数の属性を使用すると、Combine Using オプションを使用して、[And] 条件または [Or] 条件を定義できます。 バリアのフィルタリングの構成は次のとおりです。
バリアのフィルタリングの operator の値オプションは次のとおりです。
バリアのフィルタリングの Type の値オプションは次のとおりです。
バリアのフィルタリングの Combine Using の値オプションは次のとおりです。
| Value Table |
filter_function_barriers [[Function, Attribute, Operator, Value, Use Local Values],...] (オプション) | 特定のカテゴリのトレース結果をフィルタリングします。 フィルター関数バリアの構成は次のとおりです。
フィルター関数バリアの function の値オプションは次のとおりです。
フィルター関数バリアの operator の値オプションは次のとおりです。
フィルター関数バリアの Use Local Values オプションは次のとおりです。
| Value Table |
filter_scope (オプション) | 特定のカテゴリのフィルターをジャンクション、エッジ、その両方のいずれに適用するかを指定します。たとえば、Device Status が Open であり、通過可能性の範囲がエッジのみに設定されている場合にトレースを停止するようにフィルター バリアを定義すると、トレースでオープン デバイスが検出された場合でも、Device Status はジャンクションにしか適用されないため、トレースは停止しません。つまり、このパラメーターは、トレースで、ジャンクション、エッジ、またはその両方を無視するかどうかを示します。
| String |
filter_bitset_network_attribute_name (オプション) | bitset によるフィルター処理に使用するネットワーク属性の名前。このパラメーターは、上流、下流、およびループ トレース タイプのみに適用できます。このパラメーターを使用すると、トレースが実世界のシナリオをより細密に反映するように、トレース中に特別なロジックを追加できます。たとえば、ループ トレースの場合、Phases current ネットワーク属性は、ループが真の電気ループである (ループ全体で同じフェーズに電源が入る) かどうかを判断し、トレース結果の真の電源ループのみを返すことができます。上流トレースの場合、たとえば、配電網のトレース時に Phases current ネットワーク属性を指定することにより、トレース結果に、すべてのパスではなく、ネットワーク属性で指定された有効なパスのみを含めます。 | String |
filter_nearest (オプション) | 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],...] (オプション) | 伝播させるネットワーク属性、およびトレース中に伝播がどのように発生するかを指定します。伝播されるクラス属性は、サブネットワーク内の他のフィーチャに広められる、サブネットワーク コントローラーの重要な値を示します。たとえば、配電モデルでは、位相値を伝播することができます。 プロパゲーターの構成は次のとおりです。
プロパゲーターの function の値オプションは次のとおりです。
プロパゲーターの operator の値オプションは次のとおりです。
メモ:このパラメーターは Python でのみ使用できます。 | Value Table |
description (オプション) | ルールの説明。 | String |
allow_indeterminate_flow (オプション) | フロー方向が不定または未定のトレース ネットワーク フィーチャをトレースするかどうかを指定します。このパラメーターは、上流解析トレース タイプまたは下流解析トレース タイプを実行する場合にのみ適用されます。
| Boolean |
path_direction (オプション) | トレース ネットワークのパスの方向を指定します。パスの通過にかかるコストは、フロー方向に関係なく、[path_network_attribute_name] で設定された値に基づいて決定されます。このパラメーターは、[PATH] トレース タイプを実行する場合にのみ適用されます。
| String |
path_network_weight_name (オプション) | トレース ネットワークのパスを計算する場合に使用するネットワーク属性。最短パス解析トレースを実行すると、形状の長さなど、数値のネットワーク属性を使用して、最短パスが計算されます。コストに基づくパスと距離に基づくパスの両方が得られます。最短パス解析トレースを実行する場合は、このパラメーターは必須です。 | String |
派生した出力
名前 | 説明 | データ タイプ |
out_utility_network | 更新されたユーティリティ ネットワークまたはトレース ネットワーク。 | ユーティリティ ネットワーク、トレース ネットワーク |
out_template_name | ダイアグラム テンプレートの名前。 | String |
コードのサンプル
指定したネットワーク用の既存の MyTemplate1 テンプレートにトレース ルールを追加して、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")
環境
ライセンス情報
- Basic: いいえ
- Standard: はい
- Advanced: はい