Execution Engine

class tsuchinoko.execution.Engine[source]

The Execution Engine base class. This component is generally to be responsible for measuring targets.

abstract get_measurements() List[Tuple][source]

Returns new measurements made since its last call. Generally measured values are accumulated by a background thread, then returned and cleared here.

Returns:
position: tuple

The measured target position.

value: float

The value at that position.

variance: float

The variance associated with the measurement of that value.

metrics: dict

Any non-standard metric values to be used for visualization at the client.

abstract get_position() Tuple[source]

Returns the current position in the target domain.

Returns:
current_position: tuple

The current position in the target domain

abstract update_targets(targets: List[Tuple])[source]

Updates the list of measurement targets. Generally new targets will take precedence, and will be stashed for measurement in the background.

Parameters:
targets: list

A list of new measure target positions.