com.esri.arcgis.datasourcesraster
Interface IClipFunctionArguments

All Superinterfaces:
Serializable
All Known Implementing Classes:
ClipFunctionArguments

public interface IClipFunctionArguments
extends Serializable

Provides access to members that control raster clipping function arguments.

Product Availability

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


Method Summary
 IGeometry getClippingGeometry()
          The clipping geometry.
 int getClippingType()
          The raster clipping type.
 IEnvelope getExtent()
          The output extent.
 Object getRaster()
          The source raster object.
 void setClippingGeometryByRef(IGeometry ppClippingGeometry)
          The clipping geometry.
 void setClippingType(int pClippingType)
          The raster clipping type.
 void setExtentByRef(IEnvelope ppExtent)
          The output extent.
 void setRasterByRef(Object ppRaster)
          The source raster object.
 

Method Detail

getRaster

Object getRaster()
                 throws IOException,
                        AutomationException
The source raster object.

Product Availability

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

Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterByRef

void setRasterByRef(Object ppRaster)
                    throws IOException,
                           AutomationException
The source raster object.

Product Availability

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

Parameters:
ppRaster - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClippingGeometry

IGeometry getClippingGeometry()
                              throws IOException,
                                     AutomationException
The clipping geometry.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geometry.IGeometry
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setClippingGeometryByRef

void setClippingGeometryByRef(IGeometry ppClippingGeometry)
                              throws IOException,
                                     AutomationException
The clipping geometry.

Product Availability

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

Parameters:
ppClippingGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClippingType

int getClippingType()
                    throws IOException,
                           AutomationException
The raster clipping type.

Product Availability

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

Returns:
A com.esri.arcgis.datasourcesraster.esriRasterClippingType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setClippingType

void setClippingType(int pClippingType)
                     throws IOException,
                            AutomationException
The raster clipping type.

Product Availability

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

Parameters:
pClippingType - A com.esri.arcgis.datasourcesraster.esriRasterClippingType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException
The output extent.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExtentByRef

void setExtentByRef(IEnvelope ppExtent)
                    throws IOException,
                           AutomationException
The output extent.

Product Availability

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

Parameters:
ppExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.