com.esri.arcgis.networkanalyst
Interface INAServer2

All Superinterfaces:

INAServer, Serializable

All Known Implementing Classes:

NAServer, NAServerIP, NAServerLP

public interface INAServer2
extends INAServer, Serializable

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

Remarks

INAServer2 is the main interface on the NAServer object. It provides methods to perform network analysis in a stateless manner on a server.

INAServer2 provides method which returns default analysis settings and optionally content of NAClasses present in the analysis layer be default or loaded from a layer stored on server.

Product Availability

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

Method Summary

INAServerSolverParams

getSolverParameters2(String nALayerName, String layerToken, boolean populateNAClasses) Default solver parameters for the specified network analysis layer.

Methods inherited from interface com.esri.arcgis.networkanalyst.INAServer

getNALayerNames, getNetworkDescription, getSolverParameters, solve

Method Detail

getSolverParameters2

INAServerSolverParams getSolverParameters2(String nALayerName,
                                           String layerToken,
                                           boolean populateNAClasses)
                                           throws IOException,
                                                  AutomationException

Default solver parameters for the specified network analysis layer.

Remarks

GetSolverParameters2 returns the NAServerSolverParams object (NAServerRouteParams, NAServerClosestFacilityParams, NAServerServiceAreaParams, NAServerLocationAllocationParams, NAServerODCostMatrixParams, NAServerVRPParams) corresponding to the NALayerName and LayerToken passed in. if PopulateNAClasses was set to True, returned NAServerSolverParams instance will contain correspondent recordsets populated with content of NAClasses.

As opposed to GetSolverParameters, NAServerSolverParams instance returned by GetSolverParameters2 does not contain MapDescription and ImageDescription populated, which significantly reduces response size.

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

LayerToken can be obtained from NAServerSolverResults object if the instance of NAServerSolverParams previously passed to the Solve method had SaveLayerOnServer set to True.

This method can be useful when, for example, multiple clients are working with a shared network analysis layer stored on server, or shared layer originally was created and saved on server by another client process.

Product Availability

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

Parameters:

nALayerName - The nALayerName (in)

layerToken - The layerToken (in)

populateNAClasses - The populateNAClasses (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.