サブネットワークのエクスポート (Export Subnetwork) (ユーティリティ ネットワーク)

サマリー

サブネットワークを、ユーティリティ ネットワークから *.json ファイルにエクスポートします。 Is deleted 属性が True に設定されている限り、このツールを使用して、サブネットワーク テーブル内の行を削除することもできます。 この属性の True の値は、サブネットワーク コントローラーがサブネットワークから削除されていることを示します。

注意:

ArcGIS Enterprise 10.9.1 以降、エンタープライズ ジオデータベースでユーティリティ ネットワークを操作する場合、UtilityNetworkTools ジオプロセシング サービスを使用して、サブネットワークのエクスポート操作が非同期に処理されるようになりました。 UtilityNetworkTools サービスは、ユーティリティ ネットワークを含むフィーチャ サービスの System フォルダーで事前構成済みです。 このサービスはタイムアウト設定が長く、ユーティリティ ネットワークのジオプロセシング タスク用に予約されています。

サブネットワークのエクスポートの詳細

使用法

  • サブネットワークをエクスポートするには、クリーンでなければなりません。最初に [サブネットワークの更新 (Update Subnetwork)] ツールを実行してください。

  • Trace Parameters カテゴリ内のパラメーターは、Python を介してのみ実行できます。

  • エンタープライズ ジオデータベースを操作する場合、次の要件が満たされている必要があります。
    • [入力ユーティリティ ネットワーク] パラメーター値は、ユーティリティ ネットワーク サービスから取得する必要があります。
  • [エクスポートを承認済みに設定] パラメーターをオンにする場合、次の条件を満たす必要があります。

    • ネットワーク トポロジを有効化する必要があります。

    • エンタープライズ ジオデータベースには、次の追加要件があります。

  • ArcGIS Pro 2.3 では、[ジオメトリを含める][結果タイプ][結果ネットワーク属性]、および [結果フィールド] パラメーターが追加されました。 これらのパラメーターを使用した場合、出力 JSON ファイルの形式が変わります。 これらのパラメーターをエンタープライズ ジオデータベースで使用する場合は、ArcGIS Enterprise 10.7 以降が必要です。 出力 JSON 応答構文を確認してください。

パラメーター

ラベル説明データ タイプ
入力ユーティリティ ネットワーク

エクスポートするサブネットワークを含むユーティリティ ネットワーク。

Utility Network; Utility Network Layer
ドメイン ネットワーク

サブネットワークが属しているドメイン ネットワーク。

String

サブネットワークを含む層。

String
サブネットワーク名

エクスポートするサブネットワークの名前。 指定したソースに対応する、サブネットワーク情報をエクスポートします。

String
エクスポートを承認済みに設定

Subnetworks テーブル内の対応するコントローラーと SubnetLine フィーチャクラス内のフィーチャの LASTACKEXPORTSUBNETWORK 属性を更新するかどうかを指定します。

  • オン - Subnetworks テーブルで、対応するコントローラーの LASTACKEXPORTSUBNETWORK 属性を更新します。 削除対象の印 (Is deleted = True) をコントローラーにつけた場合、そのコントローラーが Subnetworks テーブルから削除されます。 このオプションでは、入力ユーティリティ ネットワークがデフォルト バージョンを参照する必要があります。
  • オフ - Subnetworks テーブルで、対応するコントローラーの LASTACKEXPORTSUBNETWORK 属性を更新しません。 これがデフォルトです。

Boolean
出力 JSON

生成される *.json ファイルの名前と場所。

File
条件バリア
(オプション)
注意:

このパラメーターは Python でのみ使用できます。

Value Table
関数バリア
(オプション)
注意:

このパラメーターは Python でのみ使用できます。

Value Table
バリア フィーチャを含める
(オプション)
注意:

このパラメーターは Python でのみ使用できます。

Boolean
通過可能性の適用
(オプション)

適用される通過可能性のタイプを指定します。 通過可能性範囲は、通過可能性がジャンクション、エッジ、またはその両方のいずれに適用されるかを決定します。 たとえば、DEVICESTATUSOpen ならばトレースを停止する、という条件バリアを定義したとしましょう。しかし、通過可能性スコープが「エッジのみ」であるとすれば、開いているデバイスを検出してもトレースは停止しません。DEVICESTATUS はジャンクションにしか適用されないからです。 つまり、このパラメーターは、トレースで、ジャンクション、エッジ、またはその両方を無視するかどうかを示します。

  • ジャンクションとエッジの両方通過可能性は、ジャンクションとエッジの両方に適用されます。
  • ジャンクションのみ通過可能性は、ジャンクションのみに適用されます。
  • エッジのみ通過可能性は、エッジのみに適用されます。
注意:

このパラメーターは Python でのみ使用できます。

String
プロパゲーター
(オプション)
注意:

このパラメーターは Python でのみ使用できます。

Value Table
ジオメトリを含める
(オプション)

