com.esri.arcgis.spatialanalyst
Interface IGPSAHorizontalFactor

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPSAHorizontalFactor

public interface IGPSAHorizontalFactor
extends Serializable

Provides access to the horizontal factor object used for path distance.

Product Availability

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

Method Summary

int	getType() The type of the horizontal function.
void	setBinary(Object zeroFactor, Object cutAngle) Sets a binary horizontal function object.
void	setDefault() Sets a default horizontal function object.
void	setForward(Object zeroFactor, Object sideValue) Sets a forward horizontal function object.
void	setInverseLinear(Object zeroFactor, Object cutAngle, Object slope) Sets a inverse linear horizontal function object.
void	setLinear(Object zeroFactor, Object cutAngle, Object slope) Sets a linear horizontal function object.
void	setTable(String tableName) Sets a table horizontal function object.

Method Detail

setDefault

void setDefault()
                throws IOException,
                       AutomationException

Sets a default horizontal function object.

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.

setBinary

void setBinary(Object zeroFactor,
               Object cutAngle)
               throws IOException,
                      AutomationException

Sets a binary horizontal function object.

Product Availability

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

Parameters:

zeroFactor - A Variant (in)

cutAngle - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setForward

void setForward(Object zeroFactor,
                Object sideValue)
                throws IOException,
                       AutomationException

Sets a forward horizontal function object.

Product Availability

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

Parameters:

zeroFactor - A Variant (in)

sideValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLinear

void setLinear(Object zeroFactor,
               Object cutAngle,
               Object slope)
               throws IOException,
                      AutomationException

Sets a linear horizontal function object.

Product Availability

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

Parameters:

zeroFactor - A Variant (in)

cutAngle - A Variant (in)

slope - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInverseLinear

void setInverseLinear(Object zeroFactor,
                      Object cutAngle,
                      Object slope)
                      throws IOException,
                             AutomationException

Sets a inverse linear horizontal function object.

Product Availability

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

Parameters:

zeroFactor - A Variant (in)

cutAngle - A Variant (in)

slope - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTable

void setTable(String tableName)
              throws IOException,
                     AutomationException

Sets a table horizontal function object.

Product Availability

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

Parameters:

tableName - The tableName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

int getType()
            throws IOException,
                   AutomationException

The type of the horizontal function.

Product Availability

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

Returns:

A com.esri.arcgis.spatialanalyst.esriPathDistanceHorizontalEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.