TerrainAnalystSetting (iObjects Java Help)

java.lang.Object
- com.supermap.analyst.spatialanalyst.TerrainAnalystSetting

```
public class TerrainAnalystSetting
extends Object
```
地形分析基本环境设置类。该类用于提供地形分析时所需要的所有参数信息。

构造器概要

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

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`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

- 构造器详细资料
  - TerrainAnalystSetting
```
public TerrainAnalystSetting()
```
    构造一个新的 TerrainAnalystSetting 对象。
  - TerrainAnalystSetting
```
public TerrainAnalystSetting(TerrainAnalystSetting terraindAnalystSetting)
```
    根据给定的 TerrainAnalystSetting 对象构造一个与其完全相同的新对象。
    
    参数:
    
    terraindAnalystSetting - 给定的地形分析设置类对象。
- 方法详细资料
  - getBoundsType
```
public BoundsType getBoundsType()
```
    获取分析范围类型。
    
    返回:
    
    分析范围类型，默认为 Intersection 类型。
  - setBoundsType
```
public void setBoundsType(BoundsType value)
```
    设置分析范围类型。
    
    参数:
    
    value - 分析范围类型，默认值为输入栅格数据集的交集。
  - getBounds
```
public Rectangle2D getBounds()
```
    获取结果数据集的地理范围。
    只有 BoundType 为 Custom 时，才可以对其修改。
    
    返回:
    
    结果数据集的地理范围。默认为 Rectangle(0,0,0,0)
  - setBounds
```
public void setBounds(Rectangle2D value)
```
    设置结果数据集的地理范围。
    
    参数:
    
    value - 默认值为输入栅格数据集的交集。
  - getCellSizeType
```
public CellSizeType getCellSizeType()
```
    获取结果数据集的单元格的类型。
    
    返回:
    
    单元格类型。
  - setCellSizeType
```
public void setCellSizeType(CellSizeType value)
```
    设置结果数据集的单元格类型。
    
    参数:
    
    value - 结果数据集单元格的类型。默认值为输入栅格数据集中单元格最小值，即 CellSizeType.Min。
  - getCellSize
```
public double getCellSize()
```
    获取结果栅格数据集的单元格大小。单位与结果栅格数据集的坐标系单位相同。
    
    返回:
    
    结果栅格数据集的单元格大小。
  - setCellSize
```
public void setCellSize(double value)
```
    设置结果栅格数据集的单元格大小。单位与结果栅格数据集的坐标系单位相同。
    只当结果栅格数据集的单元格类型（setCellSizeType 方法）为 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 - 矢量数据集的名称前缀。
  - getOutputDatasource
```
public Datasource getOutputDatasource()
```
    获取存储结果数据集的数据源。
    
    返回:
    
    存储结果数据集的数据源。默认值为 null。
  - setOutputDatasource
```
public void setOutputDatasource(Datasource value)
```
    设置存储结果数据集的数据源。
    
    参数:
    
    value - 存储结果数据集的数据源。
  - isShowProgress
```
public boolean isShowProgress()
```
    返回是否显示进度条。
    
    返回:
    
    一个布尔值，表示是否显示进度条，如果为 true 表示显示进度条，否则不显示。
    
    默认值:
    
    默认值为 false。
  - 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 - 数据集的像素格式

类 TerrainAnalystSetting

构造器概要

方法概要

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

构造器详细资料

TerrainAnalystSetting

TerrainAnalystSetting

方法详细资料

getBoundsType

setBoundsType

getBounds

setBounds

getCellSizeType

setCellSizeType

getCellSize

setCellSize

getValidRegion

setValidRegion

getGridOutputNamePrefix

setGridOutputNamePrefix

getVectorOutputNamePrefix

setVectorOutputNamePrefix

getOutputDatasource

setOutputDatasource

isShowProgress

setShowProgress

getUseNoValue

setUseNoValue

getPixelFormat

setPixelFormat