名前 | 説明 | データ タイプ |
in_utility_network | 変更するダイアグラム テンプレートを含むユーティリティ ネットワークまたはトレース ネットワーク。 | Utility Network; Trace Network |
template_name | 変更するダイアグラム テンプレートの名前。 | String |
is_active | 指定したテンプレートに基づくダイアグラムの生成および更新時に、ルールを有効にするかどうかを指定します。 - ACTIVE—追加されたルールが、入力テンプレートに基づくダイアグラムの生成および更新時に有効になります。 これがデフォルトです。
- INACTIVE—追加されたルールが、入力テンプレートに基づくダイアグラムの生成および更新時に有効になりません。
| Boolean |
trace_type | ダイアグラム コンテンツの構築のために実行するトレースのタイプを指定します。 - CONNECTED—接続トレースは、ルールの開始時にダイアグラム内に現在表示されているユーティリティ ネットワーク エレメントまたはトレース ネットワーク エレメントから実行され、接続エレメントに沿って、外側に広がります。 これがデフォルトです。
- SUBNETWORK—サブネットワーク トレースは、ルールの開始時にダイアグラム内に現在表示されているユーティリティ ネットワーク エレメントから実行され、接続エレメントに沿って外側に広がり、関連するサブネットワークに沿って、外側に広がるソースまたはシンクを検出します。
- UPSTREAM—上流トレースは、ルールの開始時にダイアグラム内に現在表示されているユーティリティ ネットワーク エレメントまたはトレース ネットワーク エレメントから実行され、上流にあるエレメントを検出します。
- DOWNSTREAM—下流トレースは、ルールの開始時にダイアグラム内に現在表示されているユーティリティ ネットワーク エレメントまたはトレース ネットワーク エレメントから実行され、下流にあるエレメントを検出します。
- SHORTEST_PATH—最短パス トレースは、ルールの開始時にダイアグラム内に現在始点として指定されているユーティリティ ネットワーク フィーチャまたはトレース ネットワーク フィーチャから実行され、これらの始点間の最短パスに沿って、フィーチャを検出します。 パスの通過にかかるコストは、フロー方向に関係なく、[最短パス ネットワーク属性名] パラメーターの値 / path_network_weight_name として設定されたネットワーク属性に基づいて、決定されます。
| String |
domain_network (オプション) | ユーティリティ ネットワークに対して、トレースを実行するドメイン ネットワークの名前。 サブネットワーク、上流、および下流トレース タイプを実行する場合、このパラメーターは必須です。 | String |
tier (オプション) | ユーティリティ ネットワークに対して、トレースを開始する層の名前。 このパラメーターは、接続トレース タイプを実行する場合にはオプションであり、サブネットワーク、上流、および下流トレース タイプを実行する場合には必須です。 | String |
target_tier (オプション) | ユーティリティ ネットワークに対して、入力層が流れるターゲット層の名前。 上流および下流トレースで、このパラメーターを使用しない場合は、開始するサブネットワークの境界に到達すると、トレースは停止します。 このパラメーターを使用すると、このトレースを階層の上方または下方に継続できます。 | String |
include_structures (オプション) | 構造物フィーチャおよびオブジェクトをトレース結果に含めるかどうかを指定します。 - INCLUDE_STRUCTURES—構造物フィーチャおよびオブジェクトをトレース結果に含めます。
- EXCLUDE_STRUCTURES—構造物フィーチャおよびオブジェクトをトレース結果に含めません。 これがデフォルトです。
| Boolean |
include_barriers (オプション) | 通過可能性バリア フィーチャをトレース結果に含めるかどうかを指定します。 通過可能性バリアは、サブネットワーク定義で事前に設定されている場合でも任意指定です。 このパラメーターは、ターミナルを含むデバイス フィーチャには適用されません。 - INCLUDE_BARRIERS—通過可能性バリア フィーチャをトレース結果に含めます。 これがデフォルトです。
- EXCLUDE_BARRIERS—通過可能性バリア フィーチャをトレース結果に含めません。
| Boolean |
condition_barriers [[Name, Operator, Type, Value, Combine Using],...] (オプション) | ネットワーク属性との比較またはカテゴリ文字列のチェックに基づいて、フィーチャに対して通過可能性バリア条件を設定します。 条件バリアは、ネットワーク属性、演算子とタイプ、および属性値を使用します。 たとえば、フィーチャが Open の特定の値と等しい Device Status 属性を持っている場合に、トレースを停止します。 フィーチャがこの条件を満たしている場合、トレースが停止します。 複数の属性を使用している場合、[結合方法] パラメーターを使用して、And 条件および Or 条件を定義することができます。
条件バリアの構成は次のとおりです。 - Name - システム内で定義された任意のネットワーク属性によってフィルターします。
- Operator - 複数の異なる演算子から選択します。
- Type - name パラメーターで指定された値から、特定の値またはネットワーク属性を選択します。
- Value - 演算子の値に基づいて処理を停止させる、入力属性タイプの特定の値を指定します。
- Combine Using - 複数の属性を追加する場合に、この値を設定します。And 条件または Or 条件を使用して、属性を結合することができます。
条件バリアの 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—値のすべてのビットが、属性内に存在するビット単位の論理積演算 (bitwise AND == value)。
- DOES_NOT_INCLUDE_THE_VALUES—値の一部のビットが、属性内に存在しないビット単位の論理積演算 (bitwise AND != value)。
- INCLUDES_ANY—値の少なくとも 1 つのビットが、属性内に存在するビット単位の論理積演算 (bitwise AND == True)。
- DOES_NOT_INCLUDE_ANY—値のビットが、属性内に存在しないビット単位の論理積演算 (bitwise AND == False)。
bitwise 演算子の詳細 条件バリアの 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 の 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—値のすべてのビットが、属性内に存在するビット単位の論理積演算 (bitwise AND == value)。
- DOES_NOT_INCLUDE_THE_VALUES—値の一部のビットが、属性内に存在しないビット単位の論理積演算 (bitwise AND != value)。
- INCLUDES_ANY—値の少なくとも 1 つのビットが、属性内に存在するビット単位の論理積演算 (bitwise AND == True)。
- DOES_NOT_INCLUDE_ANY—値のビットが、属性内に存在しないビット単位の論理積演算 (bitwise AND == False)。
bitwise 演算子の詳細 関数バリアの [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 オプションを使用して、And 条件または Or 条件を定義できます。
フィルター バリアの構成は次のとおりです。 - Name -システム内で定義されたカテゴリまたは任意のネットワーク属性によってフィルターします。
- Operator - 複数の異なる演算子から選択します。
- Type - name パラメーターで指定された値から、特定の値またはネットワーク属性を選択します。
- Value - 演算子の値に基づいて、処理を停止させる入力属性タイプの特定の値を指定します。
- Combine Using - 複数の属性を追加する場合に、この値を設定します。And 条件または Or 条件を使用して、属性を結合することができます。
フィルター バリアの 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—値のすべてのビットが、属性内に存在するビット単位の論理積演算 (bitwise AND == value)。
- DOES_NOT_INCLUDE_THE_VALUES—値の一部のビットが、属性内に存在しないビット単位の論理積演算 (bitwise AND != value)。
- INCLUDES_ANY—値の少なくとも 1 つのビットが、属性内に存在するビット単位の論理積演算 (bitwise AND == True)。
- DOES_NOT_INLCUDE_ANY—値のビットが、属性内に存在しないビット単位の論理積演算 (bitwise AND == False)。
bitwise 演算子の詳細 フィルター バリアの 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 の 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—値のすべてのビットが、属性内に存在するビット単位の論理積演算 (bitwise AND == value)。
- DOES_NOT_INCLUDE_THE_VALUES—値の一部のビットが、属性内に存在しないビット単位の論理積演算 (bitwise AND != value)。
- INCLUDES_ANY—値の少なくとも 1 つのビットが、属性内に存在するビット単位の論理積演算 (bitwise AND == True)。
- DOES_NOT_INCLUDE_ANY—値のビットが、属性内に存在しないビット単位の論理積演算 (bitwise AND == False)。
bitwise 演算子の詳細 関数バリアのフィルターの Use Local Values オプションは次のとおりです。 - TRUE—ローカル値が使用されます。
- FALSE—グローバル値が使用されます。 これがデフォルトです。
| Value Table |
filter_scope (オプション) | 特定のカテゴリのフィルターをジャンクション、エッジ、その両方のいずれに適用するかを指定します。 たとえば、Device Status が Open であり、通過可能性の範囲がエッジのみに設定されている場合に、トレースを停止するようにフィルター バリアを定義すると、トレースでオープン デバイスが検出された場合でも、Device Status はジャンクションにしか適用されないため、トレースは停止しません。 つまり、このパラメーターは、トレースで、ジャンクション、エッジ、またはその両方を無視するかどうかを示します。 - BOTH_JUNCTIONS_AND_EDGES—フィルターをジャンクションとエッジの両方に適用します。 これがデフォルトです。
- JUNCTIONS_ONLY—フィルターをジャンクションのみに適用します。
- EDGES_ONLY—フィルターをエッジのみに適用します。
| String |
filter_bitset_network_attribute_name (オプション) | bitset によるフィルターに使用するネットワーク属性の名前。 このパラメーターは、上流、下流、およびループ トレース タイプのみに適用できます。 このパラメーターを使用すると、トレースが実世界のシナリオをより細密に反映するように、トレース中に特別なロジックを追加できます。 たとえば、ループ トレースの場合、Phases current ネットワーク属性は、ループが真の電気ループである (ループ全体で同じフェーズに電源が入る) かどうかを判断し、トレース結果の真の電源ループのみを返すことができます。 上流トレースの場合、たとえば、配電網のトレース時に Phases current ネットワーク属性を指定することにより、トレース結果に、すべてのパスではなく、ネットワーク属性で指定された有効なパスのみを含めます。 | 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 |
propagators [[Attribute, Substitution Attribute, Function, Operator, Value],...] (オプション) | 反映させるネットワーク属性、およびトレース中に反映がどのように発生するかを指定します。 反映されるクラス属性は、サブネットワーク内の他のフィーチャに広められる、サブネットワーク コントローラーの重要な値を示します。 たとえば、配電モデルでは、位相値を反映することができます。 プロパゲーターの構成は次のとおりです。 - Attribute - システム内で定義された任意のネットワーク属性を基準にフィルターします。
- Substitution Attribute - bitset ネットワーク属性値の代わりに、代替値を使用します。 代替値は、反映されるネットワーク属性のビット数に基づいてエンコードされます。 代替は、フェーズ内の各ビットから別のマップへのマッピングです。 たとえば、フェーズ AC では、1 つの代替は、ビット 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—値のすべてのビットが、属性内に存在するビット単位の論理積演算 (bitwise AND == value)。
- DOES_NOT_INCLUDE_THE_VALUES—値の一部のビットが、属性内に存在しないビット単位の論理積演算 (bitwise AND != value)。
- INCLUDES_ANY—値の少なくとも 1 つのビットが、属性内に存在するビット単位の論理積演算 (bitwise AND == True)。
- DOES_NOT_INCLUDE_ANY—値のビットが、属性内に存在しないビット単位の論理積演算 (bitwise AND == False)。
bitwise 演算子の詳細 このパラメーターは、Python でのみ使用できます。 | Value Table |
description (オプション) | ルールの説明。 | String |
allow_indeterminate_flow (オプション) | フロー方向が、不定または未定のトレース ネットワーク フィーチャをトレースするかどうかを指定します。 このパラメーターは、上流トレース タイプまたは下流トレース タイプを実行する場合にのみ適用されます。 - TRACE_INDETERMINATE_FLOW—フロー方向が、不定または未定のトレース ネットワーク フィーチャをトレースします。
- IGNORE_INDETERMINATE_FLOW—フロー方向が、不定または未定のトレース ネットワーク フィーチャをトレースしません。 これがデフォルトです。
| Boolean |
path_direction (オプション) | トレース ネットワークのパスの方向を指定します。 パスの通過にかかるコストは、path_network_weight_name パラメーターの値によって決定されます。 このパラメーターは、SHORTEST_PATH トレース タイプを実行する場合にのみ適用されます。 - NO_DIRECTION—フロー方向に関係なく、2 つの始点間にパスが存在します。 これがデフォルトです。
- PATH_UPSTREAM—パスの方向は、2 つの始点間の下流方向になります。
- PATH_DOWNSTREAM—パスの方向は、2 つの始点間の上流方向になります。
| String |
path_network_weight_name (オプション) | ユーティリティ ネットワークまたはトレース ネットワークのパスを計算する場合に使用するネットワーク属性。 最短パス解析トレースを実行すると、形状の長さなど、数値のネットワーク属性を使用して、最短パスが計算されます。 コストに基づくパスと、距離に基づくパスの両方が得られます。 最短パス トレースを実行する場合は、このパラメーターは必須です。 | String |
use_trace_config (オプション) | トレースのプロパティの定義に、既存の指定トレース構成を使用するかどうかを指定します。 このパラメーターは、ユーティリティ ネットワーク バージョン 7 以降でのみ有効になります。 - USE_TRACE_CONFIGURATION—既存の指定トレース構成を使用して、トレースのプロパティを定義します。
- DO_NOT_USE_TRACE_CONFIGURATION—既存の指定トレース構成を使用して、トレースのプロパティを定義します。 これがデフォルトです。
| Boolean |
trace_config_name (オプション) | 既存の指定トレース構成の名前を使用して、トレースのプロパティを定義します。 このパラメーターは、use_trace_config パラメーターが USE_TRACE_CONFIGURATION に設定されている場合のみ有効です。 | String |
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 |