com.esri.arcgis.geoprocessing
Interface IGPEnvelope

All Superinterfaces:
Serializable
All Known Implementing Classes:
GPEnvelope

public interface IGPEnvelope
extends Serializable

Provides access to the properties/methods of a geoprocessing envelope object.

Product Availability

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

Supported Platforms

Windows


Method Summary
 IEnvelope getExtent()
          The extent of the geoprocessing envelope.
 double getXMax()
          The maximum X value of the geoprocessing envelope.
 double getXMin()
          The minimum X value of the geoprocessing envelope.
 double getYMax()
          The maximum Y value of the geoprocessing envelope.
 double getYMin()
          The minimum Y value of the geoprocessing envelope.
 void setCoords(double xMin, double yMin, double xMax, double yMax)
          Sets the extent of the geoprocessing envelope given the x/y minimum/maximum values.
 void setExtentByRef(IEnvelope ppExtent)
          The extent of the geoprocessing envelope.
 void setXMax(double xMax)
          The maximum X value of the geoprocessing envelope.
 void setXMin(double xMin)
          The minimum X value of the geoprocessing envelope.
 void setYMax(double yMax)
          The maximum Y value of the geoprocessing envelope.
 void setYMin(double yMin)
          The minimum Y value of the geoprocessing envelope.
 

Method Detail

getXMin

double getXMin()
               throws IOException,
                      AutomationException
The minimum X value of the geoprocessing envelope.

Product Availability

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

Supported Platforms

Windows

Returns:
The xMin
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setXMin

void setXMin(double xMin)
             throws IOException,
                    AutomationException
The minimum X value of the geoprocessing envelope.

Product Availability

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

Supported Platforms

Windows

Parameters:
xMin - The xMin (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getYMin

double getYMin()
               throws IOException,
                      AutomationException
The minimum Y value of the geoprocessing envelope.

Product Availability

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

Supported Platforms

Windows

Returns:
The yMin
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setYMin

void setYMin(double yMin)
             throws IOException,
                    AutomationException
The minimum Y value of the geoprocessing envelope.

Product Availability

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

Supported Platforms

Windows

Parameters:
yMin - The yMin (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getXMax

double getXMax()
               throws IOException,
                      AutomationException
The maximum X value of the geoprocessing envelope.

Product Availability

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

Supported Platforms

Windows

Returns:
The xMax
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setXMax

void setXMax(double xMax)
             throws IOException,
                    AutomationException
The maximum X value of the geoprocessing envelope.

Product Availability

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

Supported Platforms

Windows

Parameters:
xMax - The xMax (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getYMax

double getYMax()
               throws IOException,
                      AutomationException
The maximum Y value of the geoprocessing envelope.

Product Availability

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

Supported Platforms

Windows

Returns:
The yMax
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setYMax

void setYMax(double yMax)
             throws IOException,
                    AutomationException
The maximum Y value of the geoprocessing envelope.

Product Availability

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

Supported Platforms

Windows

Parameters:
yMax - The yMax (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException
The extent of the geoprocessing envelope.

Product Availability

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

Supported Platforms

Windows

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 extent of the geoprocessing envelope.

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.

setCoords

void setCoords(double xMin,
               double yMin,
               double xMax,
               double yMax)
               throws IOException,
                      AutomationException
Sets the extent of the geoprocessing envelope given the x/y minimum/maximum values.

Product Availability

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

Supported Platforms

Windows

Parameters:
xMin - The xMin (in)
yMin - The yMin (in)
xMax - The xMax (in)
yMax - The yMax (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.