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, Externalizable, Serializable

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

The TerrainToRasterFunction arguments.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

TerrainToRasterFunctionArguments()
Constructs a TerrainToRasterFunctionArguments using ArcGIS Engine.

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

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(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 String	getClsid() getClsid.
IStringArray	getFileList() The list of all files associated with the arguments.
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
Object	getTerrain() The input terrain or terrain name.
int	getTinToRasterInterpolationType() Tin to raster interpolation type (how to rasterize the tin: Linear or NN).
Object	getValue(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(String name, Object value) Puts a named argument value.
void	readExternal(ObjectInput in)
void	remove(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(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(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

TerrainToRasterFunctionArguments

public TerrainToRasterFunctionArguments()
                                 throws IOException,
                                        UnknownHostException

Constructs a TerrainToRasterFunctionArguments using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TerrainToRasterFunctionArguments

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

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

getValue

public Object getValue(String name)
                throws IOException,
                       AutomationException

Gets a named argument value.

Product Availability

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

Specified by:

getValue in interface IRasterFunctionArguments

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putValue

public void putValue(String name,
                     Object value)
              throws IOException,
                     AutomationException

Puts a named argument value.

Product Availability

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

Specified by:

putValue in interface IRasterFunctionArguments

Parameters:

name - The name (in)

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(String name)
            throws IOException,
                   AutomationException

Removes a named argument value.

Product Availability

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

Specified by:

remove in interface IRasterFunctionArguments

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws IOException,
                      AutomationException

Removes all argument values.

Product Availability

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

Specified by:

removeAll in interface IRasterFunctionArguments

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNames

public IStringArray getNames()
                      throws IOException,
                             AutomationException

The list of all argument names.

Product Availability

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

Specified by:

getNames in interface IRasterFunctionArguments

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValues

public IVariantArray getValues()
                        throws IOException,
                               AutomationException

The list of all arguments.

Product Availability

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

Specified by:

getValues in interface IRasterFunctionArguments

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFileList

public IStringArray getFileList()
                         throws IOException,
                                AutomationException

The list of all files associated with the arguments.

Product Availability

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

Specified by:

getFileList in interface IRasterFunctionArguments

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resolve

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

Resolves function variables using a row and set of properties.

Product Availability

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

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:

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 IOException,
                   AutomationException

Updates function variables using a row and set of properties.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheLocation

public IName getCacheLocation()
                       throws IOException,
                              AutomationException

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

Product Availability

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

Specified by:

getCacheLocation in interface IRasterCacheArguments

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCacheLocationByRef

public void setCacheLocationByRef(IName ppName)
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Specified by:

setCacheLocationByRef in interface IRasterCacheArguments

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTerrain

public Object getTerrain()
                  throws IOException,
                         AutomationException

The input terrain or terrain name.

Product Availability

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

Specified by:

getTerrain in interface ITerrainToRasterFunctionArguments

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTerrainByRef

public void setTerrainByRef(Object ppTerrain)
                     throws IOException,
                            AutomationException

The input terrain or terrain name.

Product Availability

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

Specified by:

setTerrainByRef in interface ITerrainToRasterFunctionArguments

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCellWidth

public double getCellWidth()
                    throws IOException,
                           AutomationException

Cell width.

Product Availability

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

Specified by:

getCellWidth in interface ITerrainToRasterFunctionArguments

Returns:

The pCellWidth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCellWidth

public void setCellWidth(double pCellWidth)
                  throws IOException,
                         AutomationException

Cell width.

Product Availability

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

Specified by:

setCellWidth in interface ITerrainToRasterFunctionArguments

Parameters:

pCellWidth - The pCellWidth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTinToRasterInterpolationType

public int getTinToRasterInterpolationType()
                                    throws IOException,
                                           AutomationException

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

Product Availability

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

Specified by:

getTinToRasterInterpolationType in interface ITerrainToRasterFunctionArguments

Returns:

A com.esri.arcgis.geodatabase.esriSurfaceInterpolationType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTinToRasterInterpolationType

public void setTinToRasterInterpolationType(int pType)
                                     throws IOException,
                                            AutomationException

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

Product Availability

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

Specified by:

setTinToRasterInterpolationType in interface ITerrainToRasterFunctionArguments

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheMaxNumSurfaces

public int getCacheMaxNumSurfaces()
                           throws IOException,
                                  AutomationException

Maximum number of different surfaces kept in this cache folder.

Product Availability

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

Specified by:

getCacheMaxNumSurfaces in interface ITerrainToRasterFunctionArguments

Returns:

The pMaxNumSurfaces

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCacheMaxNumSurfaces

public void setCacheMaxNumSurfaces(int pMaxNumSurfaces)
                            throws IOException,
                                   AutomationException

Maximum number of different surfaces kept in this cache folder.

Product Availability

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

Specified by:

setCacheMaxNumSurfaces in interface ITerrainToRasterFunctionArguments

Parameters:

pMaxNumSurfaces - The pMaxNumSurfaces (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCacheRasterZTolerance

public double getCacheRasterZTolerance()
                                throws IOException,
                                       AutomationException

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

Product Availability

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

Specified by:

getCacheRasterZTolerance in interface ITerrainToRasterFunctionArguments

Returns:

The pZTolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCacheRasterZTolerance

public void setCacheRasterZTolerance(double pZTolerance)
                              throws IOException,
                                     AutomationException

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

Product Availability

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

Specified by:

setCacheRasterZTolerance in interface ITerrainToRasterFunctionArguments

Parameters:

pZTolerance - The pZTolerance (in)

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.

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.

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.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

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

Product Availability

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPaths

public IStringArray getPaths()
                      throws IOException,
                             AutomationException

Returns all paths associated with the object.

Product Availability

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

Specified by:

getPaths in interface IItemPaths

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

replacePaths

public void replacePaths(IStringArray pOldPaths,
                         IStringArray pNewPaths)
                  throws 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.

Product Availability

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

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPathsEx

public IStringArray getPathsEx(IItemPathsOptions pOptions)
                        throws IOException,
                               AutomationException

Returns all paths associated with the object.

Product Availability

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

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:

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