atef.procedure.FailedStep

class atef.procedure.FailedStep(parent: ~atef.procedure.PreparedProcedureGroup | None, origin: ~atef.procedure.ProcedureGroup | ~atef.procedure.DescriptionStep | ~atef.procedure.PassiveStep | ~atef.procedure.SetValueStep | ~atef.procedure.PlanStep | ~atef.procedure.TemplateStep, combined_result: ~atef.result.Result = <factory>, verify_result: ~atef.result.Result = <factory>, step_result: ~atef.result.Result = <factory>, exception: Exception | None = None)[source]

A step that failed to be prepared for running.

Attributes:

exception
result

Methods

__init__(parent: ~atef.procedure.PreparedProcedureGroup | None, origin: ~atef.procedure.ProcedureGroup | ~atef.procedure.DescriptionStep | ~atef.procedure.PassiveStep | ~atef.procedure.SetValueStep | ~atef.procedure.PlanStep | ~atef.procedure.TemplateStep, combined_result: ~atef.result.Result = <factory>, verify_result: ~atef.result.Result = <factory>, step_result: ~atef.result.Result = <factory>, exception: Exception | None = None) → None

Attributes

exception: Exception | None = None: Exception that was caught, if available.

result

parent: PreparedProcedureGroup | None: The data cache to use for the preparation step.

origin: ProcedureGroup | DescriptionStep | PassiveStep | SetValueStep | PlanStep | TemplateStep: Configuration instance.

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