com.esri.arcgis.controls
Interface IEngineNetworkAnalystEnvironment

All Superinterfaces:

Serializable

All Known Implementing Classes:

EngineNetworkAnalystEnvironment

public interface IEngineNetworkAnalystEnvironment
extends Serializable

Provides access to the network analyst extension.

Description

The IEngineNetworkAnalystEnvironment interface is the main interface on the EngineNetworkAnalystEnvironment singleton object and used to access the INetworkLayer objects and the NAWindow.

Product Availability

Available with ArcGIS Engine.

Method Summary

INetworkLayer	getCurrentNetworkLayer() The current network layer.
IEngineNAWindow	getNAWindow() The network analysis window.
INetworkLayer	getNetworkLayer(int index) The network layer by index.
int	getNetworkLayerCount() The number of network layers.
int	getShowAnalysisMessagesAfterSolve() The types of messages that are displayed after solving.
boolean	isZoomToResultAfterSolve() Indicates if the window should zoom the map to show results after solving.
void	setCurrentNetworkLayer(INetworkLayer layer) The current network layer.
void	setShowAnalysisMessagesAfterSolve(int messageTypes) The types of messages that are displayed after solving.
void	setZoomToResultAfterSolve(boolean flag) Indicates if the window should zoom the map to show results after solving.

Method Detail

getNAWindow

IEngineNAWindow getNAWindow()
                            throws IOException,
                                   AutomationException

The network analysis window.

Description

Returns the Engine Network Analyst Window.

Product Availability

Available with ArcGIS Engine.

Returns:

A reference to a com.esri.arcgis.controls.IEngineNAWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNetworkLayerCount

int getNetworkLayerCount()
                         throws IOException,
                                AutomationException

The number of network layers.

Description

Returns the number of INetworkLayer objects referencing NetworkDataset objects in the map.

Product Availability

Available with ArcGIS Engine.

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNetworkLayer

INetworkLayer getNetworkLayer(int index)
                              throws IOException,
                                     AutomationException

The network layer by index.

Product Availability

Available with ArcGIS Engine.

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.carto.INetworkLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentNetworkLayer

INetworkLayer getCurrentNetworkLayer()
                                     throws IOException,
                                            AutomationException

The current network layer.

Description

The currently selected INetworkLayer object.

Product Availability

Available with ArcGIS Engine.

Returns:

A reference to a com.esri.arcgis.carto.INetworkLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentNetworkLayer

void setCurrentNetworkLayer(INetworkLayer layer)
                            throws IOException,
                                   AutomationException

The current network layer.

Product Availability

Available with ArcGIS Engine.

Parameters:

layer - A reference to a com.esri.arcgis.carto.INetworkLayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isZoomToResultAfterSolve

boolean isZoomToResultAfterSolve()
                                 throws IOException,
                                        AutomationException

Indicates if the window should zoom the map to show results after solving.

Description

Indicates if the display will automatically zoom to the extent of the analysis results once the network analysis is complete. By deafult this property is false.

Product Availability

Available with ArcGIS Engine.

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZoomToResultAfterSolve

void setZoomToResultAfterSolve(boolean flag)
                               throws IOException,
                                      AutomationException

Indicates if the window should zoom the map to show results after solving.

Product Availability

Available with ArcGIS Engine.

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShowAnalysisMessagesAfterSolve

int getShowAnalysisMessagesAfterSolve()
                                      throws IOException,
                                             AutomationException

The types of messages that are displayed after solving.

Description

The type of messages displayed when a solve completes.

For example, esriEngineNAMessageTypeNone (0) means you do not want to see any messages after solve and esriEngineNAMessageTypeError + esriEngineNAMessageTypeWarning (6) means you just want to see errors and warnings.

Product Availability

Available with ArcGIS Engine.

Returns:

The messageTypes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowAnalysisMessagesAfterSolve

void setShowAnalysisMessagesAfterSolve(int messageTypes)
                                       throws IOException,
                                              AutomationException

The types of messages that are displayed after solving.

Product Availability

Available with ArcGIS Engine.

Parameters:

messageTypes - The messageTypes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.