OriginDestinationCostMatrixResult

Summary

An object containing the results of an origin destination cost matrix 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 OriginDestinationCostMatrix class.

Properties

Property	Explanation	Data 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

Method Overview

Method	Explanation
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.
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. The layer file can be opened in ArcGIS Desktop or ArcGIS Pro as a record of the analysis settings or to visualize the results. The method returns a RuntimeError exception if the allowSaveLayerFile property on the solver object is set to False.
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)

Parameter	Explanation	Data Type
output_type	The type of output features to count. The parameter should be set using the OriginDestinationCostMatrixOutputDataType enumeration.	Object

Return Value

Data Type	Explanation
Integer	The number of rows.

Raises no exception.

export (output_type, output_features)

Parameter	Explanation	Data Type
output_type	The type of output to export. The parameter should be set using the OriginDestinationCostMatrixOutputDataType enumeration.	Object
output_features	The catalog path to the output feature class or table that will contain the exported features.	String

fieldNames (output_type)

Parameter	Explanation	Data Type
output_type	The type of output for which to return a list of field names. The parameter should be set using the OriginDestinationCostMatrixOutputDataType enumeration.	Object

Return Value

Data Type	Explanation
String	A list of field names supported by the specified output type.

saveAsLayerFile (file_name)

Parameter	Explanation	Data Type
file_name	The catalog path of the output layer file (.lyr) to write.	String

searchCursor (output_type, field_names, {where_clause})

Parameter	Explanation	Data Type
output_type	The type of output to read. The parameter should be set using the OriginDestinationCostMatrixOutputDataType 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. In addition to regular fields, you can also access the geometry of the output using one of the following geometry tokens: SHAPE@XY —A tuple of the feature's centroid x,y coordinates. SHAPE@XYZ —A tuple of the feature's centroid x,y,z coordinates. This token is only supported when the geometry is z-enabled. SHAPE@JSON — The Esri JSON string representing the geometry. SHAPE@WKB —The well-known binary (WKB) representation for OGC geometry. It provides a portable representation of a geometry value as a contiguous stream of bytes. SHAPE@WKT —The 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.	String
where_clause	An optional expression that limits the records returned. For more information on WHERE clauses and SQL statements, see SQL reference for elements used in query expressions. (The default value is None)	String

Return Value

Data Type	Explanation
Object	A SolverResultSearchCursor object that reads rows from the output.

solverMessages (severity)

Parameter	Explanation	Data Type
severity	The type of messages to be returned. The parameter should be specified using the MessageSeverity enumeration.	Object

Return Value

Data Type

Explanation

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".']]