ArcGIS API for WPF - Library Reference
RouteParameters Class Members
See Also  Properties  Send comments on this topic
ESRI.ArcGIS.Client.Tasks Namespace : RouteParameters Class


The following tables list the members exposed by RouteParameters.

Public Constructors

 NameDescription
public ConstructorRouteParameters ConstructorInitializes a new instance of the RouteParameters class.  
Top

Public Properties

 NameDescription
public PropertyAccumulateAttributes The list of network attribute names to be accumulated with the analysis, i.e. which attributes should be returned as part of the response. The default is as defined in the specific routing network layer used in your RouteTask. You can specify any attributes names listed in the Service Directory under "Network Dataset -> Network Attributes" as "Usage Type: esriNAUTCost". (Inherited from ESRI.ArcGIS.Client.Tasks.BaseRouteParameters)
public PropertyAttributeParameterValues A set of attribute parameter values that can be parameterized to determine which network elements can be used by a vehicle. (Inherited from ESRI.ArcGIS.Client.Tasks.BaseRouteParameters)
public PropertyBarriers The set of barriers loaded as network locations during analysis. (Inherited from ESRI.ArcGIS.Client.Tasks.BaseRouteParameters)
public PropertyDirectionsLanguage The language to be used when computing directions. The default is as defined in the specific routing network layer used in your RouteTask. By default, NAServer gets installed with en_US only - it is up to the server administrator to add additional languages.  
public PropertyDirectionsLengthUnitsThe length units to use when computing directions. The default is as defined in the specific routing network layer used in your RouteTask. Possible values are "esriFeet", "esriKilometers", "esriMeters", "esriMiles", "esriNauticalMiles" and "esriYards".  
public PropertyDirectionsTimeAttribute The name of network attribute to use for the drive time when computing directions. The default is as defined in the specific routing network layer used in your RouteTask.  
public PropertyDoNotLocateOnRestrictedElements If true, avoid network elements restricted by barriers or due to restrictions specified in restrictionAttributes.  
public PropertyFindBestSequence If true, the solver will optimize the order of the stops in the route (while taking into account preserveFirstStop and preserveLastStop if they were set to true).  
public PropertyIgnoreInvalidLocations When false, the solve operation will fail if at least one of the stops specified cannot be located or reached.  
public PropertyImpedanceAttribute The network attribute name to be used as the impedance attribute in analysis. (Inherited from ESRI.ArcGIS.Client.Tasks.BaseRouteParameters)
public PropertyOutputGeometryPrecision The precision of the output geometry after generalization. If 0, no generalization of output geometry is performed. If present and positive, it represents the MaximumAllowableOffset parameter - generalization is performed according to IPolycurve.Generalize. (Inherited from ESRI.ArcGIS.Client.Tasks.BaseRouteParameters)
public PropertyOutputGeometryPrecisionUnits The units of the output geometry precision. (Inherited from ESRI.ArcGIS.Client.Tasks.BaseRouteParameters)
public PropertyOutputLinesThe type of output lines to be generated in the result. The default is as defined in the specific routing network layer used in your RouteTask. Possible values are "esriNAOutputLineNone" (no line at all), "esriNAOutputLineStraight" (a straight line from start to end) and "esriNAOutputLineTrueShape" (Inherited from ESRI.ArcGIS.Client.Tasks.BaseRouteParameters)
public PropertyOutSpatialReferenceThe well-known ID of the spatial reference for the geometries returned with the analysis results. If outSR is not specified, the geometries are returned in the spatial reference of the routing network layer used in your RouteTask. (Inherited from ESRI.ArcGIS.Client.Tasks.BaseRouteParameters)
public PropertyPolygonBarriers The set of polygon barriers loaded as network locations during analysis. (Inherited from ESRI.ArcGIS.Client.Tasks.BaseRouteParameters)
public PropertyPolylineBarriers The set of polyline barriers loaded as network locations during analysis. (Inherited from ESRI.ArcGIS.Client.Tasks.BaseRouteParameters)
public PropertyPreserveFirstStopIf true, the solver should keep the first stop fixed in the sequence (even when findBestSequence is true). Only applicable if findBestSequence is true. The default is as defined in the specific routing network layer used in your RouteTask.  
public PropertyPreserveLastStop If true, the solver should keep the last stop fixed in the sequence (even when findBestSequence is true). Only applicable if findBestSequence is true. The default is as defined in the specific routing network layer used in your RouteTask.  
public PropertyRestrictionAttributes The list of network attribute names to be used as restrictions with the analysis. The default is as defined in the specific routing network layer used in your RouteTask. Possible values are listed in the Service Directory under "Network Dataset -> Network Attributes". You can also specify a value of "none" to indicate that no network attributes should be used as restrictions. If you specify an empty array, it will default to the default of the service. (Inherited from ESRI.ArcGIS.Client.Tasks.BaseRouteParameters)
public PropertyRestrictUTurns Specifies how U-Turns should be handled. The default is as defined in the specific routing network layer used in your RouteTask. Possible values are "esriNFSBAllowBacktrack", "esriNFSBAtDeadEndsOnly" and "esriNFSBNoBacktrack". (Inherited from ESRI.ArcGIS.Client.Tasks.BaseRouteParameters)
public PropertyReturnBarriers If true, barriers will be returned in the barriers property of RouteSolveResult. (Inherited from ESRI.ArcGIS.Client.Tasks.BaseRouteParameters)
public PropertyReturnDirectionsIf true, directions will be generated and returned in the directions property of each RouteResult of the RouteEventArgs.  
public PropertyReturnPolygonBarriers If true, polyline barriers will be returned in the polylineBarriers of the RouteSolveResult. (Inherited from ESRI.ArcGIS.Client.Tasks.BaseRouteParameters)
public PropertyReturnPolylineBarriers If true, polygon barriers will be returned in the polygonBarriers of the RouteSolveResult. (Inherited from ESRI.ArcGIS.Client.Tasks.BaseRouteParameters)
public PropertyReturnRoutesIf true, routes will be generated and returned in the route property of each RouteResult of the RouteEventArgs.  
public PropertyReturnStopsIf true, stops will be returned in the stops property of RouteSolveResult.  
public PropertyStartTime The time the route begins. If not specified, the solver will not start the route at a particular time.  
public PropertyStops The set of stops loaded as network locations during analysis. Can be either an instance of DataLayer or FeatureSet.  
public PropertyUseHierarchy If true, the hierarchy attribute for the network should be used in analysis. The default is as defined in the specific routing network layer used in your RouteTask.  
public PropertyUseTimeWindowsIf true, the solver should consider time windows. The default is as defined in the specific routing network layer used in your RouteTask.  
Top

See Also

© ESRI, Inc. All Rights Reserved.