.. _pilot.limit_reason_e:

pilot.limit_reason_e
====================

.. cpp:namespace:: pilot::limit_reason_e

Enumeration
-----------

Possible reasons for limiting velocity or yawrate.

.. cpp:enumerator:: DEFAULT_MAX
	
	Default maximum for the platform. (global configuration)
	
.. cpp:enumerator:: CUSTOM_MAX
	
	Custom limit (at current position). (Road Map parameter, or via. :ref:`pilot.goal_options_t`)
	
.. cpp:enumerator:: ACCEL_MAX
	
	Limited due to hitting maximum allowed acceleration / decceleration.
	
.. cpp:enumerator:: LOCAL_COST
	
	Limited due to obstacles in path or close to path.
	
.. cpp:enumerator:: PATH_DEVIATION
	
	Limited due to unexpected deviation from path.
	
.. cpp:enumerator:: ORIENTATION_DEVIATION
	
	Limited due to unexpected deviation from target orientation.
	
.. cpp:enumerator:: CURVE_LIMIT
	
	Limited due to maximum lateral acceleration.
	
.. cpp:enumerator:: WAITING
	
	Limited due to waiting for a certain condition.
	
.. cpp:enumerator:: GOAL_MAX
	
	Limited due to approaching final goal position.
	
.. cpp:enumerator:: LIMIT_AHEAD
	
	Limited due to approaching a lower limit on the path ahead.
	
.. cpp:enumerator:: OBSTACLE
	
	Limited due to obstacle blocking the path.
	
.. cpp:enumerator:: STOPPING
	
	Limited due to trying to stop.
	
.. cpp:enumerator:: FINISHED
	
	Limited due to having reached the goal.