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

.. py:module:: pyrcf.components.pyrcf_component

.. autoapi-nested-parse::

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

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



Classes
-------

.. autoapisummary::

   pyrcf.components.pyrcf_component.PyRCFComponent


Module 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.