diff --git a/configuration/packages/bt-plugins/conditions/IsPathValid.rst b/configuration/packages/bt-plugins/conditions/IsPathValid.rst index 8484f013d2..31b6b7953e 100644 --- a/configuration/packages/bt-plugins/conditions/IsPathValid.rst +++ b/configuration/packages/bt-plugins/conditions/IsPathValid.rst @@ -5,11 +5,59 @@ IsPathValid Checks to see if the global path is valid. If there is a obstacle along the path, the condition returns FAILURE, otherwise -it returns SUCCESS. +it returns SUCCESS. + +Input Ports +----------- + +:service_timeout: + + ====== ======= + Type Default + ------ ------- + double 20.0 + ====== ======= + + Description + Service response timeout (ms). + +:path: + + ==================================== ======= + Type Default + ------------------------------------ ------- + nav_msgs::msg::Path N/A + ==================================== ======= + + Description + The global path to check for validity. + +:max_cost: + + ============== ========== + Type Default + -------------- ---------- + unsigned int 253 + ============== ========== + + Description + The maximum allowable cost for the path to be considered valid. + +:consider_unknown_as_obstacle: + + ====== ======= + Type Default + ------ ------- + bool false + ====== ======= + + Description + Whether to consider unknown cost (255) as obstacle. + Example ------- .. code-block:: xml - \ No newline at end of file + \ No newline at end of file