ジオメトリを結果に含めるかどうかを指定します。

  • オン - ジオメトリは結果に含まれます。
  • オフ - ジオメトリは結果に含まれません。 これがデフォルトです。

注意:

エンタープライズ ジオデータベースの場合、このパラメーターは ArcGIS Enterprise 10.7 以降を必要とします。

Boolean
結果タイプ
(オプション)

返される結果のタイプを指定します。

  • 接続性ジオメトリの一致または接続性の関連付けを介して接続されるフィーチャを返します。 これがデフォルトです。
  • フィーチャフィーチャレベルの情報を返します。
  • 格納および付属物の関連付け格納および構造物付属物の関連付けを介して関連付けられたフィーチャを返します。
注意:

エンタープライズ ジオデータベースの場合、このパラメーターは ArcGIS Enterprise 10.7 以降を必要とします。

格納および付属物の関連付けのオプションは、ArcGIS Enterprise 10.8.1 以降を必要とします。

String
結果のネットワーク属性
(オプション)

結果に含めるネットワーク属性。

注意:

エンタープライズ ジオデータベースの場合、このパラメーターは ArcGIS Enterprise 10.7 以降を必要とします。

String
結果フィールド
(オプション)

結果として返されるフィーチャクラスのフィールド。 フィールドの値は、サブネットワーク内のフィーチャの結果に返されます。

注意:

エンタープライズ ジオデータベースの場合、このパラメーターは ArcGIS Enterprise 10.7 以降を必要とします。

Value Table
ドメインの説明を含める
(オプション)

ドメインの説明を出力 *.json ファイルに含めて、コントローラー、featureElements、接続性、関連付けのドメイン マッピングを伝えるかどうかを指定します。

  • オン - ドメインの説明を結果に含めます。
  • オフ - ドメインの説明を結果に含めません。 これがデフォルトです。

注意:

エンタープライズ ジオデータベースの場合、このパラメーターは ArcGIS Enterprise 10.9.1 以降を必要とします。

Boolean

派生した出力

ラベル説明データ タイプ
更新されたユーティリティ ネットワーク

更新されるユーティリティ ネットワーク。

Utility Network

arcpy.un.ExportSubnetwork(in_utility_network, domain_network, tier, subnetwork_name, export_acknowledged, out_json_file, {condition_barriers}, {function_barriers}, {include_barriers}, {traversability_scope}, {propagators}, {include_geometry}, {result_types}, {result_network_attributes}, {result_fields}, {include_domain_descriptions})
名前説明データ タイプ
in_utility_network

エクスポートするサブネットワークを含むユーティリティ ネットワーク。

Utility Network; Utility Network Layer
domain_network

サブネットワークが属しているドメイン ネットワーク。

String
tier

サブネットワークを含む層。

String
subnetwork_name

エクスポートするサブネットワークの名前。 指定したソースに対応する、サブネットワーク情報をエクスポートします。

String
export_acknowledged

Subnetworks テーブル内の対応するコントローラーと SubnetLine フィーチャクラス内のフィーチャの LASTACKEXPORTSUBNETWORK 属性を更新するかどうかを指定します。

  • ACKNOWLEDGESubnetworks テーブルで、対応するコントローラーの LASTACKEXPORTSUBNETWORK 属性を更新します。 削除対象の印 (Is deleted = True) をソースにつけた場合、そのソースが Subnetworks テーブルから削除されます。 このオプションでは、入力ユーティリティ ネットワークがデフォルト バージョンを参照する必要があります。
  • NO_ACKNOWLEDGESubnetworks テーブルで、対応するコントローラーの LASTACKEXPORTSUBNETWORK 属性を更新しません。 これがデフォルトです。
Boolean
out_json_file

生成される *.json ファイルの名前と場所。

File
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)。

条件バリアの 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] - 全体的なグローバル値とは対照的に、各方向で値を計算します。 たとえば、Shape length の合計を計算している関数バリアで、値が 4 以上になったときにトレースが終了する場合に使用します。 グローバル値の場合は、値が 2 の 2 つのエッジを通過すると、形状の長さの合計値 4 にすでに到達するため、トレースが停止します。 ローカル値を使用している場合は、各パスに沿ってローカル値が変化するため、トレースが続行します。

  • TRUEローカル値を使用します。
  • FALSEグローバル値を使用します。 これがデフォルトです。

関数バリアの function のオプションに指定できる値は次のとおりです。

  • AVERAGE入力値の平均値。
  • COUNTフィーチャの数。
  • MAX最大の入力値。
  • MIN最小の入力値。
  • ADD値を追加します。
  • SUBTRACT値を減算します。 サブネットワーク コントローラーおよびループ トレース タイプは、[減算] 関数をサポートしていません。

たとえば、始点フィーチャの値が 20 とします。 次のフィーチャは 30 の値を持っています。 [最小値] 関数を使用すると、結果が 20、最大値が 30、追加が 50、平均値が 25、個数が 2、減算が -10 になります。

