Display Name: Solve

Description: Solves the network analysis layer problem based on its network locations and properties.

Category:

Help URL: https://mapservices.sccgov.org/arcgis/rest/directories/arcgisoutput/test/NetworkAnalysis_GPServer/test_NetworkAnalysis/Solve.htm

Execution Type: esriExecutionTypeAsynchronous

Parameters:

Parameter: in_network_analysis_layer

Data Type: GPString
Display Name Input Network Analysis Layer
Description: The network analysis layer on which the analysis will be computed.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Route
Parameter Type: esriGPParameterTypeRequired
Category:
Choice List: [ Service Area, Route ]

Parameter: ignore_invalids

Data Type: GPBoolean
Display Name Ignore Invalid Locations
Description: Specifies whether invalid input locations will be ignored. Typically, locations are invalid if they cannot be located on the network. When invalid locations are ignored, the solver will skip them and attempt to perform the analysis using the remaining locations.Checked—Invalid input locations will be ignored and only valid locations will be used.Unchecked—All input locations will be used. Any invalid locations will cause the solve to fail.The default value will match the Ignore Invalid Locations at Solve Time setting on the designated Input Network Analysis Layer value.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: true
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: terminate_on_solve_error

Data Type: GPBoolean
Display Name Terminate on Solve Error
Description: Specifies whether tool execution will terminate if an error is encountered during the solve.Checked—The tool will fail to execute when the solver encounters an error. This is the default.Unchecked—The tool will not fail and will continue execution even when the solver encounters an error. All error messages returned by the solver will be converted to warning messages. Use this option when background processing is enabled in your application.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: true
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: simplification_tolerance

Data Type: GPLinearUnit
Display Name Simplification Tolerance
Description: The tolerance that determines the degree of simplification for the output geometry. If a tolerance is specified, it must be greater than zero. You can choose a preferred unit; the default unit is decimal degrees.Specifying a simplification tolerance tends to reduce the time it takes to render routes or service areas. The drawback, however, is that simplifying geometry removes vertices, which may lessen the spatial accuracy of the output at larger scales.Because a line with only two vertices cannot be simplified any further, this parameter has no effect on drawing times for single-segment output, such as straight-line routes, OD cost matrix lines, and location-allocation lines.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: output_layer

Data Type: GPString
Display Name Network Analyst Layer
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:


Parameter: solve_succeeded

Data Type: GPBoolean
Display Name Solve Succeeded
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:


Parameter: overrides

Data Type: GPString
Display Name Overrides
Description: Additional settings that can influence the behavior of the solver when finding solutions for the network analysis problems.The value for this parameter must be specified in JavaScript Object Notation (JSON). For example, a valid value is of the following form {"overrideSetting1" : "value1", "overrideSetting2" : "value2"}. The override setting name is always enclosed in double quotation marks. The values can be a number, a Boolean, or a string.The default value for this parameter is no value, which indicates solver settings will not be overridden.Overrides are advanced settings that should be used only after careful analysis of the results obtained before and after applying the settings. A list of supported override settings for each solver and their acceptable values can be obtained by contacting Esri Technical Support.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:

Supported Operations:   Submit Job

Child Resources:   Metadata