com.supermap.analyst.spatialanalyst

类 GenerateEventTableParameter

  • java.lang.Object
    • com.supermap.analyst.spatialanalyst.GenerateEventTableParameter


  • public class GenerateEventTableParameter
    extends Object
    事件表参数类。该类提供在创建事件表方法中参数的设置。
    • 方法详细资料

      • getEventDataset

        public DatasetVector getEventDataset()
        返回用于生成事件表的空间数据,称为事件数据集,可以是矢量点或线数据集。
        返回:
        事件数据集。
      • setEventDataset

        public void setEventDataset(DatasetVector value)
        设置用于生成事件表的空间数据,称为事件数据集,可以是矢量点或线数据集。
        参数:
        value - 事件数据集。
      • getRouteIDField

        public String getRouteIDField()
        返回参考路由数据集中的路由标识字段。
        返回:
        参考路由数据集中的路由标识字段。
      • setRouteIDField

        public void setRouteIDField(String value)
        设置参考路由数据集中的路由标识字段。

        注意:对于路由标识字段,所支持的字段类型请参见 LinearReferencing 类的介绍。如果设置的字段类型不被支持,会导致生成事件表失败。

        参数:
        value - 参考路由数据集中的路由标识字段。
      • getMeasureField

        public String getMeasureField()
        返回结果事件表的刻度字段,只当生成的事件表为点事件表时才有意义。
        返回:
        结果事件表的刻度字段。
      • setMeasureField

        public void setMeasureField(String value)
        设置结果事件表的刻度字段,只当生成的事件表为点事件表时才有意义。
        参数:
        value - 结果事件表的刻度字段。
      • getMeasureStartField

        public String getMeasureStartField()
        返回结果事件表的起始刻度字段,只当生成的事件为线事件时才有意义。
        返回:
        结果事件表的起始刻度字段。
      • setMeasureStartField

        public void setMeasureStartField(String value)
        设置结果事件表的起始刻度字段,只当生成的事件为线事件时才有意义。
        参数:
        value - 结果事件表的起始刻度字段。
      • getMeasureEndField

        public String getMeasureEndField()
        返回结果事件表的终止刻度字段,只当生成的事件为线事件时才有意义。
        返回:
        结果事件表的终止刻度字段。
      • setMeasureEndField

        public void setMeasureEndField(String value)
        设置结果事件表的终止刻度字段,只当生成的事件为线事件时才有意义。
        参数:
        value - 结果事件表的终止刻度字段。
      • getSearchRadius

        public double getSearchRadius()
        返回查找半径,对路由对象以该值为半径扩展出的缓冲区域称为查找范围,位于该范围之外的点或线将不能在事件表中生成记录。
        返回:
        查找半径。
        默认值:
        默认值为 1.0e-10。
      • setSearchRadius

        public void setSearchRadius(double value)
        返回查找半径,对路由对象以该值为半径扩展出的缓冲区域称为查找范围,位于该范围之外(包括部分在查找范围外)的点或线将不能在事件表中生成记录。单位由 setSearchRadiusUnit 方法决定。

        除可以指定生成事件表时的查找半径外,用户还可以通过 setSearchRadius 方法来指定查找半径的单位。在生成事件表时,系统会自动将查找半径的值换算到用于生成事件表的参考的路由数据集的坐标系统单位。

        参数:
        value - 查找半径。
      • hasDistanceField

        public boolean hasDistanceField()
        返回是否在结果事件表中创建距离字段,用于存储点到路由的直线距离,只当事件数据为点数据时有效。
        返回:
        一个布尔值,代表是否在结果事件表中创建距离字段,如果为 true 表示创建,false表示不创建。
        默认值:
        默认值为 true。
      • setDistanceField

        public void setDistanceField(boolean value)
        设置是否在结果事件表中创建距离字段,用于存储点到路由的直线距离,只当事件数据为点数据时有效。
        参数:
        value - 是否在结果事件表中创建距离字段,如果为 true 表示创建,false表示不创建。
      • getFindingClosestRoute

        public boolean getFindingClosestRoute()
        返回是否只查找最近的路由,只当事件数据为点数据时有效。

        当某个点在多条路由的查找范围内时,如果该属性设置为 true,则只生成距离该点最近的路由上的事件;如果为 false,则只要该点在路由的查找范围内,就生成对应的事件。举例来讲,如果某点在三条路由的查找范围内,如果只查找最近距离的路由,则结果事件表中只生成一条事件记录,否则会生成三条分别对应三条路由的事件记录。

        注:有关查找范围请参见查找半径(GenerateEventTableParameter.setSearchRadius(double) setSearchRadius)。

        返回:
        一个布尔值,表示是否只查找最近的路由,如果为 true 表示只查找最近路由,false 表示只要点到路由的距离小于查找半径,就会在该路由上生成事件。
        默认值:
        默认值为 true,即只查找最近的路由。
      • setFindingClosestRoute

        public void setFindingClosestRoute(boolean value)
        设置是否只查找最近的路由,只当事件数据为点数据时有效。

        当某个点在多条路由的查找范围内时,如果该属性设置为 true,则只生成距离该点最近的路由上的事件;如果为 false,则只要该点在路由的查找范围内,就生成对应的事件。举例来讲,如果某点在三条路由的查找范围内,如果只查找最近距离的路由,则结果事件表中只生成一条事件记录,否则会生成三条分别对应三条路由的事件记录。

        注:有关查找范围请参见查找半径(GenerateEventTableParameter.setSearchRadius(double) setSearchRadius)。

        参数:
        value - 是否只查找最近的路由,如果为 true 表示只查找最近路由,false 表示只要点到路由的距离小于查找半径,就会在该路由上生成事件。
      • getRetainingAllFields

        public boolean getRetainingAllFields()
        返回是否在结果事件表中保留事件数据中除系统字段外的所有属性字段。
        返回:
        一个布尔值,表示是否在结果事件表中保留事件数据中除系统字段外的所有属性字段,如果为 true 表示保留,false 表示不保留。
        默认值:
        默认值为 true。
      • setRetainingAllFields

        public void setRetainingAllFields(boolean value)
        设置是否在结果事件表中保留事件数据中除系统字段外的所有属性字段。

        当选择保留系统字段外的属性字段时,如果生成点事件表,被保留的字段将添加“_P”后缀;如果生成线事件表,则添加“_L”后缀。

        参数:
        value - 是否在结果事件表中保留事件数据中除系统字段外的所有属性字段,如果为 true 表示保留,false 表示不保留。
      • getOutputDatasource

        public Datasource getOutputDatasource()
        返回用于存储结果事件表的数据源。
        返回:
        用于存储结果事件表的数据源。
      • setOutputDatasource

        public void setOutputDatasource(Datasource value)
        设置用于存储结果事件表的数据源,如果为 null,结果事件表将会自动存储到参考路由数据集所在的数据源中。
        参数:
        value - 用于存储结果事件表的数据源。
      • getOutputDatasetName

        public String getOutputDatasetName()
        返回结果事件表的名称。
        返回:
        结果事件表的名称。
      • setOutputDatasetName

        public void setOutputDatasetName(String value)
        设置结果事件表的名称。
        参数:
        value - 结果事件表的名称。
      • getOutputDatasetRouteField

        public String getOutputDatasetRouteField()
        返回结果事件表的路由标识字段。
        返回:
        结果事件表的路由标识字段。
      • setOutputDatasetRouteField

        public void setOutputDatasetRouteField(String value)
        设置结果事件表的路由标识字段。
        参数:
        value - 结果事件表的路由标识字段。
      • getSearchRadiusUnit

        public Unit getSearchRadiusUnit()
        返回查找半径的单位。单位为 getSearchRadiusUnit 方法的返回值。
        返回:
        查找半径的单位。
        默认值:
        默认值为 Unit.METER。
      • setSearchRadiusUnit

        public void setSearchRadiusUnit(Unit value)
        设置查找半径的单位。

        用户可以自定义查找半径(SearchRadius)的单位,在生成事件表时,系统会自动将查找半径的值换算到用于生成事件表的参考的路由数据集的坐标系统单位。

        参数:
        value - 查找半径的单位。

Copyright © 2021–2024 SuperMap. All rights reserved.