atef.procedure.DescriptionStep

class atef.procedure.DescriptionStep(name: str | None = None, description: str | None = None, parent: ProcedureGroup | None = None, verify_required: bool = True, step_success_required: bool = True)[source]

A simple title or descriptive step in the procedure.

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

Methods

__init__(name: str | None = None, description: str | None = None, parent: ProcedureGroup | None = None, verify_required: bool = True, step_success_required: bool = True) → None

allow_verify() → bool: Whether or not the step can be verified. To be further expanded or overloaded in subclass,

children() → List[Any]: Return children of this group, as a tree view might expect

Attributes

description: str | None = None: A description of narrative explanation of setup steps, what is to happen, etc.

name: str | None = None: The title of the procedure

parent: ProcedureGroup | None = None: The hierarchical parent of this step.

step_success_required: bool = True: step success requirements, does the step need to complete?

verify_required: bool = True: verification requirements, is human verification required?