com.esri.arcgis.geoprocessing
Interface IGPLine

All Superinterfaces:
Serializable
All Known Implementing Classes:
GPLine

public interface IGPLine
extends Serializable

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

Product Availability

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

Supported Platforms

Windows


Method Summary
 void addCoords(double x, double y)
          Adds a point to the line given the x/y coordinates.
 void addPoint(IGPPoint point)
          Adds a point to the line.
 void getCoords(int index, double[] x, double[] y)
          Returns the x/y coordinates of the point at the given index.
 int getCount()
          The number of points in the line.
 IGPPoint getPoint(int index)
          Returns the point at the given index.
 

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException
The number of points in the line.

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.

getPoint

IGPPoint getPoint(int index)
                  throws IOException,
                         AutomationException
Returns the point at the given index.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPPoint
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addPoint

void addPoint(IGPPoint point)
              throws IOException,
                     AutomationException
Adds a point to the line.

Product Availability

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

Supported Platforms

Windows

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

getCoords

void getCoords(int index,
               double[] x,
               double[] y)
               throws IOException,
                      AutomationException
Returns the x/y coordinates of the point at the given index.

Product Availability

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

Supported Platforms

Windows

Parameters:
index - The index (in)
x - The x (out: use single element array)
y - The y (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addCoords

void addCoords(double x,
               double y)
               throws IOException,
                      AutomationException
Adds a point to the line given the x/y coordinates.

Product Availability

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

Supported Platforms

Windows

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