NAServerSolverParams

Derived Types: NAServerClosestFacilityParams, NAServerRouteParams, NAServerServiceAreaParams, NAServerLocationAllocationParams, NAServerODCostMatrixParams, NAServerVRPParams

An abstract class that describes the base properties on network analysis layers and is used to set the input properties that are used by the Solve method to perform network analysis.

Property

Type

Description

AccumulateAttributeNames

string[]

The names of the cost network attributes to accumulate during analysis.

AttributeParameterValues

NAAttributeParameterValue[]

The network attribute parameter values to override on the network dataset during analysis.

HierarchyAttributeName

string

The name of the hierarchy network attribute to use when performing hierarchical network analysis.

HierarchyLevelCount

int

The number of levels in the hierarchy attribute. The current limit is 3.

HierarchyMaxValues

int[]

The maximum hierarchy value for each hierarchy level.

HierarchyNumTransitions

int[]

The number of lower level junctions to explore before searching the next hierarchy level.

IgnoreInvalidLocations

bool

Indicates if the network analysis should continue solving the problem even if some network locations are invalid due to not being properly located.

ImageDescription

ImageDescription

The ImageDescription object to use when drawing the map with the analysis results if ReturnMap is set to true.

ImpedanceAttributeName

string

The name of the cost network attribute you wish to minimize during analysis.

LayerToken

string

The 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 = true.

MapDescription

MapDescription

The MapDescription object to use when drawing the map with the analysis results if ReturnMap is set to true.

MaxSnapTolerance

double

The maximum search tolerance used when attempting to load network locations.

NAClassCandidateFieldMaps

NAClassCandidateFieldMap[]

The candidate field maps to associate input NAServerLocation fields/properties to NAClass fields when loading network locations.

NALayerName

string

The name of the associated network analysis layer.

OutputGeometryPrecision

object

The precision of the output geometry after generalization. Algorithm involving Douglas-Poiker generalization is used.

OutputGeometryPrecisionUnits

esriUnits

The length units that the OutputGeometryPrecision are in. If unknown, the units are assumed to be the same as the spatial reference of the geometries.

OutputGeometryPrecisionUnitsSpecified

bool

Indicates if OutputGeometryPrecisionUnits is specified.

OutputSpatialReference

SpatialReference

The spatial reference of the geometries returned with the analysis results.

ResetHierarchyRangesOnBind

bool

Indicates if the hierarchy ranges will be reset to the network dataset's hierarchy settings during initialization.

RestrictionAttributeNames

string[]

The names of the restriction network attributes to use during analysis.

RestrictUTurns

esriNetworkForwardStarBacktrack

Indicates how U-turns should be restricted during analysis.

ReturnGeometriesAsBinary

bool

Indicates if the geometries returned by solve are xxxN or xxxB geometries.

ReturnMap

bool

Indicates if a MapImage should be generated and returned with the analysis results.

ReturnPartialResultsOnError

bool

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

ReturnPartialResultsOnErrorSpecified

bool

Indicates if ReturnPartialResultsOnError is specified.

SaveLayerOnServer

bool

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.

SaveLayerOnServerSpecified

bool

Indicates if SaveLayerOnServer is specified.

SnapTolerance

double

The minimum search tolerance used when finding network locations.

SnapToleranceUnits

esriUnits

The units of the search tolerance in esriUnits type.

UseHierarchy

bool

Indicates if hierarchical network analysis should be performed if the network has a hierarchy defined.

Examples

C#

//Example showing setting the image description so the output map would be 200x200 pixels:

routeParams.ImageDescription.Display.Width = 200;

routeParams.ImageDescription.Display.Height = 200;

10/23/2013