com.esri.arcgis.geodatabaseextensions

Class TerrainToRasterFunctionArguments

java.lang.Object

com.esri.arcgis.geodatabaseextensions.TerrainToRasterFunctionArguments

All Implemented Interfaces:

IItemPaths, IItemPaths2, IRasterCacheArguments, IRasterFunctionArguments, ITerrainToRasterFunctionArguments, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class TerrainToRasterFunctionArguments
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterFunctionArguments, IRasterCacheArguments, ITerrainToRasterFunctionArguments, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, IItemPaths, IItemPaths2, java.io.Externalizable

COM Class 'TerrainToRasterFunctionArguments'. Generated 9/21/2023 10:01:44 AM from 'X:\ArcGIS\com\server\esriGeoDatabaseExtensions.tlb'

Description 'The TerrainToRasterFunction 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.IRasterFunctionArguments

IID, IID04aa081e_28b0_47e4_b375_f367046da924, xxDummy

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

IID, IID454319d6_468a_4143_9bbc_571f0e51e656, xxDummy

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

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

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

IID, IID9c76b127_61ac_4e66_99b0_8c14a9a386ea, xxDummy

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

IIDcafd4e87_0672_43e0_b92d_175306c1a309

Constructor Summary

Constructors

Constructor and Description
TerrainToRasterFunctionArguments() Constructs a TerrainToRasterFunctionArguments using ArcGIS Engine.
TerrainToRasterFunctionArguments(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. TerrainToRasterFunctionArguments theTerrainToRasterFunctionArguments = (TerrainToRasterFunctionArguments) 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
IName	getCacheLocation() Location where the item cache gets generated.
int	getCacheMaxNumSurfaces() Maximum number of different surfaces kept in this cache folder.
double	getCacheRasterZTolerance() Z tolerance for rasters in the image cache folder, used for compression.
double	getCellWidth() Cell width.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
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.
IStringArray	getPaths() Returns all paths associated with the object.
IStringArray	getPathsEx(IItemPathsOptions pOptions) Returns all paths associated with the object.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
java.lang.Object	getTerrain() The input terrain or terrain name.
int	getTinToRasterInterpolationType() Tin to raster interpolation type (how to rasterize the tin: Linear or NN).
java.lang.Object	getValue(java.lang.String name) Gets a named argument value.
IVariantArray	getValues() The list of all arguments.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
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	replacePaths(IStringArray pOldPaths, IStringArray pNewPaths) Updates all paths associated with the object using the specified mapping rule.
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	setCacheLocationByRef(IName ppName) Location where the item cache gets generated.
void	setCacheMaxNumSurfaces(int pMaxNumSurfaces) Maximum number of different surfaces kept in this cache folder.
void	setCacheRasterZTolerance(double pZTolerance) Z tolerance for rasters in the image cache folder, used for compression.
void	setCellWidth(double pCellWidth) Cell width.
void	setTerrainByRef(java.lang.Object ppTerrain) The input terrain or terrain name.
void	setTinToRasterInterpolationType(int pType) Tin to raster interpolation type (how to rasterize the tin: Linear or NN).
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

TerrainToRasterFunctionArguments

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

Constructs a TerrainToRasterFunctionArguments using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TerrainToRasterFunctionArguments

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

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

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

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.

getCacheLocation

public IName getCacheLocation()
                       throws java.io.IOException,
                              AutomationException

Location where the item cache gets generated. This could be a workspace name or a table name

Specified by:

getCacheLocation in interface IRasterCacheArguments

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCacheLocationByRef

public void setCacheLocationByRef(IName ppName)
                           throws java.io.IOException,
                                  AutomationException

Location where the item cache gets generated. This could be a workspace name or a table name

Specified by:

setCacheLocationByRef in interface IRasterCacheArguments

Parameters:

ppName - A reference to a com.esri.arcgis.system.IName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTerrain

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

The input terrain or terrain name.

Specified by:

getTerrain in interface ITerrainToRasterFunctionArguments

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTerrainByRef

public void setTerrainByRef(java.lang.Object ppTerrain)
                     throws java.io.IOException,
                            AutomationException

The input terrain or terrain name.

Specified by:

setTerrainByRef in interface ITerrainToRasterFunctionArguments

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCellWidth

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

Cell width.

Specified by:

getCellWidth in interface ITerrainToRasterFunctionArguments

Returns:

The pCellWidth

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCellWidth

public void setCellWidth(double pCellWidth)
                  throws java.io.IOException,
                         AutomationException

Cell width.

Specified by:

setCellWidth in interface ITerrainToRasterFunctionArguments

Parameters:

pCellWidth - The pCellWidth (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTinToRasterInterpolationType

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

Tin to raster interpolation type (how to rasterize the tin: Linear or NN).

Specified by:

getTinToRasterInterpolationType in interface ITerrainToRasterFunctionArguments

Returns:

A com.esri.arcgis.geodatabase.esriSurfaceInterpolationType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTinToRasterInterpolationType

public void setTinToRasterInterpolationType(int pType)
                                     throws java.io.IOException,
                                            AutomationException

Tin to raster interpolation type (how to rasterize the tin: Linear or NN).

Specified by:

setTinToRasterInterpolationType in interface ITerrainToRasterFunctionArguments

Parameters:

pType - A com.esri.arcgis.geodatabase.esriSurfaceInterpolationType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCacheMaxNumSurfaces

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

Maximum number of different surfaces kept in this cache folder.

Specified by:

getCacheMaxNumSurfaces in interface ITerrainToRasterFunctionArguments

Returns:

The pMaxNumSurfaces

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCacheMaxNumSurfaces

public void setCacheMaxNumSurfaces(int pMaxNumSurfaces)
                            throws java.io.IOException,
                                   AutomationException

Maximum number of different surfaces kept in this cache folder.

Specified by:

setCacheMaxNumSurfaces in interface ITerrainToRasterFunctionArguments

Parameters:

pMaxNumSurfaces - The pMaxNumSurfaces (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCacheRasterZTolerance

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

Z tolerance for rasters in the image cache folder, used for compression.

Specified by:

getCacheRasterZTolerance in interface ITerrainToRasterFunctionArguments

Returns:

The pZTolerance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCacheRasterZTolerance

public void setCacheRasterZTolerance(double pZTolerance)
                              throws java.io.IOException,
                                     AutomationException

Z tolerance for rasters in the image cache folder, used for compression.

Specified by:

setCacheRasterZTolerance in interface ITerrainToRasterFunctionArguments

Parameters:

pZTolerance - The pZTolerance (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.

getPaths

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

Returns all paths associated with the object.

Specified by:

getPaths in interface IItemPaths

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.

replacePaths

public void replacePaths(IStringArray pOldPaths,
                         IStringArray pNewPaths)
                  throws java.io.IOException,
                         AutomationException

Updates all paths associated with the object using the specified mapping rule. The number of values in the two arrays must be the same.

Specified by:

replacePaths in interface IItemPaths

Parameters:

pOldPaths - A reference to a com.esri.arcgis.system.IStringArray (in)

pNewPaths - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPathsEx

public IStringArray getPathsEx(IItemPathsOptions pOptions)
                        throws java.io.IOException,
                               AutomationException

Returns all paths associated with the object.

Specified by:

getPathsEx in interface IItemPaths2

Parameters:

pOptions - A reference to a com.esri.arcgis.datasourcesraster.IItemPathsOptions (in)

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.

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