com.esri.arcgis.spatialanalyst
Class PathDistanceVerticalFactor

java.lang.Object
  extended by com.esri.arcgis.spatialanalyst.PathDistanceVerticalFactor
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IPathDistanceVerticalFactor, ISupportErrorInfo, Serializable

public class PathDistanceVerticalFactor
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPathDistanceVerticalFactor, ISupportErrorInfo

Path distance vertical 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
PathDistanceVerticalFactor()
          Constructs a PathDistanceVerticalFactor using ArcGIS Engine.
PathDistanceVerticalFactor(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PathDistanceVerticalFactor thePathDistanceVerticalFactor = (PathDistanceVerticalFactor) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 String getDescription()
          The string description of the vertical function.
 int getType()
          The type of the vertical function.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 void setBinary(Object zeroFactor, Object lowCutAngle, Object highCutAngle)
          Sets a binary vertical function object.
 void setCos(Object lowCutAngle, Object highCutAngle, Object power)
          Sets a Cos vertical function object.
 void setCosSec(Object lowCutAngle, Object highCutAngle, Object cosPower, Object secPower)
          Sets a negative-Cos and positive-Sec vertical function object.
 void setDefault()
          Sets a default vertical function object.
 void setInverseLinear(Object zeroFactor, Object lowCutAngle, Object highCutAngle, Object slope)
          Sets a inverse linear vertical function object.
 void setLinear(Object zeroFactor, Object lowCutAngle, Object highCutAngle, Object slope)
          Sets a linear vertical function object.
 void setSec(Object lowCutAngle, Object highCutAngle, Object power)
          Sets a Sec vertical function object.
 void setSecCos(Object lowCutAngle, Object highCutAngle, Object secPower, Object cosPower)
          Sets a negative-Cos and positive-Sec vertical function object.
 void setSymInverseLinear(Object zeroFactor, Object lowCutAngle, Object highCutAngle, Object slope)
          Sets a symmetrical-inverse-linear vertical function object.
 void setSymLinear(Object zeroFactor, Object lowCutAngle, Object highCutAngle, Object slope)
          Sets a symmetrical-linear vertical function object.
 void setTable(String tableName)
          Sets a table vertical 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

PathDistanceVerticalFactor

public PathDistanceVerticalFactor()
                           throws IOException,
                                  UnknownHostException
Constructs a PathDistanceVerticalFactor using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

PathDistanceVerticalFactor

public PathDistanceVerticalFactor(Object obj)
                           throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PathDistanceVerticalFactor thePathDistanceVerticalFactor = (PathDistanceVerticalFactor) obj;

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

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 vertical 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 IPathDistanceVerticalFactor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBinary

public void setBinary(Object zeroFactor,
                      Object lowCutAngle,
                      Object highCutAngle)
               throws IOException,
                      AutomationException
Sets a binary vertical 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 IPathDistanceVerticalFactor
Parameters:
zeroFactor - A Variant (in)
lowCutAngle - A Variant (in)
highCutAngle - 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 lowCutAngle,
                      Object highCutAngle,
                      Object slope)
               throws IOException,
                      AutomationException
Sets a linear vertical 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 IPathDistanceVerticalFactor
Parameters:
zeroFactor - A Variant (in)
lowCutAngle - A Variant (in)
highCutAngle - 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 lowCutAngle,
                             Object highCutAngle,
                             Object slope)
                      throws IOException,
                             AutomationException
Sets a inverse linear vertical 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 IPathDistanceVerticalFactor
Parameters:
zeroFactor - A Variant (in)
lowCutAngle - A Variant (in)
highCutAngle - 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 vertical 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 IPathDistanceVerticalFactor
Parameters:
tableName - The tableName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymLinear

public void setSymLinear(Object zeroFactor,
                         Object lowCutAngle,
                         Object highCutAngle,
                         Object slope)
                  throws IOException,
                         AutomationException
Sets a symmetrical-linear vertical function object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSymLinear in interface IPathDistanceVerticalFactor
Parameters:
zeroFactor - A Variant (in)
lowCutAngle - A Variant (in)
highCutAngle - A Variant (in)
slope - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymInverseLinear

public void setSymInverseLinear(Object zeroFactor,
                                Object lowCutAngle,
                                Object highCutAngle,
                                Object slope)
                         throws IOException,
                                AutomationException
Sets a symmetrical-inverse-linear vertical function object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSymInverseLinear in interface IPathDistanceVerticalFactor
Parameters:
zeroFactor - A Variant (in)
lowCutAngle - A Variant (in)
highCutAngle - A Variant (in)
slope - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCos

public void setCos(Object lowCutAngle,
                   Object highCutAngle,
                   Object power)
            throws IOException,
                   AutomationException
Sets a Cos vertical function object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCos in interface IPathDistanceVerticalFactor
Parameters:
lowCutAngle - A Variant (in)
highCutAngle - A Variant (in)
power - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSec

public void setSec(Object lowCutAngle,
                   Object highCutAngle,
                   Object power)
            throws IOException,
                   AutomationException
Sets a Sec vertical function object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSec in interface IPathDistanceVerticalFactor
Parameters:
lowCutAngle - A Variant (in)
highCutAngle - A Variant (in)
power - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCosSec

public void setCosSec(Object lowCutAngle,
                      Object highCutAngle,
                      Object cosPower,
                      Object secPower)
               throws IOException,
                      AutomationException
Sets a negative-Cos and positive-Sec vertical function object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCosSec in interface IPathDistanceVerticalFactor
Parameters:
lowCutAngle - A Variant (in)
highCutAngle - A Variant (in)
cosPower - A Variant (in)
secPower - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSecCos

public void setSecCos(Object lowCutAngle,
                      Object highCutAngle,
                      Object secPower,
                      Object cosPower)
               throws IOException,
                      AutomationException
Sets a negative-Cos and positive-Sec vertical function object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSecCos in interface IPathDistanceVerticalFactor
Parameters:
lowCutAngle - A Variant (in)
highCutAngle - A Variant (in)
secPower - A Variant (in)
cosPower - A Variant (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 vertical 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 IPathDistanceVerticalFactor
Returns:
A com.esri.arcgis.spatialanalyst.esriPathDistanceVerticalEnum 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 vertical 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 IPathDistanceVerticalFactor
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.