GridAnalystSetting (iObjects Java Help)

java.lang.Object
- com.supermap.mobjects.common.GridAnalystSetting

```
public class GridAnalystSetting
extends Object
```
栅格分析环境设置类。用于提供栅格分析前基本环境设置的相关信息。
在调用栅格分析接口时，需要设置很多参数，且每次调用都要重新设置，比较繁琐。为了减少用户的工作量，简化相关接口的使用，SuperMap组件产品提供栅格分析环境设置（GridAnalystSetting）类，将栅格分析接口中通用的参数提取出来，统一设置。栅格分析环境的设置，会在一定程度上影响栅格分析的结果。

栅格分析环境设置，主要包括对地理范围、单元格大小、有效分析区域的数据有效区域、像素格式及目标路径等参数进行设定。目前，栅格分析环境的设置，只对矢栅转换（ConversionAnalyst）类、距离栅格分析（DistanceAnalyst）、栅格概况操作（GeneralizeAnalyst）、插值分析（Interpolator）类、栅格代数运算（MathAnalyst）类、和通视分析（VisibilityAnalyst）类中的分析功能有效。通过类的方法来设置该类是否使用栅格分析环境对象的参数设置，如 ConversionAnalyst.setAnalystSetting 方法。

注意：栅格分析环境的各个参数设置并不都对以上各类有效，其具体的支持情况如下表所示：

注：

① 对于距离分析，get/setBoundsType、get/setBounds、get/setCellSizeType、get/setCellSize 只对 costDistance 和 straightDistance 方法有效。

② 对于可视性分析，get/setOutputDatasource、is/setShowProgress 只对 calculateViewShed 方法有效。

③ 栅格代数运算中，executeFromXML 是否显示进度条由 toXMLFile 写入的值决定。

需要强调的是：在调用支持栅格分析环境设置的类的接口时，如果设置了栅格分析环境，调用的接口的参数设置的优先级高于栅格分析环境中对应的参数设置，且接口中与栅格分析环境设置中的参数对应的参数，如果设置为 null，则分析时读取栅格分析环境中该参数的设置。

构造器概要

构造器
构造器和说明
`GridAnalystSetting()` 构造一个新的 GridAnalystSetting 对象。
`GridAnalystSetting(GridAnalystSetting gridAnalystSetting)` 根据给定的 GridAnalystSetting 对象构造一个与其完全相同的新对象。

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`Rectangle2D`	`getBounds()` 返回结果数据集的地理范围。
`BoundsType`	`getBoundsType()` 返回结果数据的地理范围类型。
`double`	`getCellSize()` 返回结果栅格数据集的单元格大小。
`CellSizeType`	`getCellSizeType()` 返回结果数据集的单元格大小类型。
`String`	`getGridOutputNamePrefix()` 返回栅格数据集的名称前缀。
`Datasource`	`getOutputDatasource()` 返回用于存储结果数据集的数据源。
`PixelFormat`	`getPixelFormat()` 已过时。
`boolean`	`getUseNoValue()` 已过时。
`GeoRegion`	`getValidRegion()` 返回数据集的有效分析区域。
`String`	`getVectorOutputNamePrefix()` 返回矢量数据集的名称前缀。
`boolean`	`isShowProgress()` 返回是否显示进度条。
`void`	`setBounds(Rectangle2D value)` 设置结果数据集的地理范围。
`void`	`setBoundsType(BoundsType value)` 设置结果数据的地理范围类型。
`void`	`setCellSize(double value)` 设置结果栅格数据集的单元格大小。
`void`	`setCellSizeType(CellSizeType value)` 设置结果数据集的单元格大小类型。
`void`	`setGridOutputNamePrefix(String value)` 设置栅格数据集的名称前缀。
`void`	`setOutputDatasource(Datasource value)` 设置用于存储结果数据集的数据源。
`void`	`setPixelFormat(PixelFormat value)` 已过时。
`void`	`setShowProgress(boolean value)` 设置是否显示进度条。
`void`	`setUseNoValue(boolean value)` 已过时。
`void`	`setValidRegion(GeoRegion value)` 设置数据集的有效分析区域。
`void`	`setVectorOutputNamePrefix(String value)` 设置矢量数据集的名称前缀。

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

- 构造器详细资料
  - GridAnalystSetting
```
public GridAnalystSetting()
```
    构造一个新的 GridAnalystSetting 对象。
  - GridAnalystSetting
```
public GridAnalystSetting(GridAnalystSetting gridAnalystSetting)
```
    根据给定的 GridAnalystSetting 对象构造一个与其完全相同的新对象。
    
    参数:
    
    gridAnalystSetting -
- 方法详细资料
  - getBoundsType
```
public BoundsType getBoundsType()
```
    返回结果数据的地理范围类型。
    
    返回:
    
    结果数据集的地理范围类型。
    
    默认值:
    
    默认值为 BoundsType.INTERSECTION 类型。
  - setBoundsType
```
public void setBoundsType(BoundsType value)
```
    设置结果数据的地理范围类型。
    
    参数:
    
    value - 结果数据集的地理范围类型。
  - getBounds
