com.esri.arcgis.geoprocessing
Interface IGpDescribeGeometry

All Superinterfaces:

Serializable

All Known Implementing Classes:

IGpDescribeGeometryProxy

public interface IGpDescribeGeometry
extends Serializable

Provides access to the properties and methods of the Describe Geometry object.

Product Availability

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

Method Summary

double	getArea() The area of the geometry object.
String	getCentroid(Object pInside) The centroid of the geometry object; returns label point if centroid is outside.
String	getExtent() The extent of the geometry object.
String	getFirstPoint() The first point of the geometry object.
IGeometry	getGeometry() Sets the geometry property.
String	getHullRectangle() The four corners of the most narrow enclosing rectangle.
String	getIsMultipart() Indicates whether the geometry object contains more than one part.
String	getLabelPoint() The (inside) label point of the geometry object.
String	getLastPoint() The last point of the geometry object.
double	getLength() The length of the geometry object.
Object	getPart(Object part) Returns the part of the geometry object at the specified index.
int	getPartCount() The number of parts of the geometry object.
int	getPointCount() The number of points of the geometry object.
String	getTrueCentroid() The true centroid of the geometry object.
String	getType() The geometry type of the geometry object.

Method Detail

getType

String getType()
               throws IOException,
                      AutomationException

The geometry type of the geometry object.

Product Availability

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

Supported Platforms

Windows

Returns:

The type

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

String getExtent()
                 throws IOException,
                        AutomationException

The extent of the geometry object.

Product Availability

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

Supported Platforms

Windows

Returns:

The extent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCentroid

String getCentroid(Object pInside)
                   throws IOException,
                          AutomationException

The centroid of the geometry object; returns label point if centroid is outside.

Product Availability

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

Parameters:

pInside - A Variant (in, optional, pass null if not required)

Returns:

The centroid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrueCentroid

String getTrueCentroid()
                       throws IOException,
                              AutomationException

The true centroid of the geometry object.

Product Availability

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

Returns:

The centroid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelPoint

String getLabelPoint()
                     throws IOException,
                            AutomationException

The (inside) label point of the geometry object.

Product Availability

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

Returns:

The labelPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFirstPoint

String getFirstPoint()
                     throws IOException,
                            AutomationException

The first point of the geometry object.

Product Availability

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

Supported Platforms

Windows

Returns:

The firstPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastPoint

String getLastPoint()
                    throws IOException,
                           AutomationException

The last point of the geometry object.

Product Availability

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

Supported Platforms

Windows

Returns:

The lastPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getArea

double getArea()
               throws IOException,
                      AutomationException

The area of the geometry object.

Product Availability

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

Supported Platforms

Windows

Returns:

The area

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLength

double getLength()
                 throws IOException,
                        AutomationException

The length of the geometry object.

Product Availability

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

Supported Platforms

Windows

Returns:

The length

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIsMultipart

String getIsMultipart()
                      throws IOException,
                             AutomationException

Indicates whether the geometry object contains more than one part.

Product Availability

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

Supported Platforms

Windows

Returns:

The multipart

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPartCount

int getPartCount()
                 throws IOException,
                        AutomationException

The number of parts of the geometry object.

Product Availability

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

Supported Platforms

Windows

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPart

Object getPart(Object part)
               throws IOException,
                      AutomationException

Returns the part of the geometry object at the specified index.

Product Availability

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

Supported Platforms

Windows

Parameters:

part - A Variant (in, optional, pass null if not required)

Returns:

A reference to another Automation Object (IDispatch)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometry

IGeometry getGeometry()
                      throws IOException,
                             AutomationException

Sets the geometry property.

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.

getHullRectangle

String getHullRectangle()
                        throws IOException,
                               AutomationException

The four corners of the most narrow enclosing rectangle.

Product Availability

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

Returns:

The rectangle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPointCount

int getPointCount()
                  throws IOException,
                         AutomationException

The number of points of the geometry object.

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.