com.esri.arcgis.spatialanalyst
Class PathDistanceHorizontalFactor

java.lang.Object
  com.esri.arcgis.spatialanalyst.PathDistanceHorizontalFactor

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IPathDistanceHorizontalFactor, ISupportErrorInfo, Serializable

public class PathDistanceHorizontalFactor
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPathDistanceHorizontalFactor, ISupportErrorInfo

Path distance horizontal function object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

PathDistanceHorizontalFactor()
Constructs a PathDistanceHorizontalFactor using ArcGIS Engine.

PathDistanceHorizontalFactor(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PathDistanceHorizontalFactor thePathDistanceHorizontalFactor = (PathDistanceHorizontalFactor) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
String	getDescription() The string description of the horizontal function.
int	getType() The type of the horizontal function.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

PathDistanceHorizontalFactor

public PathDistanceHorizontalFactor()
                             throws IOException,
                                    UnknownHostException

Constructs a PathDistanceHorizontalFactor using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

PathDistanceHorizontalFactor

public PathDistanceHorizontalFactor(Object obj)
                             throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PathDistanceHorizontalFactor thePathDistanceHorizontalFactor = (PathDistanceHorizontalFactor) obj;

Construct a PathDistanceHorizontalFactor using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to PathDistanceHorizontalFactor.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setDefault

public 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.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefault in interface IPathDistanceHorizontalFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBinary

public 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.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBinary in interface IPathDistanceHorizontalFactor

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

public 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.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setForward in interface IPathDistanceHorizontalFactor

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

public 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.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLinear in interface IPathDistanceHorizontalFactor

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

public 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.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setInverseLinear in interface IPathDistanceHorizontalFactor

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

public 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.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTable in interface IPathDistanceHorizontalFactor

Parameters:

tableName - The tableName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public 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.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getType in interface IPathDistanceHorizontalFactor

Returns:

A com.esri.arcgis.spatialanalyst.esriPathDistanceHorizontalEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

The string description of the horizontal function.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDescription in interface IPathDistanceHorizontalFactor

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.