pyrcf.components.local_planners.local_planner_base

Classes

`LocalPlannerBase`	Base class defining the interface for all local planners that can be used in the control
`DummyLocalPlanner`	Dummy local planner for testing pipeline.

class pyrcf.components.local_planners.local_planner_base.LocalPlannerBase

Base class defining the interface for all local planners that can be used in the control loop.

The main local plan generation method to be called in the loop.

This method will be called after the global plan is generated in the loop.

This method should be implemented by any local planner implementation.

Parameters:

robot_state (RobotState) – The current state information from the robot.
global_plan (GlobalMotionPlan) – the latest global plan generated by the global planner used in the loop.
t (float) – the current time signature of the control loop. Defaults to None (controllers may or may not need this).
dt (float, optional) – the time since the last control loop. Defaults to None (controllers may or may not need this).

Raises:

NotImplementedError – Raised if this method is not implemented by the child class.

Returns:

The output local plan to be used by the controller in this iteration.

Return type:

LocalMotionPlan

class pyrcf.components.local_planners.local_planner_base.DummyLocalPlanner(squawk: bool = True)

Dummy local planner for testing pipeline.

generate_local_plan(robot_state: pyrcf.core.types.RobotState, global_plan: pyrcf.core.types.GlobalMotionPlan, t: float, dt: float) → pyrcf.core.types.LocalMotionPlan: This is a dummy method for sanity checking the control loop.