public class LocationAnalystParameter
extends java.lang.Object
implements java.io.Serializable
The location-allocation analysis parameter class.
provides the required parameters for the location-allocation analysis including whether to allocate resources from the supply center, supply centers, the weight field name, the turn weight field, the expected number of supply centers, etc.
Modifier and Type | Field and Description |
---|---|
int |
expectedSupplyCenterCount
The expected number of supply centers for location-allocation analysis.
|
boolean |
isFromCenter
Determines whether to allocate resources from supply center.
|
boolean |
returnNodeFeatures
Whether to return attribute information of the result edge.
|
SupplyCenterCollection |
supplyCenters
The resource supply center collection.
|
java.lang.String |
turnWeightField
The name of the turn weight field.
|
java.lang.String |
weightName
Denotes the field name of the weight field.
|
Constructor and Description |
---|
LocationAnalystParameter()
The Constructor.
|
LocationAnalystParameter(LocationAnalystParameter locationAnalystParameter)
The Constructor.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Compares whether the specified object equals to the current
LocationAnalystParameter object. |
int |
hashCode()
Gets the hash code value of the location-allocation parameter object.
|
public boolean returnNodeFeatures
Whether to return attribute information of the result edge. Default is true.
public int expectedSupplyCenterCount
The expected number of supply centers for location-allocation analysis.
When the value is 0, the resources supply centers amount of the final facilities locations is default to be the least needed supply centers number that covers the analysis area
public SupplyCenterCollection supplyCenters
The resource supply center collection.
The resource supply center collection contains information of resources supply center.
public java.lang.String turnWeightField
The name of the turn weight field.
public java.lang.String weightName
Denotes the field name of the weight field.
The weight used by the location-allocation analysis contains forward and reverse weights. WeightFieldInfo
specifies the name of forward and reverse weight fields. The environmental settings of the transportation network analysis (TransportationAnalystSetting
) specifies weight field information collection (weightFieldInfos
). weightName is the name of a object.
public boolean isFromCenter
Determines whether to allocate resources from supply center.
True denotes allocating from SupplyCenter, while false denotes not.
The edge in network data has both from-to impedance and to-from impedance, which may not be the same. Therefore, allocating resources from supply center to demand node and allocating resources from demand node to supply center may have different analysis result.
The two examples below will help you better understand the difference. Given that the from-to impedance and the to-from impedance of the edge are different.
public LocationAnalystParameter(LocationAnalystParameter locationAnalystParameter)
The Constructor.
locationAnalystParameter
- The location-allocation parameterspublic LocationAnalystParameter()
The Constructor.
public int hashCode()
Gets the hash code value of the location-allocation parameter object.
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
Compares whether the specified object equals to the current LocationAnalystParameter
object.
equals
in class java.lang.Object
obj
- Object that compares with the current LocationAnalystParameter
object.