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

.. py:module:: pyrcf.components.global_planners

.. autoapi-nested-parse::

   Module containing interface and definitions of global planners (and ui reference generators)
   that can be used in the control loop.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/pyrcf/components/global_planners/global_planner_base/index
   /autoapi/pyrcf/components/global_planners/ui_reference_generators/index


Classes
-------

.. autoapisummary::

   pyrcf.components.global_planners.GlobalMotionPlannerBase


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

.. py:class:: GlobalMotionPlannerBase

   Bases: :py:obj:`pyrcf.components.pyrcf_component.PyRCFComponent`


   Simple protocol and base class for a global motion planner interface.

   This protocol has to be respected by all classes that generate a GlobalMotionPlan object
   to be used in the control loop by local planners. (e.g. user interfaces such as
   keyboard_interface).

   INFO: A general 'global motion planner' is a planner that performs high-level planning that is
       dependent on the task the robot has to perform. For e.g. for a A->B locomotion, the global
       planner might generate a sequence of collision-aware waypoints for the local planner to
       respect.


   .. py:method:: generate_global_plan(robot_state: pyrcf.core.types.RobotState, t: float, dt: float) -> pyrcf.core.types.GlobalMotionPlan
      :abstractmethod:


      Generate a global motion plan message.

      :param robot_state: Current robot state.
      :type robot_state: RobotState
      :param t: the current time signature of the control loop.
      :type t: float, optional
      :param dt: the time since the last control loop.
      :type dt: float, optional

      :returns: Output global plan to be sent to local planner in the control loop.
      :rtype: GlobalMotionPlan