pyrcf.components
================

.. py:module:: pyrcf.components

.. autoapi-nested-parse::

   Components that can be run in the control loop.



Subpackages
-----------

.. toctree::
   :maxdepth: 1

   /autoapi/pyrcf/components/agents/index
   /autoapi/pyrcf/components/callback_handlers/index
   /autoapi/pyrcf/components/controller_manager/index
   /autoapi/pyrcf/components/controllers/index
   /autoapi/pyrcf/components/ctrl_loop_debuggers/index
   /autoapi/pyrcf/components/global_planners/index
   /autoapi/pyrcf/components/local_planners/index
   /autoapi/pyrcf/components/robot_interfaces/index
   /autoapi/pyrcf/components/state_estimators/index


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/pyrcf/components/pyrcf_component/index


Classes
-------

.. autoapisummary::

   pyrcf.components.PyRCFComponent


Package Contents
----------------

.. py:class:: PyRCFComponent

   Bases: :py:obj:`abc.ABC`


   Abstract base class for all core components in PyRCF control loop.

   Components that inherit this are:
       - RobotInterfaceBase
       - GlobalMotionPlannerBase
       - LocalMotionPlannerBase
       - ControllerBase
       - StateEstimatorBase


   .. py:method:: shutdown()

      Cleanly shutdown the PyRCF component. Override in child class if required. The
      base class implements an empty function.



   .. py:method:: get_class_name() -> str

      Get the name of the class/type of this object.



   .. py:method:: get_class_info() -> str

      Override with custom string if needed.