|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface INALocatorAgent
Provides access to properties common to all locator agents.
INALocatorAgent has been superseded by INALocatorAgent3.
Method Summary | |
---|---|
void |
bind(INetworkDataset pNetworkDataset,
IGPMessages pGPMessages)
Re-associate the locator with the given network dataset and its schema. |
String |
getName()
The name of the locator agent. |
void |
queryLocationByPoint(IPoint point,
double tolerance,
INALocation[] location,
IPoint[] outPoint,
double[] distanceFromPoint)
Find a network location from a point. |
void |
queryLocationByRow(IRow row,
double tolerance,
INALocation[] location,
double[] distanceFromPoint)
Find a network location from a row. |
void |
queryPoint(INALocation location,
IPoint[] point)
The point for the given network location. |
Method Detail |
---|
String getName() throws IOException, AutomationException
The Name of the locator agent.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void queryLocationByPoint(IPoint point, double tolerance, INALocation[] location, IPoint[] outPoint, double[] distanceFromPoint) throws IOException, AutomationException
QueryLocationByPoint searches for network locations based upon an input point. The corresponding NALocation, the point where the location was found, and the distance from the input point to the source feature found are all returned.
When the NALocatorFeatureAgent is used, the distance returned is from the point to the feature, not from the point to the actual network location on the feature. It is important to know the distance to the feature as a whole because this is the feature on which you want to locate the endpoint/midpoint. If you need to determine the distance from the input point to the actual network location point, use IProximityOperator::ReturnDistance between the input point and the output point.
The NALocatorLocationFieldsAgent should not be used with this method.
point
- A reference to a com.esri.arcgis.geometry.IPoint (in)tolerance
- The tolerance (in)location
- A reference to a com.esri.arcgis.networkanalyst.INALocation (in/out: use single element array)outPoint
- A reference to a com.esri.arcgis.geometry.IPoint (in/out: use single element array)distanceFromPoint
- The distanceFromPoint (in/out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void queryLocationByRow(IRow row, double tolerance, INALocation[] location, double[] distanceFromPoint) throws IOException, AutomationException
QueryLocationByRow searches for network locations based upon the inbound Row. The result is returned as an INALocation.
For a NALocatorFeatureAgent, if the row is a feature, QueryLocationByRow uses the feature geometry to populate the INALocation.
For a NALocatorLocationFieldsAgent, QueryLocationByRow uses the field names specified on INALocatorLocationFieldsAgent to populate the INALocation.
row
- A reference to a com.esri.arcgis.geodatabase.IRow (in)tolerance
- The tolerance (in)location
- A reference to a com.esri.arcgis.networkanalyst.INALocation (in/out: use single element array)distanceFromPoint
- The distanceFromPoint (in/out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void queryPoint(INALocation location, IPoint[] point) throws IOException, AutomationException
The result of calling QueryLocationByPoint or QueryLocationByRow is an INALocation. Use QueryPoint to get the Point that represents this location.
location
- A reference to a com.esri.arcgis.networkanalyst.INALocation (in)point
- A reference to a com.esri.arcgis.geometry.IPoint (in/out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void bind(INetworkDataset pNetworkDataset, IGPMessages pGPMessages) throws IOException, AutomationException
Bind re-associates the NALocator with a network dataset. This method must be called before calling any of the Query functions.
pNetworkDataset
- A reference to a com.esri.arcgis.geodatabase.INetworkDataset (in)pGPMessages
- A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |