rs2.interpreter.queryResults.TimeQueryResults module

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

Bases: object

Returns query point result.

Variables:

• 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.

Examples

Code Snippet: Manipulation of Time Query and its results

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

Variables:

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

Examples

Code Snippet: Manipulation of Time Query and its results

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

Variables:

• entity_ID (str) – Unique Identifier for time query point.

• query_values (list[QueryPointResult]) – List of QueryPointResult object for time query point.

Examples

Code Snippet: Manipulation of Time Query and its results

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

Variables:

• entity_ID (str) – Unique Identifier for time query line.

• line_data (list[QueryLineResult]) – List of QueryLineResult object for time query line.

Examples

Code Snippet: Manipulation of Time Query and its results

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