ClosestFacilitySolverProperties (arcpy.na)

サマリ

Provides access to analysis properties from a closest facility network analysis layer. The GetSolverProperties function is used to obtain a ClosestFacilitySolverProperties object from a closest facility network analysis layer.

説明

The ClosestFacilitySolverProperties object provides read and write access to all the analysis properties of a closest facility network analysis layer. The object can be used to modify the desired analysis properties of the closest facility layer, and the corresponding layer can be re-solved to determine the appropriate results. A new closest facility layer can be created using the Make Closest Facility Layer geoprocessing tool. Obtaining the ClosestFacilitySolverProperties object from a new closest facility layer allows you to reuse the existing layer for subsequent analyses rather than create a new layer for each analysis, which can be slow.

After modifying the properties on the ClosestFacilitySolverProperties object, the corresponding layer can be immediately used with other functions and geoprocessing tools. There is no refresh or update of the layer required to honor the changes modified through the object.

特性

プロパティ説明データ タイプ
accumulators
(読み書き)

解析時に累積されるネットワーク コスト属性のリストを取得または設定できます。空のリスト([])は、累積されるコスト属性がないことを表します。

String
attributeParameters
(読み書き)

解析で使用されるパラメータ化属性を取得または設定できます。プロパティは Python ディクショナリを返します。ディクショナリのキーは、属性名とパラメータで構成される 2 つの値の組み合わせです。ディクショナリ内の各アイテムの値はパラメータ値です。

パラメータ化されたネットワーク属性は、リアルタイムに変化する属性値をモデリングするために使用されます。たとえば、12 フィートの車高規制があるトンネルをパラメータを使用してモデリングできます。この場合、車両の高さ(フィート)をパラメータ値として指定する必要があります。車両の高さが 12 フィートを超えている場合は、この規制が true に評価され、トンネルの通行が規制されます。同様に、橋は重量規制を指定するパラメータを保持することができます。

attributeParameters プロパティを直接変更しようとしても、値は更新されません。常に新しいディクショナリ オブジェクトを使用して、プロパティの値を設定する必要があります。以下の 2 つのコード ブロックは、これらの 2 つの方法の違いを示しています。

#Don't attempt to modify the attributeParameters property in place.
#This coding method won't work.

solverProps.attributeParameters[('HeightRestriction', 'RestrictionUsage')] = "PROHIBITED"
#Modify the attributeParameters property using a new dictionary object.
#This coding method works. 

params = solverProps.attributeParameters
params[('HeightRestriction', 'RestrictionUsage')] = "PROHIBITED"
solverProps.attributeParameters = params
ネットワーク解析レイヤにパラメータ化属性がない場合、このプロパティは None を返します。

Dictionary
defaultCutoff
(読み書き)

指定されたインシデントに対して解析機能が施設の検索を中止する、デフォルトのインピーダンス値を取得または設定できます。値が None の場合は、カットオフが使用されません。

Double
defaultTargetFacilityCount
(読み書き)

インシデントごとに検索する最寄り施設の数を取得または設定できます。

Integer
impedance
(読み書き)

インピーダンスとして使用するネットワーク コスト属性を取得または設定できます。このコスト属性が最小となるように、最寄り施設および最寄り施設への最適なルートが決定されます。

String
outputPathShape
(読み書き)

解析で出力されるルート フィーチャの形状タイプを取得または設定できます。設定可能な値の一覧を次に示します。

  • TRUE_LINES_WITH_MEASURES(計測値を含む正確なライン)出力ルートはネットワーク ソースの正確な形状を保持します。リニア リファレンスのためのルートのメジャー値が出力に含まれます。メジャー値は、最初のストップから増加し、指定された位置に到着するまでの累積インピーダンスを記録します。
  • TRUE_LINES_WITHOUT_MEASURES(計測値を含まない正確なライン)出力ルートはネットワーク ソースの正確な形状を保持します。
  • STRAIGHT_LINES(直線)出力のルート形状は各インシデント~施設間を結ぶ 1 本の直線になります。
  • NO_LINES(ラインなし)出力ルートに形状は生成されません。
String
restrictions
(読み書き)

解析時に適用される規制属性のリストを取得または設定できます。空のリスト([])は、解析で使用される規制属性がないことを表します。

String
solverName
(読み取り専用)

解析プロパティ オブジェクトを取得するために使用されている Network Analyst レイヤが参照している解析の名前を返します。このプロパティは、ClosestFacilitySolverProperties オブジェクトからアクセスされたときに必ず文字列「Closest Facility Solver」を返します。

String
timeOfDay
(読み書き)

ルートの開始または終了の日時を取得または設定できます。この値の解釈は、timeOfDayUsage プロパティが START_TIME または END_TIME のどちらに設定されているかで異なります。値に None を指定すると、日付と時刻は使用されません。

