com.esri.arcgis.controls
Interface IEngineNetworkAnalystHelper

All Superinterfaces:

Serializable

All Known Subinterfaces:

IEngineNetworkAnalystHelper2

All Known Implementing Classes:

EngineNetworkAnalystEnvironment

public interface IEngineNetworkAnalystHelper
extends Serializable

Provides access to actions that operate on the network analyst extension.

Product Availability

Available with ArcGIS Engine.

Method Summary

void	addNetworkLocation(IPoint pPoint, String name) Adds a network location to the NAWindow at the specified point.
void	deleteAllNetworkLocations() Delete all network locations of active category for active analysis.
INAStreetDirectionsContainer	getDirections() Get directions after solving.
void	solve() Solve for current network locations.

Method Detail

addNetworkLocation

void addNetworkLocation(IPoint pPoint,
                        String name)
                        throws IOException,
                               AutomationException

Adds a network location to the NAWindow at the specified point.

Description

Adds the specified point to the IEngineNAWindow::ActiveCategory of the IEngineNAWindow::ActiveAnalysis layer as a network location.

Product Availability

Available with ArcGIS Engine.

Parameters:

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

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteAllNetworkLocations

void deleteAllNetworkLocations()
                               throws IOException,
                                      AutomationException

Delete all network locations of active category for active analysis.

Description

Deletes all network locations in the IEngineNAWindow::ActiveCategory of the IEngineNAWindow::ActiveAnalysis layer.

Product Availability

Available with ArcGIS Engine.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirections

INAStreetDirectionsContainer getDirections()
                                           throws IOException,
                                                  AutomationException

Get directions after solving.

Description

Use the GetDirections method after using the Solve method to return directions contents in XML format. Using GetDirections before the Solve method will return nothing.

Product Availability

Available with ArcGIS Engine.

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAStreetDirectionsContainer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

solve

void solve()
           throws IOException,
                  AutomationException

Solve for current network locations.

Description

Solve performs network analysis based upon the IEngineNAWindow::ActiveAnalysis layer and the NAContext.

Product Availability

Available with ArcGIS Engine.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.