com.esri.arcgis.datasourcesraster
Interface IRemapFunctionArguments

All Superinterfaces:
Serializable
All Known Implementing Classes:
RemapFunctionArguments

public interface IRemapFunctionArguments
extends Serializable

Provides access to members that control remap function arguments.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.


Method Summary
 String getInputField()
          Field in the Attribute table that contains pixel values.
 IDoubleArray getInputRanges()
          The collection of min-max value pairs indicating input remap classes.
 IDoubleArray getNoDataRanges()
          The collection of min-max value pairs indicating NoData.
 String getOutputField()
          Field in the attribute table containing the remapped values.
 IDoubleArray getOutputValues()
          The collection of output values to which each input value pair in the 'InputRanges' collection is remapped.
 Object getRaster()
          The source raster object.
 ITable getTable()
          The table used to lookup pixel values.
 boolean isAllowUnmatched()
          Indicates if unmatched values should be passed through.
 boolean isUseTable()
          Indicates if the attribute table should be used for remapping.
 void setAllowUnmatched(boolean pbAllowUnmatched)
          Indicates if unmatched values should be passed through.
 void setInputField(String pInputField)
          Field in the Attribute table that contains pixel values.
 void setInputRangesByRef(IDoubleArray ppInputRanges)
          The collection of min-max value pairs indicating input remap classes.
 void setNoDataRangesByRef(IDoubleArray ppNoDataRanges)
          The collection of min-max value pairs indicating NoData.
 void setOutputField(String pOutputField)
          Field in the attribute table containing the remapped values.
 void setOutputValuesByRef(IDoubleArray ppOutputValues)
          The collection of output values to which each input value pair in the 'InputRanges' collection is remapped.
 void setRasterByRef(Object ppRaster)
          The source raster object.
 void setTableByRef(ITable ppTable)
          The table used to lookup pixel values.
 void setUseTable(boolean pbUseTable)
          Indicates if the attribute table should be used for remapping.
 

Method Detail

getRaster

Object getRaster()
                 throws IOException,
                        AutomationException
The source raster object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterByRef

void setRasterByRef(Object ppRaster)
                    throws IOException,
                           AutomationException
The source raster object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ppRaster - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAllowUnmatched

boolean isAllowUnmatched()
                         throws IOException,
                                AutomationException
Indicates if unmatched values should be passed through.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pbAllowUnmatched
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAllowUnmatched

void setAllowUnmatched(boolean pbAllowUnmatched)
                       throws IOException,
                              AutomationException
Indicates if unmatched values should be passed through.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

isUseTable

boolean isUseTable()
                   throws IOException,
                          AutomationException
Indicates if the attribute table should be used for remapping.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pbUseTable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseTable

void setUseTable(boolean pbUseTable)
                 throws IOException,
                        AutomationException
Indicates if the attribute table should be used for remapping.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

getInputField

String getInputField()
                     throws IOException,
                            AutomationException
Field in the Attribute table that contains pixel values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pInputField
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInputField

void setInputField(String pInputField)
                   throws IOException,
                          AutomationException
Field in the Attribute table that contains pixel values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

getOutputField

String getOutputField()
                      throws IOException,
                             AutomationException
Field in the attribute table containing the remapped values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pOutputField
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutputField

void setOutputField(String pOutputField)
                    throws IOException,
                           AutomationException
Field in the attribute table containing the remapped values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

getTable

ITable getTable()
                throws IOException,
                       AutomationException
The table used to lookup pixel values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTableByRef

void setTableByRef(ITable ppTable)
                   throws IOException,
                          AutomationException
The table used to lookup pixel values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ppTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInputRanges

IDoubleArray getInputRanges()
                            throws IOException,
                                   AutomationException
The collection of min-max value pairs indicating input remap classes. Pixel values of the input raster in the range [min,max) are mapped to the corresponding value in the 'OutputValues' collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A reference to a com.esri.arcgis.system.IDoubleArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInputRangesByRef

void setInputRangesByRef(IDoubleArray ppInputRanges)
                         throws IOException,
                                AutomationException
The collection of min-max value pairs indicating input remap classes. Pixel values of the input raster in the range [min,max) are mapped to the corresponding value in the 'OutputValues' collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ppInputRanges - A reference to a com.esri.arcgis.system.IDoubleArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOutputValues

IDoubleArray getOutputValues()
                             throws IOException,
                                    AutomationException
The collection of output values to which each input value pair in the 'InputRanges' collection is remapped.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A reference to a com.esri.arcgis.system.IDoubleArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutputValuesByRef

void setOutputValuesByRef(IDoubleArray ppOutputValues)
                          throws IOException,
                                 AutomationException
The collection of output values to which each input value pair in the 'InputRanges' collection is remapped.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ppOutputValues - A reference to a com.esri.arcgis.system.IDoubleArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNoDataRanges

IDoubleArray getNoDataRanges()
                             throws IOException,
                                    AutomationException
The collection of min-max value pairs indicating NoData. Pixel values of the input raster in the range [min,max) are set as NoData.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A reference to a com.esri.arcgis.system.IDoubleArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNoDataRangesByRef

void setNoDataRangesByRef(IDoubleArray ppNoDataRanges)
                          throws IOException,
                                 AutomationException
The collection of min-max value pairs indicating NoData. Pixel values of the input raster in the range [min,max) are set as NoData.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
ppNoDataRanges - A reference to a com.esri.arcgis.system.IDoubleArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.