CalibrateOptions (iObjects Java Help)

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

```
public class CalibrateOptions
extends Object
```
路由校准选项类。用于动态分段中的校准路由（calibrateRoutes）的有关参数的设置，如设置校准容限、是否保留没有参考点经过的路由等。

构造器概要

构造器
构造器和说明
`CalibrateOptions()` 构造一个新的 CalibrateOptions 对象。
`CalibrateOptions(CalibrateMode mode, double tolerance)` 根据指定的参数来构造一个 CalibrateOptions 的新对象。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`disableAll()` 将所有返回值为布尔型的参数项设置为 false。
`void`	`enableAll()` 将所有返回值为布尔型的参数项设置为 true。
`String`	`getErrorInfoField()` 返回错误信息字段。
`boolean`	`getIgnoringGaps()` 返回是否忽略子对象的间隔。
`boolean`	`getRetainingAllRoutes()` 返回结果路由数据集中是否保留没有参考点经过的路由对象。
`CalibrateMode`	`getRouteCalibrationMode()` 返回校准模式。
`double`	`getTolerance()` 返回校准容限。
`Unit`	`getToleranceUnit()` 返回校准容限的单位。
`void`	`setErrorInfoField(String value)` 设置错误信息字段。
`void`	`setIgnoringGaps(boolean value)` 设置是否忽略子对象的间隔。
`void`	`setRetainingAllRoutes(boolean value)` 设置结果路由数据集中是否保留没有参考点经过的路线对象。
`void`	`setRouteCalibrationMode(CalibrateMode value)` 设置校准模式。
`void`	`setTolerance(double value)` 设置校准容限。
`void`	`setToleranceUnit(Unit value)` 设置校准容限的单位。

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

- 构造器详细资料
  - CalibrateOptions
```
public CalibrateOptions()
```
    构造一个新的 CalibrateOptions 对象。
  - CalibrateOptions
```
public CalibrateOptions(CalibrateMode mode,
                        double tolerance)
```
    根据指定的参数来构造一个 CalibrateOptions 的新对象。
    
    参数:
    
    mode - 指定的校准模式。
    
    tolerance - 指定的校准容限。当参考点到对应路由的垂距大于指定的校准容限时，该参考点将不参与校准路由。
- 方法详细资料
  - enableAll
```
public void enableAll()
```
    将所有返回值为布尔型的参数项设置为 true。
  - disableAll
```
public void disableAll()
```
    将所有返回值为布尔型的参数项设置为 false。
  - getRouteCalibrationMode
```
public CalibrateMode getRouteCalibrationMode()
```
    返回校准模式。
    
    返回:
    
    校准模式。
    
    默认值:
    
    默认值为 CalibrateMode.BYDISTANCE}。
  - setRouteCalibrationMode
```
public void setRouteCalibrationMode(CalibrateMode value)
```
    设置校准模式。默认校正时根据距离计算新刻度。
    
    参数:
    
    value - 校准模式。
  - getTolerance
```
public double getTolerance()
```
    返回校准容限。
    校准路由时可以给定一个距离值，称为校准容限。当参考点到路由的最短距离小于给定的校准容限值时，我们就说该参考点在校准容限范围内。如上图中的参考点 c2，它到路由的最短距离小于校准容限，则 c2 在校准容限范围内，同理可知 c3 不在校准容限范围内。
    
    返回:
    
    校准容限。
    
    默认值:
    
    默认值为 1.0e-10。单位由 getToleranceUnit() 返回。
  - setTolerance
```
public void setTolerance(double value)
```
    设置校准容限。
    校准容限用于判断参考点是否有效。当参考点到对应路由的垂距大于指定的校准容限时，该参考点将不参与校准路由。
    
    参数:
    
    value - 校准容限。
    
    默认值:
    
    默认值为 1.0e-10。单位由 setToleranceUnit 设置。
  - getIgnoringGaps
