com.esri.arcgis.networkanalyst
Interface INAServer

All Superinterfaces:

Serializable

All Known Subinterfaces:

INAServer2

All Known Implementing Classes:

NAServer, NAServerIP, NAServerLP

public interface INAServer
extends Serializable

Provides access to methods that perform network analysis in a stateless environment within a MapServer.

Remarks

INAServer has been superseded by INAServer2.

Product Availability

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

Method Summary

String[]	getNALayerNames(int layerType) Array of network analysis layers of a particular analysis type.
INAServerNetworkDescription	getNetworkDescription(String nALayerName) Description of the network dataset associated with the specified network analysis layer.
INAServerSolverParams	getSolverParameters(String nALayerName) Default solver parameters for the specified network analysis layer.
INAServerSolverResults	solve(INAServerSolverParams nAServerSolverParams) Perform network analysis based on the input solve parameters.

Method Detail

getNALayerNames

String[] getNALayerNames(int layerType)
                         throws IOException,
                                AutomationException

Array of network analysis layers of a particular analysis type.

Remarks

GetNALayerNames returns an array of names of NALayers of a given type. For example, you could use this method to find the names of all of the route analysis layers in the default map of the map server.

Product Availability

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

Parameters:

layerType - A com.esri.arcgis.networkanalyst.esriNAServerLayerType constant (in)

Returns:

The nALayerNames

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNetworkDescription

INAServerNetworkDescription getNetworkDescription(String nALayerName)
                                                  throws IOException,
                                                         AutomationException

Description of the network dataset associated with the specified network analysis layer.

Remarks

GetNetworkDescription returns an NAServerNetworkDescription object that allows you to retrieve things like the name of the network dataset as well as the sources and attributes within the network dataset.

Product Availability

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

Parameters:

nALayerName - The nALayerName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSolverParameters

INAServerSolverParams getSolverParameters(String nALayerName)
                                          throws IOException,
                                                 AutomationException

Default solver parameters for the specified network analysis layer.

Remarks

GetSolverParameters returns the NAServerSolverParams object (NAServerRouteParams, NAServerClosestFacilityParams, NAServerServiceAreaParams, NAServerLocationAllocationParams, NAServerODCostMatrixParams, NAServerVRPParams) corresponding to the NALayer name passed in. The parameter object returned will have defaults based on the NALayer it is referencing.

You can pass this resulting object into the Solve method on INAServer to perform network analysis.

Product Availability

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

Parameters:

nALayerName - The nALayerName (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

solve

INAServerSolverResults solve(INAServerSolverParams nAServerSolverParams)
                             throws IOException,
                                    AutomationException

Perform network analysis based on the input solve parameters.

Remarks

Solve performs network analysis based on the NAServerSolverParams object (NAServerRouteParams, NAServerClosestFacilityParams, NAServerServiceAreaParams) that was passed in and returns it's output through an NAServerSolverResults object (NAServerRouteResults, NAServerClosestFacilityResults, NAServerServiceAreaParams).

Product Availability

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

Parameters:

nAServerSolverParams - A reference to a com.esri.arcgis.networkanalyst.INAServerSolverParams (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.