rs2.interpreter.queryResults package

rs2.interpreter.queryResults.HistoryQueryResults module

class rs2.interpreter.queryResults.HistoryQueryResults.HistoryQueryResult(x_location, y_location, horizontal_axis_result, vertical_axis_result)

Bases: object

Examples

Code Snippet: Manipulation of History Query and its results

horizontal_axis_result

Horizontal Axis Result for history query point.

Type:

double

vertical_axis_result (double): Vertical Axis Result for history query point. location_x (double): X-Coordinate for history query point. location_y (double): Y-Coordinate for history query point.

GetXCoordinate()

Returns the X-Coordinate of the point

GetYCoordinate()

Returns the Y-Coordinate of the point

GetHorizontalAxisResult()

Returns the horizontal axis result for the specific stage

GetVerticalAxisResult()

Returns the vertical axis result for the specific stage

rs2.interpreter.queryResults.MaterialQueryResults module

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

Bases: object

Examples

Code Snippet: Manipulation of Material Queries

Attributes: 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.

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

Examples

Code Snippet: Manipulation of Material Queries

Attributes: 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.

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()

rs2.interpreter.queryResults.MeshResults module

class rs2.interpreter.queryResults.MeshResults.MeshResults(results)

Bases: object

Examples

Code Snippet: Get Model Mesh Results

Attributes: results (list[list[double]]): Mesh results containing x-coordinate, y-coordinate and result type value for each node in your model.

results = None
getXCoordinate(index)

Returns the X-Coordinate of the mesh node for specified index

getYCoordinate(index)

Returns the Y-Coordinate of the mesh node for specified index

getValue(index)

Returns the value of the mesh node based on model’s current result type and specified index

rs2.interpreter.queryResults.TimeQueryResults module

class rs2.interpreter.queryResults.TimeQueryResults.QueryPointResult(x_location, y_location, time, value)

Bases: object

Examples

Code Snippet: Manipulation of Time Query and its results

Attributes: x_location (double): X-Coordinate for time query point. y_location (double): Y-Coordinate for time query point. time (double): Dynamic stage time for time query point. value (double): Value for time query point.

GetXCoordinate() → float

Returns the X-Coordinate of the query point

GetYCoordinate() → float

Returns the Y-Coordinate of the query point

GetStageTime() → float

Returns the dynamic stage time of the query point

GetValue() → float

Returns the value of the time query point

class rs2.interpreter.queryResults.TimeQueryResults.QueryLineResult(list_node_values)

Bases: object

Examples

Code Snippet: Manipulation of Time Query and its results

Attributes: query_values (list[QueryPointResult]): List of QueryPointResult objects making up the result for the time query line.

GetNodeValues() → list[QueryPointResult]
Returns a list[QueryPointResult] representing result at this node part of the time query line
To get the x-coordinate, y-coordinate, dynamic stage time, or value, please call the supporting class methods:

  • QueryPointResult.GetXCoordinate()

  • QueryPointResult.GetYCoordinate()

  • QueryPointResult.GetStageTime()

  • QueryPointResult.GetValue()

class rs2.interpreter.queryResults.TimeQueryResults.TimeQueryPointResults(entity_ID, query_point_values)

Bases: object

Examples

Code Snippet: Manipulation of Time Query and its results

Attributes: entity_ID (str): Unique Identifier for time query point. query_values (list[QueryPointResult]): List of QueryPointResult object for time query point.

GetUniqueIdentifier() → int

Returns the unique identifier for the time query point

GetAllValues() → list[QueryPointResult]
Returns a list[QueryPointResult] representing result at all nodes of the time query point
To get the x-coordinate, y-coordinate, dynamic stage time, or value, please call the supporting class methods:

  • QueryPointResult.GetXCoordinate()

  • QueryPointResult.GetYCoordinate()

  • QueryPointResult.GetStageTime()

  • QueryPointResult.GetValue()

class rs2.interpreter.queryResults.TimeQueryResults.TimeQueryLineResults(entity_ID, list_query_line_data)

Bases: object

Examples

Code Snippet: Manipulation of Time Query and its results

Attributes: entity_ID (str): Unique Identifier for time query line. line_data (list[QueryLineResult]): List of QueryLineResult object for time query line.

GetUniqueIdentifier() → int

Returns the unique identifier for the time query point

GetAllNodeObjects() → list[QueryLineResult]

Returns a list[QueryLineResult] representing nodes making up the time query line

To get list of node values associated with a specific node, please call the supported class method:

  • QueryLineResult.GetNodeValues()

The above returns a list[QueryPointResult] representing result at this node part of the time query line
To get the x-coordinate, y-coordinate, dynamic stage time, or value, please call the supporting class methods:

  • QueryPointResult.GetXCoordinate()

  • QueryPointResult.GetYCoordinate()

  • QueryPointResult.GetStageTime()

  • QueryPointResult.GetValue()