com.esri.arcgis.spatialanalyst
Class GPSAVerticalFactor

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

All Implemented Interfaces:

IGPValue, com.esri.arcgis.interop.RemoteObjRef, IGPSAVerticalFactor, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class GPSAVerticalFactor
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPValue, IGPSAVerticalFactor, IClone, IXMLSerialize, IPersistStream, java.io.Externalizable

COM Class 'GPSAVerticalFactor'. Generated 3/19/2015 1:20:46 PM from 'C:\ArcGIS\COM\esriSpatialAnalyst.olb'

Description 'GeoProcessor path distance vertical function object.' 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 =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.geodatabase.IGPValue

IID, IID92ee08b6_c757_4178_803c_67cd665ac801, xxDummy

Fields inherited from interface com.esri.arcgis.spatialanalyst.IGPSAVerticalFactor

IID, IID4a5e124e_6476_46e3_9fbc_dc8e6044ca80, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Constructor Summary

GPSAVerticalFactor()
Constructs a GPSAVerticalFactor using ArcGIS Engine.

GPSAVerticalFactor(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPSAVerticalFactor theGPSAVerticalFactor = (GPSAVerticalFactor) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
void	empty() Clears the value object.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
java.lang.String	getAsText() Provides the value of the value object.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getType() The type of the vertical function.
int	hashCode() the hashcode for this object
IGPDataType	IGPValue_getDataType() The data type of the value object.
void	isDirty() isDirty
boolean	isEmpty() Indicates if the value object is empty.
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a GPSAVerticalFactor.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
IGPMessage	setAsText(java.lang.String text) Provides the value of the value object with the given string value.
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.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

GPSAVerticalFactor

public GPSAVerticalFactor()
                   throws java.io.IOException,
                          java.net.UnknownHostException

Constructs a GPSAVerticalFactor using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GPSAVerticalFactor

public GPSAVerticalFactor(java.lang.Object obj)
                   throws java.io.IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a GPSAVerticalFactor.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

IGPValue_getDataType

public IGPDataType IGPValue_getDataType()
                                 throws java.io.IOException,
                                        AutomationException

The data type of the value object.

Specified by:

IGPValue_getDataType in interface IGPValue

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPDataType

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws java.io.IOException,
                       AutomationException

Indicates if the value object is empty.

Specified by:

isEmpty in interface IGPValue

Returns:

The isEmpty

Throws:

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

AutomationException - If the ArcObject component throws an exception.

empty

public void empty()
           throws java.io.IOException,
                  AutomationException

Clears the value object.

Specified by:

empty in interface IGPValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAsText

public java.lang.String getAsText()
                           throws java.io.IOException,
                                  AutomationException

Provides the value of the value object.

Specified by:

getAsText in interface IGPValue

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(java.lang.String text)
                     throws java.io.IOException,
                            AutomationException

Provides the value of the value object with the given string value.

Specified by:

setAsText in interface IGPValue

Parameters:

text - The text (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IGPMessage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefault

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

Sets a default vertical function object.

Specified by:

setDefault in interface IGPSAVerticalFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBinary

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

Specified by:

setBinary in interface IGPSAVerticalFactor

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

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

Specified by:

setLinear in interface IGPSAVerticalFactor

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

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

Specified by:

setInverseLinear in interface IGPSAVerticalFactor

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

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

Sets a table vertical function object.

Specified by:

setTable in interface IGPSAVerticalFactor

Parameters:

tableName - The tableName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymLinear

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

Specified by:

setSymLinear in interface IGPSAVerticalFactor

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

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

Specified by:

setSymInverseLinear in interface IGPSAVerticalFactor

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

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

Specified by:

setCos in interface IGPSAVerticalFactor

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

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

Specified by:

setSec in interface IGPSAVerticalFactor

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

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

Specified by:

setCosSec in interface IGPSAVerticalFactor

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

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

Specified by:

setSecCos in interface IGPSAVerticalFactor

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

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

The type of the vertical function.

Specified by:

getType in interface IGPSAVerticalFactor

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.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException