LocationAnalystParameter (iObjects Java Help)

java.lang.Object
- com.supermap.data.InternalHandle
- - com.supermap.data.InternalHandleDisposable
  - - com.supermap.analyst.networkanalyst.LocationAnalystParameter

所有已实现的接口:

IDisposable
```
public class LocationAnalystParameter
extends com.supermap.data.InternalHandleDisposable
```
选址分区分析参数类。
为选址分区分析提供必要的参数信息，包括是否从资源中心分配、资源供给中心集合、权值字段信息的名称、转向权值字段，以及期望的供给中心数量等。

构造器概要

构造器
构造器和说明
`LocationAnalystParameter()` 构造一个新的选址分区分析参数对象。
`LocationAnalystParameter(LocationAnalystParameter parameter)` 根据给定的选址分区分析参数对象构造一个新的与其完全相同的选址分区分析参数对象。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`dispose()` 释放该对象所占用的资源。
`int`	`getExpectedSupplyCenterCount()` 返回期望用于最终设施选址的资源供给中心数量。
`String`	`getNodeDemandField()` 返回结点需求量字段。
`SupplyCenters`	`getSupplyCenters()` 返回资源供给中心集合。
`String`	`getTurnWeightField()` 返回转向权值字段，该字段是交通网络分析环境设置中指定的转向权值字段集合中的一员。
`String`	`getWeightName()` 返回权值字段信息的名称，即交通网络分析环境设置中指定的权值字段信息集合对象（`WeightFieldInfos` 类对象）中的某一个权值字段信息对象（`WeightFieldInfo` 类对象）的 `setName()` 方法值。
`boolean`	`isFromCenter()` 返回是否从资源供给中心开始分配资源。
`void`	`setExpectedSupplyCenterCount(int value)` 设置期望用于最终设施选址的资源供给中心数量。
`void`	`setFromCenter(boolean value)` 设置是否从资源供给中心开始分配资源。
`void`	`setNodeDemandField(String value)` 设置结点需求量字段。
`void`	`setSupplyCenters(SupplyCenters value)` 设置资源供给中心集合。
`void`	`setTurnWeightField(String value)` 设置转向权值字段，该字段是交通网络分析环境设置中指定的转向权值字段集合中的一员。
`void`	`setWeightName(String value)` 设置权值字段信息的名称，即交通网络分析环境设置中指定的权值字段信息集合对象（`WeightFieldInfos` 类对象）中的某一个权值字段信息对象（`WeightFieldInfo` 类对象）的 `setName()` 方法值。

从类继承的方法 com.supermap.data.InternalHandleDisposable
makeSureNativeObjectLive

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - LocationAnalystParameter
```
public LocationAnalystParameter()
```
    构造一个新的选址分区分析参数对象。
  - LocationAnalystParameter
```
public LocationAnalystParameter(LocationAnalystParameter parameter)
```
    根据给定的选址分区分析参数对象构造一个新的与其完全相同的选址分区分析参数对象。
    
    参数:
    
    parameter - 给定的选址分区分析参数对象。
- 方法详细资料
  - setSupplyCenters
```
public void setSupplyCenters(SupplyCenters value)
```
    设置资源供给中心集合。
    
    参数:
    
    value - 资源供给中心集合。
  - getSupplyCenters
```
public SupplyCenters getSupplyCenters()
```
    返回资源供给中心集合。
    
    返回:
    
    资源供给中心集合。
    
    另请参阅:
    
    SupplyCenters
    
    默认值:
    
    默认值为一个新构造的 SupplyCenters 对象。
  - getNodeDemandField
```
public String getNodeDemandField()
```
    返回结点需求量字段。该字段是网络数据集中，用于表示网络结点作为需求地的所需资源量的字段名称。
    
    返回:
    
    结点需求量字段。
  - setNodeDemandField
```
public void setNodeDemandField(String value)
```
    设置结点需求量字段。该字段是网络数据集中，用于表示网络结点作为需求地的所需资源量的字段名称。
    
    参数:
    
    value - 结点需求量字段。
  - getExpectedSupplyCenterCount