関数バリアの [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)。
Value Table
include_barriers
(オプション)

通過可能性バリア フィーチャがトレース結果に含まれるかどうかを指定します。 通過可能性バリアは、サブネットワーク定義で事前に設定されている場合でも任意指定です。

  • INCLUDE_BARRIERS通過可能性バリアをトレース結果に含めます。 これがデフォルトです。
  • EXCLUDE_BARRIERS通過可能性バリアをトレース結果に含めません。
Boolean
traversability_scope
(オプション)

適用される通過可能性のタイプを指定します。 通過可能性範囲は、通過可能性がジャンクション、エッジ、またはその両方のいずれに適用されるかを決定します。 たとえば、DEVICESTATUSOpen ならばトレースを停止する、という条件バリアを定義したとしましょう。しかし、通過可能性スコープが「エッジのみ」であるとすれば、開いているデバイスを検出してもトレースは停止しません。DEVICESTATUS はジャンクションにしか適用されないからです。 つまり、このパラメーターは、トレースで、ジャンクション、エッジ、またはその両方を無視するかどうかを示します。

  • BOTH_JUNCTIONS_AND_EDGES通過可能性は、ジャンクションとエッジの両方に適用されます。
  • JUNCTIONS_ONLY通過可能性は、ジャンクションのみに適用されます。
  • EDGES_ONLY通過可能性は、エッジのみに適用されます。
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_INLCUDE_ANY値のビットが属性内に存在しないビット単位の論理積演算 (bitwise AND == False)。
Value Table
include_geometry
(オプション)

ジオメトリを結果に含めるかどうかを指定します。

  • INCLUDE_GEOMETRYジオメトリは結果に含まれます。
  • EXCLUDE_GEOMETRYジオメトリは結果に含まれません。 これがデフォルトです。
注意:

エンタープライズ ジオデータベースの場合、このパラメーターは ArcGIS Enterprise 10.7 以降を必要とします。

Boolean
result_types
[result_types,...]
(オプション)

返される結果のタイプを指定します。

  • CONNECTIVITYジオメトリの一致または接続性の関連付けを介して接続されるフィーチャを返します。 これがデフォルトです。
  • FEATURESフィーチャレベルの情報を返します。
  • CONTAINMENT_AND_ATTACHMENT_ASSOCIATIONS格納および構造物付属物の関連付けを介して関連付けられたフィーチャを返します。
注意:

エンタープライズ ジオデータベースの場合、このパラメーターは ArcGIS Enterprise 10.7 以降を必要とします。

格納および付属物の関連付けのオプションは、ArcGIS Enterprise 10.8.1 以降を必要とします。

String
result_network_attributes
[result_network_attributes,...]
(オプション)

結果に含めるネットワーク属性。

注意:

エンタープライズ ジオデータベースの場合、このパラメーターは ArcGIS Enterprise 10.7 以降を必要とします。

String
result_fields
[[Feature Class, Field Name],...]
(オプション)

結果として返されるフィーチャクラスのフィールド。 フィールドの値は、サブネットワーク内のフィーチャの結果に返されます。

注意:

エンタープライズ ジオデータベースの場合、このパラメーターは ArcGIS Enterprise 10.7 以降を必要とします。

Value Table
include_domain_descriptions
(オプション)

ドメインの説明を出力 *.json に含めて、コントローラー、featureElements、接続性、関連付けのドメイン マッピングを伝えるかどうかを指定します。

  • INCLUDE_DOMAIN_DESCRIPTIONSドメインの説明を結果に含めます。
  • EXCLUDE_DOMAIN_DESCRIPTIONSドメインの説明を結果に含めません。 これがデフォルトです。
注意:

エンタープライズ ジオデータベースの場合、このパラメーターは ArcGIS Enterprise 10.9.1 以降を必要とします。

Boolean

派生した出力

名前説明データ タイプ
out_utility_network

更新されるユーティリティ ネットワーク。

Utility Network

コードのサンプル

ExportSubnetwork の例 (Python ウィンドウ)

RMT002 というソースに対応するサブネットワーク情報を、ドメインの説明を含めて *.json ファイルにエクスポートします。

import arcpy
arcpy.ExportSubnetwork_un("Utility Network", "ElectricDistribution", 
                          "Medium Voltage", "RMT002", "ACKNOWLEDGE", 
                          "C:\\Temp\\RMT002clean.json", None, None, 
                          "INCLUDE_BARRIERS", "BOTH_JUNCTIONS_AND_EDGES", 
                          None, "EXCLUDE_GEOMETRY", None, None, None, 
                          "INCLUDE_DOMAIN_DESCRIPTIONS")

環境

このツールは、ジオプロセシング環境を使用しません。

ライセンス情報

  • Basic: No
  • Standard: Yes
  • Advanced: Yes

関連トピック