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 つの方法の違いを示しています。
| Dictionary |
defaultCutoff (読み書き) | Provides the ability to get or set the default impedance value at which the solver will stop searching for facilities for a given incident. A value of None is used to specify that no cutoff should be used. | Double |
defaultTargetFacilityCount (読み書き) | Provides the ability to get or set the number of closest facilities to find per incident. | Integer |
impedance (読み書き) | Provides the ability to get or set the network cost attribute used as impedance. This cost attribute is minimized while determining the closest facility and the best route to the closest facility. | String |
outputPathShape (読み書き) | Provides the ability to get or set the shape type for the route features that are output by the solver. The following is a list of possible values:
| String |
restrictions (読み書き) | 解析時に適用される規制属性のリストを取得または設定できます。空のリスト([])は、解析で使用される規制属性がないことを表します。 | String |
solverName (読み取り専用) | Returns the name of the solver being referenced by the Network Analyst layer used to obtain the solver properties object. The property always returns the string value Closest Facility Solver when accessed from a ClosestFacilitySolverProperties object. | String |
timeOfDay (読み書き) | Provides the ability to get or set the time and date at which the routes should begin or end. The interpretation of this value depends on whether timeOfDayUsage property is set to START_TIME or END_TIME. A value of None can be used to specify that no date and time should be used. Instead of using a particular date, a day of the week can be specified using the following dates.
For example, to specify that the route should start or end at 8:00 a.m. on Monday, specify the value as datetime.datetime(1900, 1, 1, 8,0,0). The timeZoneUsage parameter specifies whether the date and time refer to UTC or the time zone in which the facilities or incidents are located. | DateTime |
timeOfDayUsage (読み書き) | Controls whether the value of the timeOfDay property represents the arrival or departure times for the routes. The following is a list of possible values:
| String |
timeZoneUsage (読み書き) | Specifies the time zone of the timeOfDay parameter.
Irrespective of the timeZoneUsage setting, if your facilities and incidents are in multiple time zones, the following rules are enforced by the tool:
| String |
travelDirection (読み書き) | Provides the ability to get or set the direction of travel between facilities and incidents during the analysis. The following is a list of possible values:
| String |
useHierarchy (読み書き) | 解析を実行しているときの階層属性の使用を制御します。設定可能な値の一覧を次に示します。
| String |
uTurns (読み書き) | ストップ間のネットワーク移動中に発生する可能性のあるジャンクションでの U ターンを、解析でどのように処理するかを指定するポリシーを取得または設定できます。設定可能な値の一覧を次に示します。
| String |
コードのサンプル
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