```
public int getExpectedSupplyCenterCount()
```
    返回期望用于最终设施选址的资源供给中心数量。当输入值为0时，最终设施选址的资源供给中心数量默认为覆盖分析区域内的所需最少的供给中心数。
    
    返回:
    
    期望的用于最终设施选址的资源供给中心数量。
    
    默认值:
    
    默认值为 0。
  - setExpectedSupplyCenterCount
```
public void setExpectedSupplyCenterCount(int value)
```
    设置期望用于最终设施选址的资源供给中心数量。当输入值为0时，最终设施选址的资源供给中心数量默认为覆盖分析区域内的所需最少的供给中心数。
    
    参数:
    
    value - 期望的用于最终设施选址的资源供给中心数量。
    
    默认值:
    
    默认值为 0。
  - isFromCenter
```
public boolean isFromCenter()
```
    返回是否从资源供给中心开始分配资源。
    由于网络数据中的弧段具有正反阻力，即弧段的正向阻力值与其反向阻力值可能不同，因此，在进行分析时，从资源供给中心开始分配资源到需求点与从需求点向资源供给中心分配这两种分配形式下，所得的分析结果会不同。
    
    下面例举两个实际的应用场景，帮助进一步理解两种形式的差异，假设网络数据集中弧段的正反阻力值不同。
    1. 从资源供给中心开始分配资源到需求点：
    2. 不从资源供给中心开始分配资源：
    返回:
    
    从资源供给中心开始分配，返回 true；否则返回 false。
    
    默认值:
    
    默认值为 true。
  - setFromCenter
```
public void setFromCenter(boolean value)
```
    设置是否从资源供给中心开始分配资源。
    由于网络数据中的弧段具有正反阻力，即弧段的正向阻力值与其反向阻力值可能不同，因此，在进行分析时，从资源供给中心开始分配资源到需求点与从需求点向资源供给中心分配这两种分配形式下，所得的分析结果会不同。
    
    下面例举两个实际的应用场景，帮助进一步理解两种形式的差异，假设网络数据集中弧段的正反阻力值不同。
    1. 从资源供给中心开始分配资源到需求点：
    2. 不从资源供给中心开始分配资源：
    参数:
    
    value - 指定是否从资源供给中心开始分配资源。
  - setTurnWeightField
```
public void setTurnWeightField(String value)
```
    设置转向权值字段，该字段是交通网络分析环境设置中指定的转向权值字段集合中的一员。
    
    参数:
    
    value - 转向权值字段。
  - getTurnWeightField
```
public String getTurnWeightField()
```
    返回转向权值字段，该字段是交通网络分析环境设置中指定的转向权值字段集合中的一员。
    
    返回:
    
    转向权值字段。
    
    默认值:
    
    默认值为一个空的字符串。
  - setWeightName
```
public void setWeightName(String value)
```
    设置权值字段信息的名称，即交通网络分析环境设置中指定的权值字段信息集合对象（WeightFieldInfos 类对象）中的某一个权值字段信息对象（WeightFieldInfo 类对象）的 setName() 方法值。
    
    参数:
    
    value - 权值字段信息的名称。
  - getWeightName
```
public String getWeightName()
```
    返回权值字段信息的名称，即交通网络分析环境设置中指定的权值字段信息集合对象（WeightFieldInfos 类对象）中的某一个权值字段信息对象（WeightFieldInfo 类对象）的 setName() 方法值。
    
    返回:
    
    权值字段信息的名称。
    
    默认值:
    
    默认值为一个空的字符串。
  - dispose
```
public void dispose()
```
    释放该对象所占用的资源。当调用该方法之后，此对象不再可用。

类 LocationAnalystParameter

构造器概要

方法概要

从类继承的方法 com.supermap.data.InternalHandleDisposable

从类继承的方法 java.lang.Object

构造器详细资料

LocationAnalystParameter

LocationAnalystParameter

方法详细资料

setSupplyCenters

getSupplyCenters

getNodeDemandField

setNodeDemandField

getExpectedSupplyCenterCount

setExpectedSupplyCenterCount

isFromCenter

setFromCenter

setTurnWeightField

getTurnWeightField

setWeightName

getWeightName

dispose