com.esri.arcgis.networkanalysis
Interface IPointToEID

All Superinterfaces:

Serializable

All Known Implementing Classes:

PointToEID

public interface IPointToEID
extends Serializable

Provides access to members that find the nearest network element to a given point.

When To Use

Use the methods on IPointToEID to find the nearest network element to a given point in the map.

Product Availability

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

Method Summary

void	getNearestEdge(IPoint inputPoint, int[] nearestEdgeEID, IPoint[] location, double[] percent) Returns the edge EID nearest to the input point, the physical point location that corresponds to the EID, and the percentage along that EID.
void	getNearestJunction(IPoint inputPoint, int[] nearestJunctionEID, IPoint[] location) Returns the junction EID nearest to the input point, and the physical point location that corresponds to the EID.
void	setGeometricNetworkByRef(IGeometricNetwork rhs1) Source geometric network from which the result EID will come.
void	setSnapTolerance(double rhs1) Maximum distance from the input point to an acceptable EID.
void	setSourceMapByRef(IMap rhs1) Source map in which to search for the nearest EID.

Method Detail

setSnapTolerance

void setSnapTolerance(double rhs1)
                      throws IOException,
                             AutomationException

Maximum distance from the input point to an acceptable EID.

Remarks

The snap tolerance is in map units of the source map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometricNetworkByRef

void setGeometricNetworkByRef(IGeometricNetwork rhs1)
                              throws IOException,
                                     AutomationException

Source geometric network from which the result EID will come.

Remarks

The result element ID will be from this geometric network.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.IGeometricNetwork (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceMapByRef

void setSourceMapByRef(IMap rhs1)
                       throws IOException,
                              AutomationException

Source map in which to search for the nearest EID.

Remarks

The result element ID will correspond to a feature in one of the layers in this map.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - A reference to a com.esri.arcgis.carto.IMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNearestEdge

void getNearestEdge(IPoint inputPoint,
                    int[] nearestEdgeEID,
                    IPoint[] location,
                    double[] percent)
                    throws IOException,
                           AutomationException

Returns the edge EID nearest to the input point, the physical point location that corresponds to the EID, and the percentage along that EID.

Remarks

GetNearestEdge returns the element ID of the nearest edge feature.

The location parameter returns the point along the nearest edge feature that is nearest the input point.

The percent parameter returns the percentage along the nearest edge feature that corresponds to the point found in the location parameter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

inputPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

nearestEdgeEID - The nearestEdgeEID (out: use single element array)

location - A reference to a com.esri.arcgis.geometry.IPoint (out: use single element array)

percent - The percent (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNearestJunction

void getNearestJunction(IPoint inputPoint,
                        int[] nearestJunctionEID,
                        IPoint[] location)
                        throws IOException,
                               AutomationException

Returns the junction EID nearest to the input point, and the physical point location that corresponds to the EID.

Remarks

GetNearestJunction returns the element ID of the nearest junction feature.

The location parameter returns the geometry of the nearest junction feature that is nearest the input point.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

inputPoint - A reference to a com.esri.arcgis.geometry.IPoint (in)

nearestJunctionEID - The nearestJunctionEID (out: use single element array)

location - A reference to a com.esri.arcgis.geometry.IPoint (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.