com.esri.arcgis.spatialanalyst
Interface IPathDistanceVerticalFactor

All Superinterfaces:

Serializable

All Known Implementing Classes:

PathDistanceVerticalFactor

public interface IPathDistanceVerticalFactor
extends Serializable

Provides access to members that control the vertical factors used when performing path distance.

Product Availability

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

Method Summary

String	getDescription() The string description of the vertical function.
int	getType() The type of the vertical function.
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.

Method Detail

setDefault

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBinary

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

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

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

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

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

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

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

Parameters:

tableName - The tableName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymLinear

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns:

A com.esri.arcgis.spatialanalyst.esriPathDistanceVerticalEnum constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

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

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.