Skip to content

ExperimentAction

Source code in docs_src/capo_fis/types/experiment_action.py
class ExperimentAction(TypedDict, closed=True):
    action_id: NotRequired["capo_fis.types.action_id.ActionId"]
    """<p>The ID of the action.</p>"""
    description: NotRequired[
        "capo_fis.types.experiment_action_description.ExperimentActionDescription"
    ]
    """<p>The description for the action.</p>"""
    parameters: NotRequired[
        "capo_fis.types.experiment_action_parameter_map.ExperimentActionParameterMap"
    ]
    """<p>The parameters for the action.</p>"""
    targets: NotRequired[
        "capo_fis.types.experiment_action_target_map.ExperimentActionTargetMap"
    ]
    """<p>The targets for the action.</p>"""
    start_after: NotRequired[
        "capo_fis.types.experiment_action_start_after_list.ExperimentActionStartAfterList"
    ]
    """<p>The name of the action that must be completed before this action starts.</p>"""
    state: NotRequired["capo_fis.types.experiment_action_state.ExperimentActionState"]
    """<p>The state of the action.</p>"""
    start_time: NotRequired[
        "capo_fis.types.experiment_action_start_time.ExperimentActionStartTime"
    ]
    """<p>The time that the action started.</p>"""
    end_time: NotRequired[
        "capo_fis.types.experiment_action_end_time.ExperimentActionEndTime"
    ]
    """<p>The time that the action ended.</p>"""

action_id instance-attribute

action_id: NotRequired[ActionId]

The ID of the action.

description instance-attribute

description: NotRequired[ExperimentActionDescription]

The description for the action.

end_time instance-attribute

end_time: NotRequired[ExperimentActionEndTime]

The time that the action ended.

parameters instance-attribute

parameters: NotRequired[ExperimentActionParameterMap]

The parameters for the action.

start_after instance-attribute

start_after: NotRequired[ExperimentActionStartAfterList]

The name of the action that must be completed before this action starts.

start_time instance-attribute

start_time: NotRequired[ExperimentActionStartTime]

The time that the action started.

state instance-attribute

state: NotRequired[ExperimentActionState]

The state of the action.

targets instance-attribute

targets: NotRequired[ExperimentActionTargetMap]

The targets for the action.