com.esri.arcgis.spatialanalyst
Interface IGPSAWeightedOverlayTable

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPSAWeightedOverlayTable

public interface IGPSAWeightedOverlayTable
extends Serializable

Provides access to WeightedOverlayTable control for GP Spatial Analyst.

Product Availability

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

Method Summary

void	addRecord(IGPValue pRaster, IGPValue pField) Adds a record to the overlay table.
void	clear() Clears the overlay table.
void	deleteRecord(int recordIndex) Removes a record from the overlay table.
int	getCount() The number of records in the overlay table.
IGPEvaluationScale	getEvaluationScale() Get the evaluation scale used by the overlay table.
int	getSumOfInfluences() The sum of percent influences of all elements in the overlay table.
IGPValue	getValue(int recordIndex, int columnIndex) Returns a column value from the overlay table.
void	setValue(int recordIndex, int columnIndex, IGPValue value) Sets a column value in the overlay table.
void	transform(IGPEvaluationScale pOldScale, IGPEvaluationScale pNewScale) Performs a transform between the current and previous scale lists.

Method Detail

addRecord

void addRecord(IGPValue pRaster,
               IGPValue pField)
               throws IOException,
                      AutomationException

Adds a record to the overlay table.

Product Availability

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

Parameters:

pRaster - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

pField - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteRecord

void deleteRecord(int recordIndex)
                  throws IOException,
                         AutomationException

Removes a record from the overlay table.

Product Availability

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

Parameters:

recordIndex - The recordIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

IGPValue getValue(int recordIndex,
                  int columnIndex)
                  throws IOException,
                         AutomationException

Returns a column value from the overlay table.

Product Availability

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

Parameters:

recordIndex - The recordIndex (in)

columnIndex - The columnIndex (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValue

void setValue(int recordIndex,
              int columnIndex,
              IGPValue value)
              throws IOException,
                     AutomationException

Sets a column value in the overlay table.

Product Availability

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

Parameters:

recordIndex - The recordIndex (in)

columnIndex - The columnIndex (in)

value - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

int getCount()
             throws IOException,
                    AutomationException

The number of records in the overlay table.

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEvaluationScale

IGPEvaluationScale getEvaluationScale()
                                      throws IOException,
                                             AutomationException

Get the evaluation scale used by the overlay table.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.spatialanalyst.IGPEvaluationScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

transform

void transform(IGPEvaluationScale pOldScale,
               IGPEvaluationScale pNewScale)
               throws IOException,
                      AutomationException

Performs a transform between the current and previous scale lists.

Product Availability

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

Parameters:

pOldScale - A reference to a com.esri.arcgis.spatialanalyst.IGPEvaluationScale (in)

pNewScale - A reference to a com.esri.arcgis.spatialanalyst.IGPEvaluationScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSumOfInfluences

int getSumOfInfluences()
                       throws IOException,
                              AutomationException

The sum of percent influences of all elements in the overlay table.

Product Availability

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

Returns:

The sumOfInfluences

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

void clear()
           throws IOException,
                  AutomationException

Clears the overlay table.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.