step.model
==========

.. py:module:: step.model


Classes
-------

.. autoapisummary::

   step.model.StepProtocol
   step.model.SimulationStepDelta
   step.model.SimulationStep


Module Contents
---------------

.. py:class:: StepProtocol

   Bases: :py:obj:`Protocol`


   Structural protocol implemented by executable step objects.


   .. py:method:: run_step(robot: raccoon.robot.api.GenericRobot) -> None
      :async:



   .. py:method:: required_resources() -> frozenset[str]


   .. py:method:: collected_resources() -> frozenset[str]


.. py:class:: SimulationStepDelta

   Estimated pose change caused by a step in simulation space.


   .. py:attribute:: forward
      :type:  float


   .. py:attribute:: strafe
      :type:  float


   .. py:attribute:: angular
      :type:  float


.. py:class:: SimulationStep

   Simulation metadata derived from a runtime step.


   .. py:attribute:: id
      :type:  str


   .. py:attribute:: label
      :type:  str | None


   .. py:attribute:: average_duration_ms
      :type:  float


   .. py:attribute:: duration_stddev_ms
      :type:  float


   .. py:attribute:: delta
      :type:  SimulationStepDelta