com.esri.arcgis.networkanalyst
Interface INAServerSolverParams2

All Superinterfaces:

INAServerSolverParams, Serializable

All Known Implementing Classes:

NAServerClosestFacilityParams, NAServerLocationAllocationParams, NAServerODCostMatrixParams, NAServerRouteParams, NAServerServiceAreaParams, NAServerVRPParams

public interface INAServerSolverParams2
extends INAServerSolverParams, Serializable

Provides access to properties that specify the solver settings and return parameters used during network analysis with NAServer.

Remarks

INAServerSolverParams2 provides methods to set input parameters on an NAServerSolverParams object (NAServerRouteParams, NAServerClosestFacilityParams, NAServerServiceAreaParams, NAServerLocationAllocationParams, NAServerODCostMatrixParams, NAServerVRPParams) that is then used by the Solve method on INAServer.

There are methods to set the snapping environment for loading network locations. There are also methods to specify if a map is returned by the solve and how that map should be generated.

There are also methods to control reuse of analysis layers stored on the server, and methods which allow to specify whether partial results will be returned even if Solve fails.

Product Availability

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

Method Summary

String	getLayerToken() Token identifying the network analysis layer on the server to use.
boolean	isReturnPartialResultsOnError() Indicates if the result object should be returned even if an error was generated during the solve operation.
boolean	isSaveLayerOnServer() Indicates if the resulting analysis layer should be saved on the server.
void	setLayerToken(String layerToken) Token identifying the network analysis layer on the server to use.
void	setReturnPartialResultsOnError(boolean returnPartialResultsOnError) Indicates if the result object should be returned even if an error was generated during the solve operation.
void	setSaveLayerOnServer(boolean saveLayerOnServer) Indicates if the resulting analysis layer should be saved on the server.

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

getImageDescription, getMapDescription, getMaxSnapTolerance, getNAClassCandidateFieldMaps, getNALayerName, getOutputSpatialReference, getSnapTolerance, getSnapToleranceUnits, isReturnMap, setImageDescriptionByRef, setMapDescriptionByRef, setMaxSnapTolerance, setNAClassCandidateFieldMaps, setNALayerName, setOutputSpatialReferenceByRef, setReturnMap, setSnapTolerance, setSnapToleranceUnits

Method Detail

setReturnPartialResultsOnError

void setReturnPartialResultsOnError(boolean returnPartialResultsOnError)
                                    throws IOException,
                                           AutomationException

Indicates if the result object should be returned even if an error was generated during the solve operation.

Remarks

ReturnPartialResultsOnError: in cases when Solve fails, it allows to get available results objects back. For example, if less than two Stops were located, Route Solve operation can still return NAServerRouteResults object with Stops recordset populated.

Product Availability

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

Parameters:

returnPartialResultsOnError - The returnPartialResultsOnError (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnPartialResultsOnError

boolean isReturnPartialResultsOnError()
                                      throws IOException,
                                             AutomationException

Indicates if the result object should be returned even if an error was generated during the solve operation.

Product Availability

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

Returns:

The returnPartialResultsOnError

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSaveLayerOnServer

void setSaveLayerOnServer(boolean saveLayerOnServer)
                          throws IOException,
                                 AutomationException

Indicates if the resulting analysis layer should be saved on the server.

Remarks

SaveLayerOnServer indicates if the network analysis layer should be saved on server for future reuse. If True, the NAServerSolverResults.LayerToken property will contain token assigned to the saved layer on server. In order to reuse this layer, set returned token value on NAServerSolverParams.LayerToken in subsequent requests.

Product Availability

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

Parameters:

saveLayerOnServer - The saveLayerOnServer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSaveLayerOnServer

boolean isSaveLayerOnServer()
                            throws IOException,
                                   AutomationException

Indicates if the resulting analysis layer should be saved on the server.

Product Availability

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

Returns:

The saveLayerOnServer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerToken

void setLayerToken(String layerToken)
                   throws IOException,
                          AutomationException

Token identifying the network analysis layer on the server to use.

Remarks

LayerToken contains token corresponding to an existing network analysis layer saved on the server to use during Solve rather than the default network analysis layer. The token value to use can be retrieved from NAServerSolverResults.LayerToken that was returned from a previous call to Solve with NAServerSolverParams.SaveLayerOnServer set to True.

Product Availability

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

Parameters:

layerToken - The layerToken (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLayerToken

String getLayerToken()
                     throws IOException,
                            AutomationException

Token identifying the network analysis layer on the server to use.

Product Availability

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

Returns:

The layerToken

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.