rs2.interpreter.queryResults.MaterialQueryResults module

class rs2.interpreter.queryResults.MaterialQueryResults.QueryResult(x_location, y_location, distance, value)

Bases: object

Variables:

• x_location (double) – X-Coordinate for material query point.

• y_location (double) – Y-Coordinate for material query point.

• distance (double) – Distance for material query point.

• value (double) – Result type value for material query point.

Examples

Code Snippet: Manipulation of Material Queries

GetXCoordinate() → float

Returns the X-Coordinate of the query

GetYCoordinate() → float

Returns the Y-Coordinate of the query

GetDistance() → float

Returns the distance of the query

GetValue() → float

Returns the value of the query based on model’s current result type

class rs2.interpreter.queryResults.MaterialQueryResults.MaterialQueryResults(entity_ID, material_id, query_values)

Bases: object

Variables:

• entity_ID (str) – Unique Identifier for material query.

• material_id (int) – Material Identifier for material query.

• query_values (list[QueryResult]) – List of QueryResult point objects making up the material query.

Examples

Code Snippet: Manipulation of Material Queries

GetUniqueIdentifier() → int

Returns the unique identifier for the material query

GetMaterialID() → int

Returns the material ID of the query

GetAllValues() → list[QueryResult]

Returns a list[QueryResult] representing result at all nodes of the material query

To get the x-coordinate, y-coordinate, distance, or value, please call the supporting class methods:

• QueryResult.GetXCoordinate()

• QueryResult.GetYCoordinate()

• QueryResult.GetDistance()

• QueryResult.GetValue()