atef.procedure.PreparedSetValueStep

class atef.procedure.PreparedSetValueStep(name: 'Optional[str]' = None, origin: 'ProcedureStep' = <factory>, parent: 'Optional[PreparedProcedureGroup]' = None, combined_result: 'Result' = <factory>, verify_result: 'Result' = <factory>, step_result: 'Result' = <factory>, prepared_actions: 'List[PreparedValueToSignal]' = <factory>, prepared_criteria: 'List[PreparedSignalComparison]' = <factory>)[source]

Attributes:

name
parent
result: Combines the step result and verification result based on settings

Methods

`from_origin`(step, parent)	Prepare a SetValueStep for running.
`run`()	Run the step and return the result
`walk_comparisons`()	Yields PreparedComparisons in this ProcedureStep

Methods

__init__(name: str | None = None, origin: ~atef.procedure.ProcedureStep = <factory>, parent: ~atef.procedure.PreparedProcedureGroup | None = None, combined_result: ~atef.result.Result = <factory>, verify_result: ~atef.result.Result = <factory>, step_result: ~atef.result.Result = <factory>, prepared_actions: ~typing.List[~atef.procedure.PreparedValueToSignal] = <factory>, prepared_criteria: ~typing.List[~atef.config.PreparedSignalComparison] = <factory>) → None

classmethod from_origin(step: SetValueStep, parent: PreparedProcedureGroup | None) → PreparedSetValueStep[source]

Prepare a SetValueStep for running. Gathers and prepares necessary signals and comparisons. Any actions and success criteria that fail to be prepared will be stored under the prepare_action_failures and prepare_criteria_failures fields respectively

Parameters:

stepSetValueStep: the original SetValueStep (not prepared)
parentOptional[PreparedProcedureGroup]: the hierarchical parent for the prepared step.

Returns:

PreparedSetValueStep

async run() → Result: Run the step and return the result

walk_comparisons() → Generator[PreparedComparison, None, None][source]: Yields PreparedComparisons in this ProcedureStep

Attributes

name: str | None = None: name of this comparison

parent: PreparedProcedureGroup | None = None: hierarchical parent of this step

result

Combines the step result and verification result based on settings

Returns:

Result: The overall result of this step

prepared_actions: List[PreparedValueToSignal]: list of prepared actions to take (values to set to a target)

prepared_criteria: List[PreparedSignalComparison]: list of prepared success criteria (comparisons)

origin: ProcedureStep: original procedure step, of which this is the prepared version

combined_result: Result: overall result of running the step

verify_result: Result: confirmation by the user that result matches expectations

step_result: Result: whether or not the step completed successfully