```
public Rectangle2D getBounds()
```
    返回结果数据集的地理范围。
    
    返回:
    
    结果数据集的地理范围。
    
    默认值:
    
    默认值为 Rectangle(0,0,0,0)。
  - setBounds
```
public void setBounds(Rectangle2D value)
```
    设置结果数据集的地理范围。
    只有结果地理范围的设置方式 BoundsType 为自定义范围类型 CUSTOM 时，才可以对该方法进行修改。
    
    参数:
    
    value - 结果数据集的地理范围。
  - getCellSizeType
```
public CellSizeType getCellSizeType()
```
    返回结果数据集的单元格大小类型。
    
    返回:
    
    结果数据集的单元格大小类型。
    
    默认值:
    
    默认值为 MIN。
  - setCellSizeType
```
public void setCellSizeType(CellSizeType value)
```
    设置结果数据集的单元格大小类型。
    
    参数:
    
    value - 结果数据集的单元格大小类型。
  - getCellSize
```
public double getCellSize()
```
    返回结果栅格数据集的单元格大小。单位与结果栅格数据集的坐标系单位相同。
    
    返回:
    
    结果栅格数据集的单元格大小。
    
    默认值:
    
    默认值为 0.0。
  - setCellSize
```
public void setCellSize(double value)
```
    设置结果栅格数据集的单元格大小。单位与结果栅格数据集的坐标系单位相同。
    只有结果栅格数据集单元格大小类型 CellSizeType 为 CUSTOM 时，才可以对该方法进行修改。
    
    参数:
    
    value - 结果栅格数据集的单元格大小。
  - getValidRegion
```
public GeoRegion getValidRegion()
```
    返回数据集的有效分析区域。
    
    返回:
    
    数据集的有效分析区域。
    
    默认值:
    
    默认值为 null，即用户设置的分析范围。
  - setValidRegion
```
public void setValidRegion(GeoRegion value)
```
    设置数据集的有效分析区域。
    
    参数:
    
    value - 数据集的有效分析区域。
  - getGridOutputNamePrefix
```
public String getGridOutputNamePrefix()
```
    返回栅格数据集的名称前缀。
    
    返回:
    
    栅格数据集的名称前缀。
    
    默认值:
    
    默认值为 null。
  - setGridOutputNamePrefix
```
public void setGridOutputNamePrefix(String value)
```
    设置栅格数据集的名称前缀。
    
    参数:
    
    value - 栅格数据集的名称前缀。
  - getVectorOutputNamePrefix
```
public String getVectorOutputNamePrefix()
```
    返回矢量数据集的名称前缀。
    
    返回:
    
    矢量数据集的名称前缀。
    
    默认值:
    
    默认值为 null。
  - setVectorOutputNamePrefix
```
public void setVectorOutputNamePrefix(String value)
```
    设置矢量数据集的名称前缀。
    
    参数:
    
    value - 矢量数据集的名称前缀。
    
    默认值:
    
    默认值为 null。
  - getOutputDatasource
```
public Datasource getOutputDatasource()
```
    返回用于存储结果数据集的数据源。
    
    返回:
    
    用于存储结果数据集的数据源。
    
    默认值:
    
    默认值为 null。
  - setOutputDatasource
```
public void setOutputDatasource(Datasource value)
```
    设置用于存储结果数据集的数据源。
    
    参数:
    
    value - 用于存储结果数据集的数据源。
  - isShowProgress
```
public boolean isShowProgress()
```
    返回是否显示进度条。
    
    返回:
    
    一个布尔值，表示是否显示进度条，如果为 true 表示显示进度条，否则不显示。
    
    默认值:
    
    默认值为 true。
  - setShowProgress
```
public void setShowProgress(boolean value)
```
    设置是否显示进度条。
    
    参数:
    
    value - 是否显示进度条。
  - getUseNoValue
```
@Deprecated
public boolean getUseNoValue()
```
    已过时。
    
    返回:
    
    空值是否参与运算默认为FALSE
  - setUseNoValue
```
@Deprecated
public void setUseNoValue(boolean value)
```
    已过时。
    
    参数:
    
    value - 空值是否参与运算
  - getPixelFormat
```
@Deprecated
public PixelFormat getPixelFormat()
```
    已过时。
    
    返回:
    
    数据集的像素格式默认为DOUBLE
  - setPixelFormat
```
@Deprecated
public void setPixelFormat(PixelFormat value)
```
    已过时。
    
    参数:
    
    value - 数据集的像素格式

类 GridAnalystSetting

构造器概要

方法概要

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

构造器详细资料

GridAnalystSetting

GridAnalystSetting

方法详细资料

getBoundsType

setBoundsType

getBounds

setBounds

getCellSizeType

setCellSizeType

getCellSize

setCellSize

getValidRegion

setValidRegion

getGridOutputNamePrefix

setGridOutputNamePrefix

getVectorOutputNamePrefix

setVectorOutputNamePrefix

getOutputDatasource

setOutputDatasource

isShowProgress

setShowProgress

getUseNoValue

setUseNoValue

getPixelFormat

setPixelFormat