特定の日付を使用する代わりに、次の日付を使用して曜日を指定することができます。

  • 今日 - 1899/12/30
  • 日 - 1899/12/31
  • 月 - 1900/1/1
  • 火 - 1900/1/2
  • 水 - 1900/1/3
  • 木 - 19001/4
  • 金 - 1900/1/5
  • 土 - 1900/1/6

たとえば、ルートの開始または終了を月曜日の午前 8:00 に指定するには、「datetime.datetime(1900, 1, 1, 8,0,0)」という値を指定します。

DateTime
timeOfDayUsage
(読み書き)

timeOfDay プロパティの値が、ルートの到着時間と出発時間のどちらを表すかを制御します。設定可能な値の一覧を次に示します。

  • END_TIMEルートは timeOfDay プロパティに設定した時間に施設またはインシデントに到着します。この選択は到着時間が重要な場合、つまり、指定した時間に目的地に到着するには何時に出発しなければならないかを確認したいときに有効です。
  • START_TIMEルートは timeOfDay プロパティに設定した時間に施設またはインシデントから出発します。この選択は、出発時刻に対して最適なルートを検索するときに有効です。
  • NOT_USEDルートは開始日時または終了日時を使用しません。この選択は、timeOfDay プロパティの値が None であるときに使用します。
String
travelDirection
(読み書き)

解析中に施設とインシデント間の移動方向を取得または設定できます。設定可能な値の一覧を次に示します。

  • TRAVEL_FROM移動する方向は施設からインシデントの方向になります。
  • TRAVEL_TO移動する方向はインシデントから施設の方向になります。
String
useHierarchy
(読み書き)

解析を実行しているときの階層属性の使用を制御します。設定可能な値の一覧を次に示します。

  • USE_HIERARCHY(階層を使用) 階層属性を解析に使用します。階層を使用すると、解析は下位ランクのエッジよりも上位ランクのエッジを優先します。階層解析は、より高速で、運転者が遠回りであっても一般道路の代わりに高速道路を利用する状況をシミュレートするのに使用できます。このオプションは、Network Analyst レイヤが参照しているネットワーク データセットに階層属性がある場合のみ適用されます。値を True に設定することでも、このオプションを指定できます。
  • NO_HIERARCHY(階層を使用しない)階層属性を解析に使用しません。階層を使用しないことで、ネットワーク データセットの正確なルートが検索されます。値を False に設定することでも、このオプションを指定できます。
String
uTurns
(読み書き)

ストップ間のネットワーク移動中に発生する可能性のあるジャンクションでの U ターンを、解析でどのように処理するかを指定するポリシーを取得または設定できます。設定可能な値の一覧を次に示します。

  • ALLOW_UTURNS(U ターンを許可)任意の数の接続されたエッジを持つジャンクションで U ターンを許可します。
  • NO_UTURNS(U ターンを規制)ジャンクションの結合にかかわらず、すべてのジャンクションで U ターンを禁止します。ただし、この設定が選択されている場合でも、ネットワーク ロケーションでは U ターンが許可されます。同様に、個々のネットワーク ロケーションの CurbApproach プロパティで U ターンを禁止するように設定できます。
  • ALLOW_DEAD_ENDS_ONLY(行き止まりのみ許可)1 つの隣接エッジを持つジャンクション(行き止まり)を除くすべてのジャンクションでの U ターンを禁止します。
  • ALLOW_DEAD_ENDS_AND_INTERSECTIONS_ONLY2 つの隣接するエッジが接するジャンクションでの U ターンを禁止します。ただし、交差点(3 つ以上の隣接エッジを持つジャンクション)および行き止まり(1 つの隣接エッジを持つジャンクション)では U ターンを許可します。ネットワークには、道路セグメントの中間に無関係のジャンクションが存在する場合があります。このオプションは、これらの場所で車両が U ターンすることを防ぎます。
String

コードのサンプル

ClosestFacilitySolverProperties example (Python window)

The script shows how to update a closest facility network analysis layer to find three facilities without using a cutoff value. It assumes that a closest facility layer called Closest Hospitals has been created in a new map document based on the tutorial network dataset for San Francisco region.

#Get the closest facility layer object from a layer named "Closest Hospitals" in
#the table of contents
cfLayer = arcpy.mapping.Layer("Closest Hospitals")

#Get the closest facility solver properties object from the closest facility layer
solverProps = arcpy.na.GetSolverProperties(cfLayer)

#Update the properties for the closest facility layer using the closest facility
#solver properties object
solverProps.defaultCutoff = None
solverProps.defaultTargetFacilityCount = 3

関連トピック

9/14/2013