atef.procedure.SetValueStep

class atef.procedure.SetValueStep(name: str | None = None, description: str | None = None, parent: ~atef.procedure.ProcedureGroup | None = None, verify_required: bool = True, step_success_required: bool = True, actions: ~typing.List[~atef.procedure.ValueToTarget] = <factory>, success_criteria: ~typing.List[~atef.procedure.ComparisonToTarget] = <factory>, halt_on_fail: bool = True, require_action_success: bool = True)

A step that sets one or more values and checks one or more values after

Attributes:

description

name

parent

Methods

allow_verify()	Whether or not the step can be verified.
children()	Return children of this group, as a tree view might expect
replace_comparison(old_comp, new_comp)	replace old_comp with new_comp, in success_criteria

Methods

__init__(name: str | None = None, description: str | None = None, parent: ~atef.procedure.ProcedureGroup | None = None, verify_required: bool = True, step_success_required: bool = True, actions: ~typing.List[~atef.procedure.ValueToTarget] = <factory>, success_criteria: ~typing.List[~atef.procedure.ComparisonToTarget] = <factory>, halt_on_fail: bool = True, require_action_success: bool = True) → None

allow_verify() → bool

Whether or not the step can be verified. To be further expanded or overloaded in subclass,

children() → List[ComparisonToTarget]

Return children of this group, as a tree view might expect

replace_comparison(old_comp: Comparison, new_comp: Comparison) → None

replace old_comp with new_comp, in success_criteria

Attributes

description: str | None = None

A description of narrative explanation of setup steps, what is to happen, etc.

halt_on_fail: bool = True

Stop performing actions if one fails

name: str | None = None

The title of the procedure

parent: ProcedureGroup | None = None

The hierarchical parent of this step.

require_action_success: bool = True

Only mark the step_result as successful if all actions have succeeded

step_success_required: bool = True

step success requirements, does the step need to complete?

verify_required: bool = True

verification requirements, is human verification required?

actions: List[ValueToTarget]

success_criteria: List[ComparisonToTarget]