NAServerRouteParams

Base Type: NAServerSolverParams

A class that describes the default properties on a route network analysis layer and is used to set the input properties that are used by the Solve method to perform network analysis.

Property	Type	Description
Barriers	NAServerLocations	The input locations to load as point barriers to restrict traversability during analysis.
CreateTraversalResult	bool	Specifies if the analysis will internally create a traversal result. If the output lines are none or straight and directions aren't returned, this can be set to false for better performance.
DirectionsLanguage	string	The language used when generating directions. This string must match a language listed in the directions.lng file on the server.
DirectionsLengthUnits	esriNetworkAttributeUnits	The length units used when generating directions.
DirectionsOutputType	esriDirectionsOutputType	Defines the type of content of directions.
DirectionsOutputTypeSpecified	bool	Indicates if DirectionsOutputType is specified.
DirectionsStyleName	string	The name of the formatting style of directions. For the list of supported styles see NAServer.GetNetworkDescription() and NAServerNetworkDirections.
DirectionsTimeAttributeName	string	The name of the time network attribute to use when generating directions.
FindBestSequence	bool	Indicates if the route analysis should re-sequence the stops to minimize total cost to travel through all the stops. Use PreserveFirstStop and PreserveLastStop to constrain the analysis from changing the first and last stop.
OutputLines	esriNAOutputLineType	The type of lines to compute for the output routes. Options include true shapes, true shapes with measures, straight lines, or no lines. If you are not returning routes, set this to none for better performance.
PolygonBarriers	NAServerLocations	The input locations to load as polygon barriers to restrict traversability or scale cost during analysis.
PolylineBarriers	NAServerLocations	The input locations to load as line barriers to restrict traversability or scale cost during analysis.
PreserveFirstStop	bool	Indicates if the first stop can be changed if FindBestSequence is true.
PreserveLastStop	bool	Indicates if the last stop can be changed if FindBestSequence is true.
ReturnBarriers	bool	Indicates if the point barriers used during analysis should be returned.
ReturnCompactDirections	bool	Indicates if compact driving directions should be returned.
ReturnDirections	bool	Indicates if driving directions should be returned.
ReturnPolygonBarriers	bool	Indicates if the polygon barriers used during analysis should be returned.
ReturnPolygonBarriersSpecified	bool	Indicates if ReturnPolygonBarriers is specified.
ReturnPolylineBarriers	bool	Indicates if the polyline barriers used during analysis should be returned.
ReturnPolylineBarriersSpecified	bool	Indicates if ReturnPolylineBarriers is specified.
ReturnRouteGeometries	bool	Indicates if the route geometries should be returned in an array of Polyline.
ReturnRoutes	bool	Indicates if the route features should be returned as a RecordSet.
ReturnStops	bool	Indicates if the stop features should be returned as a RecordSet.
StartTime	DateTime	The time the route begins. This is used in conjunction with time windows, during time-dependent network analysis, and when generating driving directions.
Stops	NAServerLocations	The input locations to load as Stops locations during analysis.
UseStartTime	bool	Indicates if the start time should be used during network analysis. This should be true if using time windows or performing time-dependent network analysis.
UseTimeWindows	bool	Indicates that the analysis should use time window information defined on each stop.

Remarks

Do not set both ReturnRouteGeometries and ReturnRoutes to true. If just the geometry is needed, just set ReturnRouteGeometries to true. If the geometry and the other fields on the Routes RecordSet are needed, just set ReturnRoutes to true since the geometries in the shape field of Routes are the same geometries that are returned in ReturnRouteGeometries.

Do not set both ReturnDirections and ReturnCompactDirections to true. They each return directions in slightly different formats but contain similar information. Either direction format can be used independently and it is bad practice to return both formats. The time to compute each type of directions is considerable and should not be done unless necessary.