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
(読み書き)

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:

  • TRUE_LINES_WITH_MEASURESThe output routes will have the exact shape of the underlying network sources. Furthermore, the output includes route measurements for linear referencing. The measurements increase from the first stop and record the cumulative impedance to reach a given position.
  • TRUE_LINES_WITHOUT_MEASURESThe output routes will have the exact shape of the underlying network sources.
  • STRAIGHT_LINESThe output route shape will be a single straight line between each of the incident-facility pair.
  • NO_LINESNo shape will be generated for the output routes.
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.

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

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:

  • END_TIMEThe routes arrive at the facilities or incidents at the time you set in the timeOfDay property. This choice is useful if arrival time is more important; that is, you want to know what time you need to leave in order to arrive at your destination at a given time.
  • START_TIMEThe routes depart from the facilities or incidents at the time you set in the timeOfDay property. This choice is useful to find the best routes given a departure time.
  • NOT_USEDThe routes do not use a start or end time and date. This choice should be used if the timeOfDay property has a value of None.
String
timeZoneUsage
(読み書き)

Specifies the time zone of the timeOfDay parameter.

  • GEO_LOCALThe timeOfDay parameter refers to the time zone in which the facilities or incidents are located. If timeOfDayUsage is set to Start_Time and travelDirection is TRAVEL_FROM, this is the time zone of the facilities. If timeOfDayUsage is set to Start_Time and travelDirection is TRAVEL_TO, this is the time zone of the incidents. If timeOfDayUsage is set to End_Time and travelDirection is TRAVEL_FROM, this is the time zone of the incidents. If timeOfDayUsage is set to End_Time and travelDirection is TRAVEL_TO, this is the time zone of the facilities.
  • UTCThe timeOfDay parameter refers to Coordinated Universal Time (UTC). Choose this option if you want to find what's nearest for a specific time, such as now, but aren't certain in which time zone the facilities or incidents will be located.

Irrespective of the timeZoneUsage setting, if your facilities and incidents are in multiple time zones, the following rules are enforced by the tool:

  • All incidents must be in the same time zone when

    • Specifying a start time and traveling from incident to facility
    • Specifying an end time and traveling from facility to incident

  • All facilities must be in the same time zone when

    • Specifying a start time and traveling from facility to incident
    • Specifying an end time and traveling from incident to facility

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:

  • TRAVEL_FROMDirection of travel is from facilities to incidents.
  • TRAVEL_TODirection of travel is from incidents to facilities.
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

関連トピック

4/26/2014