com.esri.arcgis.spatialanalyst
Interface IGPSANumberRemap

All Superinterfaces:
Serializable
All Known Implementing Classes:
GPSANumberRemap

public interface IGPSANumberRemap
extends Serializable

Provides access to NumberRemap control for GP Spatial Analyst.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.


Method Summary
 void loadNumbersFromASCIIFile(String remapFile)
          Loads the information from an ArcGRID ASCII remap file into a remap object.
 void loadNumbersFromTable(ITable remapTable, String outFieldName, String fromFieldName, Object toFieldName, Object mappingFieldName)
          Load number remap records from a table object.
 void mapRange(double minValue, double maxValue, int outputValue)
          Maps a range entry to the remap object.
 void mapRangeToNoData(double minValue, double maxValue)
          Maps a range entry to nodata.
 void mapValue(double value, int outputValue)
          Maps a single value entry to the remap object.
 void mapValueToNoData(double value)
          Maps a single value entry to nodata.
 void queryNumberRecord(int index, double[] minValue, double[] maxValue, int[] outValue, boolean[] mappedToNoData)
          Returns number record information by index.
 void queryNumberValue(double inValue, int[] outValue, boolean[] isNodata)
          Returns the mapped value for a number remap entry.
 

Method Detail

mapValue

void mapValue(double value,
              int outputValue)
              throws IOException,
                     AutomationException
Maps a single value entry to the remap object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Parameters:
value - The value (in)
outputValue - The outputValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

mapRange

void mapRange(double minValue,
              double maxValue,
              int outputValue)
              throws IOException,
                     AutomationException
Maps a range entry to the remap object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Parameters:
minValue - The minValue (in)
maxValue - The maxValue (in)
outputValue - The outputValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

mapValueToNoData

void mapValueToNoData(double value)
                      throws IOException,
                             AutomationException
Maps a single value entry to nodata.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Parameters:
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

mapRangeToNoData

void mapRangeToNoData(double minValue,
                      double maxValue)
                      throws IOException,
                             AutomationException
Maps a range entry to nodata.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Parameters:
minValue - The minValue (in)
maxValue - The maxValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryNumberRecord

void queryNumberRecord(int index,
                       double[] minValue,
                       double[] maxValue,
                       int[] outValue,
                       boolean[] mappedToNoData)
                       throws IOException,
                              AutomationException
Returns number record information by index.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Parameters:
index - The index (in)
minValue - The minValue (out: use single element array)
maxValue - The maxValue (out: use single element array)
outValue - The outValue (out: use single element array)
mappedToNoData - The mappedToNoData (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryNumberValue

void queryNumberValue(double inValue,
                      int[] outValue,
                      boolean[] isNodata)
                      throws IOException,
                             AutomationException
Returns the mapped value for a number remap entry.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Parameters:
inValue - The inValue (in)
outValue - The outValue (out: use single element array)
isNodata - The isNodata (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadNumbersFromTable

void loadNumbersFromTable(ITable remapTable,
                          String outFieldName,
                          String fromFieldName,
                          Object toFieldName,
                          Object mappingFieldName)
                          throws IOException,
                                 AutomationException
Load number remap records from a table object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Parameters:
remapTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
outFieldName - The outFieldName (in)
fromFieldName - The fromFieldName (in)
toFieldName - A Variant (in, optional, pass null if not required)
mappingFieldName - A Variant (in, optional, pass null if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadNumbersFromASCIIFile

void loadNumbersFromASCIIFile(String remapFile)
                              throws IOException,
                                     AutomationException
Loads the information from an ArcGRID ASCII remap file into a remap object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Parameters:
remapFile - The remapFile (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.