com.esri.arcgis.networkanalysis
Class PointToEID

java.lang.Object
  com.esri.arcgis.networkanalysis.PointToEID

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IPointToEID, Serializable

public class PointToEID
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPointToEID

A container for finding the nearest network element ID to a given point.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

PointToEID()
Constructs a PointToEID using ArcGIS Engine.

PointToEID(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PointToEID thePointToEID = (PointToEID) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
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.
int	hashCode() the hashcode for this object
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

PointToEID

public PointToEID()
           throws IOException,
                  UnknownHostException

Constructs a PointToEID using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

PointToEID

public PointToEID(Object obj)
           throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
PointToEID thePointToEID = (PointToEID) obj;

Construct a PointToEID using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to PointToEID.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setSnapTolerance

public 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

Specified by:

setSnapTolerance in interface IPointToEID

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometricNetworkByRef

public 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

Specified by:

setGeometricNetworkByRef in interface IPointToEID

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

public 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

Specified by:

setSourceMapByRef in interface IPointToEID

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

public 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

Specified by:

getNearestEdge in interface IPointToEID

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

public 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

Specified by:

getNearestJunction in interface IPointToEID

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.