OriginDestinationCostMatrixResult

Resumen

An object containing the results of an origin destination cost matrix analysis that can be used to access outputs and solver messages.

Debate

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

Propiedades

PropiedadExplicaciónTipo de datos
isPartialSolution
(Sólo lectura)

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
(Sólo lectura)

Returns True if the solve was successful.

Boolean

Descripción general del método

MétodoExplicación
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.

Métodos

count (output_type)
ParámetroExplicaciónTipo de datos
output_type

The type of output features to count.

The parameter should be set using the OriginDestinationCostMatrixOutputDataType enumeration.

Object
Valor de retorno
Tipo de datosExplicación
Integer

The number of rows.

Raises no exception.

export (output_type, output_features)
ParámetroExplicaciónTipo de datos
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)
ParámetroExplicaciónTipo de datos
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
Valor de retorno
Tipo de datosExplicación
String

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

saveAsLayerFile (file_name)
ParámetroExplicaciónTipo de datos
file_name

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

String
searchCursor (output_type, field_names, {where_clause})
ParámetroExplicaciónTipo de datos
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@XYUna tupla de las coordenadas x,y del centroide de la entidad.
  • SHAPE@XYZUna tupla de las coordenadas x, y, z del centroide de la entidad. Este token solo se admite cuando la geometría está habilitada para z.
  • SHAPE@JSON La cadena de caracteres JSON de Esri que representa la geometría.
  • SHAPE@WKBRepresentación binaria conocida (WKB) para geometría OGC. Ofrece una representación portátil de un valor de geometría como una transmisión contigua de bytes.
  • SHAPE@WKTRepresentación en texto conocida (WKB) para geometría OGC. Ofrece una representación portátil de un valor de geometría como cadena de caracteres.
  • SHAPE@Objeto de geometría para la entidad.

The SHAPE@XY and SHAPE@XYZ tokens are only supported for point-based output types.

String
where_clause

Una expresión opcional que limita los registros que se devuelven. Para obtener más información sobre las cláusulas WHERE y sentencias SQL, consulte Referencia SQL para los elementos utilizados en las expresiones de consulta.

(El valor predeterminado es None)

String
Valor de retorno
Tipo de datosExplicación
Object

A SolverResultSearchCursor object that reads rows from the output.

solverMessages (severity)
ParámetroExplicaciónTipo de datos
severity

The type of messages to be returned.

The parameter should be specified using the MessageSeverity enumeration.

Object
Valor de retorno
Tipo de datosExplicación
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".']]