com.esri.arcgis.datasourcesraster

Class HillshadeFunctionArguments

java.lang.Object

com.esri.arcgis.datasourcesraster.HillshadeFunctionArguments

All Implemented Interfaces:

IHillshadeFunctionArguments, IRasterFunctionArguments, IRasterFunctionArguments2, ISlopeScalingArguments, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class HillshadeFunctionArguments
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterFunctionArguments, IRasterFunctionArguments2, IHillshadeFunctionArguments, ISlopeScalingArguments, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable

COM Class 'HillshadeFunctionArguments'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'The Hillshade function arguments.' 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

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterFunctionArguments2

IID, IIDfd4f0d2d_1f81_4b2d_8ae5_90cef59c3cfe, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterFunctionArguments

IID04aa081e_28b0_47e4_b375_f367046da924

Fields inherited from interface com.esri.arcgis.datasourcesraster.IHillshadeFunctionArguments

IID, IID14a88f3b_6bee_4f29_940b_f0d30d241d0d, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.ISlopeScalingArguments

IID, IIDb2a1643a_41cd_4b9d_a568_6ca85b7e7031, 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

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

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

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

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

Constructor Summary

Constructors

Constructor and Description
HillshadeFunctionArguments() Constructs a HillshadeFunctionArguments using ArcGIS Engine.
HillshadeFunctionArguments(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. HillshadeFunctionArguments theHillshadeFunctionArguments = (HillshadeFunctionArguments) obj;

Method Summary

Modifier and Type	Method and Description
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
void	fromJSON(IJSONObject pJSON, IRasterFunctionTemplateMapper pOptRFTMapper) Loads raster function arguments from JSON.
double	getAltitude() The solar altitude angle in degrees.
double	getAzimuth() The solar azimuth angle in degrees with 0 toward North.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.Object	getDEM() The input elevation model.
IStringArray	getFileList() The list of all files associated with the arguments.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
IStringArray	getNames() The list of all argument names.
double	getPixelSizeFactor() The Z scale factor that converts z value to a function of x and y.
double	getPixelSizePower() Pixel size power
int	getScalingType() The output scaling method.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
java.lang.Object	getValue(java.lang.String name) Gets a named argument value.
IVariantArray	getValues() The list of all arguments.
double	getZFactor() The Z scale factor that converts z value to the unit of x and y.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isRemoveEdgeEffect() Flag to remove seams from multi resolution datasets.
void	load(IStream pstm) load
void	putValue(java.lang.String name, java.lang.Object value) Puts a named argument value.
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	remove(java.lang.String name) Removes a named argument value.
void	removeAll() Removes all argument values.
void	resolve(IRow pRow, IPropertySet pPropertySet) Resolves function variables using a row and set of properties.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAltitude(double pAltitude) The solar altitude angle in degrees.
void	setAzimuth(double pAzimuth) The solar azimuth angle in degrees with 0 toward North.
void	setDEMByRef(java.lang.Object ppDEM) The input elevation model.
void	setPixelSizeFactor(double psZFactor) The Z scale factor that converts z value to a function of x and y.
void	setPixelSizePower(double psPower) Pixel size power
void	setRemoveEdgeEffect(boolean pRemoveEdgeEffect) Flag to remove seams from multi resolution datasets.
void	setScalingType(int scalingType) The output scaling method.
void	setZFactor(double pZfactor) The Z scale factor that converts z value to the unit of x and y.
IJSONObject	toJSON() Saves raster function arguments to JSON.
void	update(IRow pRow, IPropertySet pPropertySet, IRasterFunctionArguments pTemplateArguments) Updates function variables using a row and set of properties.
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

HillshadeFunctionArguments

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

Constructs a HillshadeFunctionArguments using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

HillshadeFunctionArguments

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

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

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

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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

getValue

public java.lang.Object getValue(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException

Gets a named argument value.

Specified by:

getValue in interface IRasterFunctionArguments

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

putValue

public void putValue(java.lang.String name,
                     java.lang.Object value)
              throws java.io.IOException,
                     AutomationException

Puts a named argument value.

Specified by:

putValue in interface IRasterFunctionArguments

Parameters:

name - The name (in)

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(java.lang.String name)
            throws java.io.IOException,
                   AutomationException

Removes a named argument value.

Specified by:

remove in interface IRasterFunctionArguments

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAll

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

Removes all argument values.

Specified by:

removeAll in interface IRasterFunctionArguments

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNames

public IStringArray getNames()
                      throws java.io.IOException,
                             AutomationException

The list of all argument names.

Specified by:

getNames in interface IRasterFunctionArguments

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValues

public IVariantArray getValues()
                        throws java.io.IOException,
                               AutomationException

The list of all arguments.

Specified by:

getValues in interface IRasterFunctionArguments

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFileList

public IStringArray getFileList()
                         throws java.io.IOException,
                                AutomationException

The list of all files associated with the arguments.

Specified by:

getFileList in interface IRasterFunctionArguments

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

resolve

public void resolve(IRow pRow,
                    IPropertySet pPropertySet)
             throws java.io.IOException,
                    AutomationException

Resolves function variables using a row and set of properties.

Specified by:

resolve in interface IRasterFunctionArguments

Parameters:

pRow - A reference to a com.esri.arcgis.geodatabase.IRow (in)

pPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update

public void update(IRow pRow,
                   IPropertySet pPropertySet,
                   IRasterFunctionArguments pTemplateArguments)
            throws java.io.IOException,
                   AutomationException

Updates function variables using a row and set of properties.

Specified by:

update in interface IRasterFunctionArguments

Parameters:

pRow - A reference to a com.esri.arcgis.geodatabase.IRow (in)

pPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

pTemplateArguments - A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionArguments (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

toJSON

public IJSONObject toJSON()
                   throws java.io.IOException,
                          AutomationException

Saves raster function arguments to JSON.

Specified by:

toJSON in interface IRasterFunctionArguments2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

fromJSON

public void fromJSON(IJSONObject pJSON,
                     IRasterFunctionTemplateMapper pOptRFTMapper)
              throws java.io.IOException,
                     AutomationException

Loads raster function arguments from JSON.

Specified by:

fromJSON in interface IRasterFunctionArguments2

Parameters:

pJSON - A reference to a com.esri.arcgis.system.IJSONObject (in)

pOptRFTMapper - A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionTemplateMapper (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDEM

public java.lang.Object getDEM()
                        throws java.io.IOException,
                               AutomationException

The input elevation model.

Specified by:

getDEM in interface IHillshadeFunctionArguments

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDEMByRef

public void setDEMByRef(java.lang.Object ppDEM)
                 throws java.io.IOException,
                        AutomationException

The input elevation model.

Specified by:

setDEMByRef in interface IHillshadeFunctionArguments

Parameters:

ppDEM - A reference to another Object (IUnknown) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAzimuth

public double getAzimuth()
                  throws java.io.IOException,
                         AutomationException

The solar azimuth angle in degrees with 0 toward North.

Specified by:

getAzimuth in interface IHillshadeFunctionArguments

Returns:

The pAzimuth

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAzimuth

public void setAzimuth(double pAzimuth)
                throws java.io.IOException,
                       AutomationException

The solar azimuth angle in degrees with 0 toward North.

Specified by:

setAzimuth in interface IHillshadeFunctionArguments

Parameters:

pAzimuth - The pAzimuth (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAltitude

public double getAltitude()
                   throws java.io.IOException,
                          AutomationException

The solar altitude angle in degrees.

Specified by:

getAltitude in interface IHillshadeFunctionArguments

Returns:

The pAltitude

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAltitude

public void setAltitude(double pAltitude)
                 throws java.io.IOException,
                        AutomationException

The solar altitude angle in degrees.

Specified by:

setAltitude in interface IHillshadeFunctionArguments

Parameters:

pAltitude - The pAltitude (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getZFactor

public double getZFactor()
                  throws java.io.IOException,
                         AutomationException

The Z scale factor that converts z value to the unit of x and y.

Specified by:

getZFactor in interface IHillshadeFunctionArguments

Returns:

The pZfactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setZFactor

public void setZFactor(double pZfactor)
                throws java.io.IOException,
                       AutomationException

The Z scale factor that converts z value to the unit of x and y.

Specified by:

setZFactor in interface IHillshadeFunctionArguments

Parameters:

pZfactor - The pZfactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelSizePower

public double getPixelSizePower()
                         throws java.io.IOException,
                                AutomationException

Pixel size power

Specified by:

getPixelSizePower in interface ISlopeScalingArguments

Returns:

The psPower

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPixelSizePower

public void setPixelSizePower(double psPower)
                       throws java.io.IOException,
                              AutomationException

Pixel size power

Specified by:

setPixelSizePower in interface ISlopeScalingArguments

Parameters:

psPower - The psPower (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPixelSizeFactor

public double getPixelSizeFactor()
                          throws java.io.IOException,
                                 AutomationException

The Z scale factor that converts z value to a function of x and y.

Specified by:

getPixelSizeFactor in interface ISlopeScalingArguments

Returns:

The psZFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPixelSizeFactor

public void setPixelSizeFactor(double psZFactor)
                        throws java.io.IOException,
                               AutomationException

The Z scale factor that converts z value to a function of x and y.

Specified by:

setPixelSizeFactor in interface ISlopeScalingArguments

Parameters:

psZFactor - The psZFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getScalingType

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

The output scaling method.

Specified by:

getScalingType in interface ISlopeScalingArguments

Returns:

A com.esri.arcgis.datasourcesraster.esriSlopeType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setScalingType

public void setScalingType(int scalingType)
                    throws java.io.IOException,
                           AutomationException

The output scaling method.

Specified by:

setScalingType in interface ISlopeScalingArguments

Parameters:

scalingType - A com.esri.arcgis.datasourcesraster.esriSlopeType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRemoveEdgeEffect

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

Flag to remove seams from multi resolution datasets.

Specified by:

isRemoveEdgeEffect in interface ISlopeScalingArguments

Returns:

The pRemoveEdgeEffect

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRemoveEdgeEffect

public void setRemoveEdgeEffect(boolean pRemoveEdgeEffect)
                         throws java.io.IOException,
                                AutomationException

Flag to remove seams from multi resolution datasets.

Specified by:

setRemoveEdgeEffect in interface ISlopeScalingArguments

Parameters:

pRemoveEdgeEffect - The pRemoveEdgeEffect (in)

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.

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.

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.

getMinNamespaceSupported

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

The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

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