```
public boolean getIgnoringGaps()
```
    返回是否忽略子对象的间隔。
    是否忽略子对象的间隔影响着路由刻度值的连续性，详细介绍请参见 GenerateRoutesParameter 类的 setIgnoringGaps 方法的介绍。
    
    返回:
    
    是否忽略子对象之间的间隔。如果为 true 表示忽略子对象间隔，false 表示不忽略。
    
    默认值:
    
    默认值为 true。
  - setIgnoringGaps
```
public void setIgnoringGaps(boolean value)
```
    设置是否忽略子对象的间隔。
    是否忽略子对象的间隔影响着路由刻度值的连续性，详细介绍请参见 GenerateRoutesParameter 类的 setIgnoringGaps 方法的介绍。
    
    注意：当校准模式为“按刻度值校准”时，该设置的有效性与原路由对象是否忽略了子对象间隔有关。如果原路由的刻度值考虑了子对象间隔，则该设置是有效的；如果原路由的刻度值是忽略子对象间隔的，则无论是否忽略子对象间隔，校准的结果路由都是忽略子对象间隔的。
    
    参数:
    
    value - 是否忽略子对象之间的间隔。如果为 true 表示忽略子对象间隔，false 表示不忽略。
  - getRetainingAllRoutes
```
public boolean getRetainingAllRoutes()
```
    返回结果路由数据集中是否保留没有参考点经过的路由对象。
    请参见 setRetainingAllRoutes 方法的介绍。
    
    返回:
    
    结果路由数据集中是否保留没有参考点经过的路由对象。如果为 true 表示保留，否则为不保留。
    
    默认值:
    
    默认值为 true，即保留没有参考点经过的路由。
  - setRetainingAllRoutes
```
public void setRetainingAllRoutes(boolean value)
```
    设置结果路由数据集中是否保留没有参考点经过的路线对象。
    以下两种情形被视为路由没有参考点经过，从而会导致路由对象不会被校准：
    - 参考点数据中没有参考点的路由 ID 与路由对象的相同，则该路由对象不会被校准；
    - 与路由对象的路由 ID 相同的参考点才可能被用于校准该路由，如果这些参考点都不在该路由校准容限范围内，那么该路由将没有参考点经过，意味着该路由没有被校准。
    用户可以根据实际研究的需求决定是否保留这些未被校准的路由。
    参数:
    
    value - 结果路由数据集中是否保留没有参考点经过的路线对象。设置为 true 表示保留，否则为不保留。
  - getToleranceUnit
```
public Unit getToleranceUnit()
```
    返回校准容限的单位。
    用户可以自定义校准容限的单位，可以与数据集单位不一致，在使用校准容限时系统会自动将其与数据集单位进行换算。
    
    返回:
    
    校准容限的单位。
    
    默认值:
    
    默认值为米（Unit.METER）。
  - setToleranceUnit
```
public void setToleranceUnit(Unit value)
```
    设置校准容限的单位。
    用户可以自定义校准容限的单位，可以与数据集单位不一致，在使用校准容限时系统会自动将其与数据集单位进行换算。
    
    参数:
    
    value - 校准容限的单位。
  - getErrorInfoField
```
public String getErrorInfoField()
```
    返回错误信息字段。
    路由校准完成后，该字段将自动添加到参考点数据集的属性表中，用于存储校准错误信息。下表列出了校准路由时可能出现的错误信息及说明。
    
    返回:
    
    错误信息字段。
  - setErrorInfoField
```
public void setErrorInfoField(String value)
```
    设置错误信息字段。
    路由校准完成后，该字段将自动添加到参考点数据集的属性表中，用于存储校准错误信息。字段值为空表示没有错误。有关错误信息的内容和说明请参见 getErrorInfoField方法。
    
    参数:
    
    value - 错误信息字段。

类 CalibrateOptions

构造器概要

方法概要

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

构造器详细资料

CalibrateOptions

CalibrateOptions

方法详细资料

enableAll

disableAll

getRouteCalibrationMode

setRouteCalibrationMode

getTolerance

setTolerance

getIgnoringGaps

setIgnoringGaps

getRetainingAllRoutes

setRetainingAllRoutes

getToleranceUnit

setToleranceUnit

getErrorInfoField

setErrorInfoField