LocationAllocationResult

Summary

An object containing the results of a location-allocation analysis that can be used to access outputs and solver messages.

Discussion

Instances of this class cannot be created directly. Instead, they are returned by the solve method of the LocationAllocation class.

Properties

PropertyExplanationData Type
isPartialSolution
(Read Only)

Returns True if the solver produced a partial solution, meaning that not all inputs were included in the results. This can occur if one of the inputs is unlocated and the solver class's ignoreInvalidLocations property is set to True.

Boolean
solveSucceeded
(Read Only)

Returns True if the solve was successful.

Boolean
spatialReference
(Read Only)

Returns the spatial reference of the output features. For example, feature classes created using the export method and geometry objects retrieved from the searchCursor method will have this spatial reference. The spatialReference value is typically the spatial reference of the network dataset or service used in the analysis.

SpatialReference

Method Overview

MethodExplanation
count (output_type)

Returns the number of rows for an output type.

export (output_type, output_features)

The output features will be created in the spatial reference of the network dataset used for the analysis. If the arcpy.env.outputCoordinateSystem environment is set, the output features will be created with the specified coordinate system instead.

Exports the analysis results to a feature class or table.

extent ({output_type})

Returns the extent of the analysis output.

The method returns a RuntimeError exception if the analysis solve failed.

fieldNames (output_type)

Returns a list of field names supported by a specified output type.

saveAsLayerFile (file_name)

Save the analysis result and settings to a layer file or layer package. The layer file or package can be opened in ArcGIS Pro as a record of the analysis settings or to visualize the results. A layer file can also be opened in ArcGIS Desktop.

The method returns a RuntimeError exception if the allowSaveLayerFile property on the solver object is set to False.

Legacy:

Routing services based on portals running versions of ArcGIS Enterprise older than 10.9 do not support saving layer packages. The method returns a RuntimeError exception if this is the case.

searchCursor (output_type, field_names, {where_clause})

Establishes a search cursor on the specified output type. This cursor can be used to read rows directly from the output.

solverMessages (severity)

Get error, warning, and informational messages returned by the solver.

Methods

count (output_type)
ParameterExplanationData Type
output_type

The type of output features to count.

The parameter should be set using the LocationAllocationOutputDataType enumeration.

Object
Return Value
Data TypeExplanation
Integer

The number of rows.

Raises no exception.

export (output_type, output_features)
ParameterExplanationData Type
output_type

The type of output to export.

The parameter should be set using the LocationAllocationOutputDataType enumeration.

See descriptions of the fields included in each output type

Object
output_features

The catalog path to the output feature class or table that will contain the exported features.

String
extent ({output_type})
ParameterExplanationData Type
output_type

The type of output features for which to get the extent.

The parameter should be set using the LocationAllocationOutputDataType enumeration.

If you do not specify a value, or you specify a value of None, the extent for the combined analysis outputs is returned.

Object
Return Value
Data TypeExplanation
Extent

An arcpy.Extent object indicating the extent of the designated output type.

fieldNames (output_type)
ParameterExplanationData Type
output_type

The type of output for which to return a list of field names.

The parameter should be set using the LocationAllocationOutputDataType enumeration.

See descriptions of the fields included in each output type

Object
Return Value
Data TypeExplanation
String

A list of field names supported by the specified output type.

saveAsLayerFile (file_name)
ParameterExplanationData Type
file_name

The catalog path of the output layer file (.lyr) or layer package (.lpkx) to write.

String
searchCursor (output_type, field_names, {where_clause})
ParameterExplanationData Type
output_type

The type of output to read.

The parameter should be set using the LocationAllocationOutputDataType enumeration.

Object
field_names
[field_names,...]

A list of field names of the output type whose values the cursor will return. You can get the names of the fields that are supported by an output type using the fieldNames method.

See descriptions of the fields included in each output type

In addition to regular fields, you can also access the geometry of the output using one of the following geometry tokens:

  • SHAPE@XYA tuple of the feature's centroid's X and Y coordinates.
  • SHAPE@XYZA tuple of the feature's centroid's X, Y, and Z coordinates.
  • SHAPE@JSON The Esri JSON string representing the geometry.
  • SHAPE@WKBThe well-known binary (WKB) representation for OGC geometry. It provides a portable representation of a geometry value as a contiguous stream of bytes.
  • SHAPE@WKTThe well-known text (WKT) representation for OGC geometry. It provides a portable representation of a geometry value as a text string.
  • SHAPE@A geometry object for the feature.

The SHAPE@XY and SHAPE@XYZ tokens are only supported for point-based output types. The x-, y-, and z-values returned when using the SHAPE@XY and SHAPE@XYZ tokens are in the spatial reference reported by the solver result object's spatialReference property, and this is typically the same as the spatial reference of the network data source used for the analysis.

String
where_clause

An optional expression that limits the records returned. For more information on where clauses and SQL statements, see SQL reference for query expressions used in ArcGIS.

(The default value is None)

String
Return Value
Data TypeExplanation
Object

A SolverResultSearchCursor object that reads rows from the output.

solverMessages (severity)
ParameterExplanationData Type
severity

The type of messages to be returned.

The parameter should be specified using the MessageSeverity enumeration.

Object
Return Value
Data TypeExplanation
List

The messages are returned as a list of lists. The inner list contains two values; the first is a number representing the message code, and the second value is the message text.

An example of a list of messages returned from a failed origin destination cost matrix analysis.

[[-2147200995, '0 location(s) in "Destinations" are valid.  Need at least 1 valid location(s).'],
 [30024, 'Solve returned a failure.'],
 [-2147200995, 'Insufficient number of valid locations in "Origins" or "Destinations".']]