com.supermap.analyst.spatialanalyst

Class TerrainAnalystSetting

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


  • public class TerrainAnalystSetting
    extends java.lang.Object
    The terrain analysis setting class
    • Constructor Detail

      • TerrainAnalystSetting

        public TerrainAnalystSetting()
      • TerrainAnalystSetting

        public TerrainAnalystSetting(TerrainAnalystSetting terraindAnalystSetting)
        Parameters:
        terraindAnalystSetting - The terrain analysis setting class
    • Method Detail

      • getBoundsType

        public BoundsType getBoundsType()
        Returns the types of the geographic range of the result dataset.
        Returns:
        the types of the geographic range of the result dataset. INTERSECTION is by default
      • setBoundsType

        public void setBoundsType(BoundsType value)
        Sets the types of the geographic range of the result dataset.
        Parameters:
        value - The types of the geographic range of the result dataset.
      • getBounds

        public Rectangle2D getBounds()
        Gets the geographic range of the result dataset.
        Returns:
        the geographic range of the result dataset. Rectangle(0,0,0,0) is by default
      • setBounds

        public void setBounds(Rectangle2D value)
        Sets the geographic range of the result dataset.
        Parameters:
        value - The geographic range of the result dataset.
      • getCellSizeType

        public CellSizeType getCellSizeType()
        Gets the resolution types of the dataset
        Returns:
        the resolution types of the dataset. MIN is by default
      • setCellSizeType

        public void setCellSizeType(CellSizeType value)
        Sets the resolution types of the dataset
        Parameters:
        value - The resolution types of the dataset
      • getCellSize

        public double getCellSize()
        Gets the resolution of the dataset
        Returns:
        the resolution of the dataset. When the resolution type is Custom, the parameter is valid and its default value is 0
      • setCellSize

        public void setCellSize(double value)
        Sets the resolution of the dataset
        Parameters:
        value - The resolution of the dataset. When the resolution type is Custom.
      • getValidRegion

        public GeoRegion getValidRegion()
        Gets the valid area of the dataset
        Returns:
        the valid area. Null is by default
      • setValidRegion

        public void setValidRegion(GeoRegion value)
        Sets the valid area of the dataset
        Parameters:
        value - The valid area of the dataset
      • getGridOutputNamePrefix

        public java.lang.String getGridOutputNamePrefix()
        Gets the name prefix of the raster dataset
        Returns:
        the name prefix of the raster dataset. Null is by default
      • setGridOutputNamePrefix

        public void setGridOutputNamePrefix(java.lang.String value)
        Sets the name prefix of the raster dataset
        Parameters:
        value - The name prefix of the raster dataset
      • getVectorOutputNamePrefix

        public java.lang.String getVectorOutputNamePrefix()
        Gets the name prefix of the vector dataset
        Returns:
        the name prefix of the vector dataset. Null is by default
      • setVectorOutputNamePrefix

        public void setVectorOutputNamePrefix(java.lang.String value)
        Sets the name prefix of the vector dataset
        Parameters:
        value - The name prefix of the vector dataset
      • getOutputDatasource

        public Datasource getOutputDatasource()
        Gets the datasoure where the dataset is located in
        Returns:
        the datasoure where the dataset is located in. Null is by default
      • setOutputDatasource

        public void setOutputDatasource(Datasource value)
        Sets the datasoure where the dataset is located in
        Parameters:
        value - The datasoure where the dataset is located in
      • isShowProgress

        public boolean isShowProgress()
        Whether to display the progress bar
        Returns:
        whether to display the progress bar. The default value is true.
      • setShowProgress

        public void setShowProgress(boolean value)
        Sets whether to display the progress bar
        Parameters:
        value - Sets whether to display the progress bar
      • getUseNoValue

        @Deprecated
        public boolean getUseNoValue()
        Deprecated. 
        Gets whether am empty value will involve in the operation
        Returns:
        whether am empty value will involve in the operation. The default value is FASLE
      • setUseNoValue

        @Deprecated
        public void setUseNoValue(boolean value)
        Deprecated. 
        Sets whether am empty value will involve in the operation
        Parameters:
        value - Whether am empty value will involve in the operation
      • getPixelFormat

        @Deprecated
        public PixelFormat getPixelFormat()
        Deprecated. 
        Gets the pixel formats of the dataset
        Returns:
        the pixel formats of the dataset. The default value is DOUBLE
      • setPixelFormat

        @Deprecated
        public void setPixelFormat(PixelFormat value)
        Deprecated. 
        Sets the pixel formats of the dataset
        Parameters:
        value - The pixel formats of the dataset