com.esri.arcgis.spatialanalyst
Interface IPathDistanceVerticalFactor

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IPathDistanceVerticalFactorProxy, PathDistanceVerticalFactor

public interface IPathDistanceVerticalFactor
extends java.io.Serializable

COM Interface 'IPathDistanceVerticalFactor'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriSpatialAnalyst.olb'

Description: 'Provides access to members that control the vertical factors used when performing path distance.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID42aa082b_2fc2_4939_ad2e_92f563e4356f
static int	xxDummy Deprecated. Internal use only

Method Summary

java.lang.String	getDescription() The string description of the vertical function.
int	getType() The type of the vertical function.
void	setBinary(java.lang.Object zeroFactor, java.lang.Object lowCutAngle, java.lang.Object highCutAngle) Sets a binary vertical function object.
void	setCos(java.lang.Object lowCutAngle, java.lang.Object highCutAngle, java.lang.Object power) Sets a Cos vertical function object.
void	setCosSec(java.lang.Object lowCutAngle, java.lang.Object highCutAngle, java.lang.Object cosPower, java.lang.Object secPower) Sets a negative-Cos and positive-Sec vertical function object.
void	setDefault() Sets a default vertical function object.
void	setInverseLinear(java.lang.Object zeroFactor, java.lang.Object lowCutAngle, java.lang.Object highCutAngle, java.lang.Object slope) Sets a inverse linear vertical function object.
void	setLinear(java.lang.Object zeroFactor, java.lang.Object lowCutAngle, java.lang.Object highCutAngle, java.lang.Object slope) Sets a linear vertical function object.
void	setSec(java.lang.Object lowCutAngle, java.lang.Object highCutAngle, java.lang.Object power) Sets a Sec vertical function object.
void	setSecCos(java.lang.Object lowCutAngle, java.lang.Object highCutAngle, java.lang.Object secPower, java.lang.Object cosPower) Sets a negative-Cos and positive-Sec vertical function object.
void	setSymInverseLinear(java.lang.Object zeroFactor, java.lang.Object lowCutAngle, java.lang.Object highCutAngle, java.lang.Object slope) Sets a symmetrical-inverse-linear vertical function object.
void	setSymLinear(java.lang.Object zeroFactor, java.lang.Object lowCutAngle, java.lang.Object highCutAngle, java.lang.Object slope) Sets a symmetrical-linear vertical function object.
void	setTable(java.lang.String tableName) Sets a table vertical function object.

Field Detail

IID42aa082b_2fc2_4939_ad2e_92f563e4356f

static final int IID42aa082b_2fc2_4939_ad2e_92f563e4356f

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setDefault

void setDefault()
                throws java.io.IOException,
                       AutomationException

Sets a default vertical function object.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBinary

void setBinary(java.lang.Object zeroFactor,
               java.lang.Object lowCutAngle,
               java.lang.Object highCutAngle)
               throws java.io.IOException,
                      AutomationException

Sets a binary vertical function object.

Parameters:

zeroFactor - A Variant (in)

lowCutAngle - A Variant (in)

highCutAngle - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLinear

void setLinear(java.lang.Object zeroFactor,
               java.lang.Object lowCutAngle,
               java.lang.Object highCutAngle,
               java.lang.Object slope)
               throws java.io.IOException,
                      AutomationException

Sets a linear vertical function object.

Parameters:

zeroFactor - A Variant (in)

lowCutAngle - A Variant (in)

highCutAngle - A Variant (in)

slope - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInverseLinear

void setInverseLinear(java.lang.Object zeroFactor,
                      java.lang.Object lowCutAngle,
                      java.lang.Object highCutAngle,
                      java.lang.Object slope)
                      throws java.io.IOException,
                             AutomationException

Sets a inverse linear vertical function object.

Parameters:

zeroFactor - A Variant (in)

lowCutAngle - A Variant (in)

highCutAngle - A Variant (in)

slope - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTable

void setTable(java.lang.String tableName)
              throws java.io.IOException,
                     AutomationException

Sets a table vertical function object.

Parameters:

tableName - The tableName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymLinear

void setSymLinear(java.lang.Object zeroFactor,
                  java.lang.Object lowCutAngle,
                  java.lang.Object highCutAngle,
                  java.lang.Object slope)
                  throws java.io.IOException,
                         AutomationException

Sets a symmetrical-linear vertical function object.

Parameters:

zeroFactor - A Variant (in)

lowCutAngle - A Variant (in)

highCutAngle - A Variant (in)

slope - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymInverseLinear

void setSymInverseLinear(java.lang.Object zeroFactor,
                         java.lang.Object lowCutAngle,
                         java.lang.Object highCutAngle,
                         java.lang.Object slope)
                         throws java.io.IOException,
                                AutomationException

Sets a symmetrical-inverse-linear vertical function object.

Parameters:

zeroFactor - A Variant (in)

lowCutAngle - A Variant (in)

highCutAngle - A Variant (in)

slope - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCos

void setCos(java.lang.Object lowCutAngle,
            java.lang.Object highCutAngle,
            java.lang.Object power)
            throws java.io.IOException,
                   AutomationException

Sets a Cos vertical function object.

Parameters:

lowCutAngle - A Variant (in)

highCutAngle - A Variant (in)

power - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSec

void setSec(java.lang.Object lowCutAngle,
            java.lang.Object highCutAngle,
            java.lang.Object power)
            throws java.io.IOException,
                   AutomationException

Sets a Sec vertical function object.

Parameters:

lowCutAngle - A Variant (in)

highCutAngle - A Variant (in)

power - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCosSec

void setCosSec(java.lang.Object lowCutAngle,
               java.lang.Object highCutAngle,
               java.lang.Object cosPower,
               java.lang.Object secPower)
               throws java.io.IOException,
                      AutomationException

Sets a negative-Cos and positive-Sec vertical function object.

Parameters:

lowCutAngle - A Variant (in)

highCutAngle - A Variant (in)

cosPower - A Variant (in)

secPower - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSecCos

void setSecCos(java.lang.Object lowCutAngle,
               java.lang.Object highCutAngle,
               java.lang.Object secPower,
               java.lang.Object cosPower)
               throws java.io.IOException,
                      AutomationException

Sets a negative-Cos and positive-Sec vertical function object.

Parameters:

lowCutAngle - A Variant (in)

highCutAngle - A Variant (in)

secPower - A Variant (in)

cosPower - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

int getType()
            throws java.io.IOException,
                   AutomationException

The type of the vertical function.

Returns:

A com.esri.arcgis.spatialanalyst.esriPathDistanceVerticalEnum constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

The string description of the vertical function.

Returns:

The description

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.