com.esri.arcgis.spatialanalyst
Class GPSAVerticalFactor

java.lang.Object
  extended by com.esri.arcgis.spatialanalyst.GPSAVerticalFactor
All Implemented Interfaces:
IGPValue, com.esri.arcgis.interop.RemoteObjRef, IGPSAVerticalFactor, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

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

GeoProcessor path distance vertical function object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
GPSAVerticalFactor()
          Constructs a GPSAVerticalFactor using ArcGIS Engine.
GPSAVerticalFactor(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(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 String getAsText()
          Provides the value of the value object.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 IGPDataType getDataType()
          The data type of the value object.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int getType()
          The type of the vertical function.
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 boolean isEmpty()
          Indicates if the value object is empty.
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 IGPMessage setAsText(String text)
          Provides the value of the value object with the given string value.
 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.
 void writeExternal(ObjectOutput out)
           
 
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

GPSAVerticalFactor

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

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

GPSAVerticalFactor

public GPSAVerticalFactor(Object obj)
                   throws 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:
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

getDataType

public IGPDataType getDataType()
                        throws IOException,
                               AutomationException
The data type of the value object.

Remarks

The DataType property returns the DataType object associated with this Value object.

Product Availability

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

Specified by:
getDataType in interface IGPValue
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPDataType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws IOException,
                       AutomationException
Indicates if the value object is empty.

Remarks

The IsEmpty method returns if this Value object has been set or not.

Product Availability

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

Specified by:
isEmpty in interface IGPValue
Returns:
The isEmpty
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

empty

public void empty()
           throws IOException,
                  AutomationException
Clears the value object.

Remarks

The Empty method clears this Value object and releases any associated objects.

Product Availability

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

Specified by:
empty in interface IGPValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAsText

public String getAsText()
                 throws IOException,
                        AutomationException
Provides the value of the value object.

Remarks

The GetAsText method returns this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string for the scalar value.

Product Availability

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

Specified by:
getAsText in interface IGPValue
Returns:
The text
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(String text)
                     throws IOException,
                            AutomationException
Provides the value of the value object with the given string value.

Remarks

The SetAsText method sets the value of this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string representing the scalar value.

Product Availability

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

Specified by:
setAsText in interface IGPValue
Parameters:
text - The text (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPMessage
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

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.

Specified by:
setDefault in interface IGPSAVerticalFactor
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.

Specified by:
setBinary in interface IGPSAVerticalFactor
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.

Specified by:
setLinear in interface IGPSAVerticalFactor
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.

Specified by:
setInverseLinear in interface IGPSAVerticalFactor
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.

Specified by:
setTable in interface IGPSAVerticalFactor
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.

Specified by:
setSymLinear in interface IGPSAVerticalFactor
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.

Specified by:
setSymInverseLinear in interface IGPSAVerticalFactor
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.

Specified by:
setCos in interface IGPSAVerticalFactor
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.

Specified by:
setSec in interface IGPSAVerticalFactor
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.

Specified by:
setCosSec in interface IGPSAVerticalFactor
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.

Specified by:
setSecCos in interface IGPSAVerticalFactor
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.

Specified by:
getType in interface IGPSAVerticalFactor
Returns:
A com.esri.arcgis.spatialanalyst.esriPathDistanceVerticalEnum constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException
Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException
Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

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

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

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

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException