Skip to content

Commit 8460efc

Browse files
authored
Add new parameter description in ispathvalid (#637)
* add new parameter description in ispathvalid Signed-off-by: Maurice-1235 <mauricepurnawan@gmail.com> * Input ports for ispathvalid Signed-off-by: Maurice-1235 <mauricepurnawan@gmail.com> * Change description Signed-off-by: Maurice-1235 <mauricepurnawan@gmail.com> --------- Signed-off-by: Maurice-1235 <mauricepurnawan@gmail.com>
1 parent 817718f commit 8460efc

1 file changed

Lines changed: 50 additions & 2 deletions

File tree

configuration/packages/bt-plugins/conditions/IsPathValid.rst

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,59 @@ IsPathValid
55

66
Checks to see if the global path is valid. If there is a
77
obstacle along the path, the condition returns FAILURE, otherwise
8-
it returns SUCCESS.
8+
it returns SUCCESS.
9+
10+
Input Ports
11+
-----------
12+
13+
:service_timeout:
14+
15+
====== =======
16+
Type Default
17+
------ -------
18+
double 20.0
19+
====== =======
20+
21+
Description
22+
Service response timeout (ms).
23+
24+
:path:
25+
26+
==================================== =======
27+
Type Default
28+
------------------------------------ -------
29+
nav_msgs::msg::Path N/A
30+
==================================== =======
31+
32+
Description
33+
The global path to check for validity.
34+
35+
:max_cost:
36+
37+
============== ==========
38+
Type Default
39+
-------------- ----------
40+
unsigned int 253
41+
============== ==========
42+
43+
Description
44+
The maximum allowable cost for the path to be considered valid.
45+
46+
:consider_unknown_as_obstacle:
47+
48+
====== =======
49+
Type Default
50+
------ -------
51+
bool false
52+
====== =======
53+
54+
Description
55+
Whether to consider unknown cost (255) as obstacle.
56+
957

1058
Example
1159
-------
1260

1361
.. code-block:: xml
1462
15-
<IsPathValid server_timeout="10" path="{path}"/>
63+
<IsPathValid server_timeout="10" path="{path}" max_cost="100" consider_unknown_as_obstacle="false" />

0 commit comments

Comments
 (0)