Skip to content

Commit c6b99b9

Browse files
authored
update vector object server docs for new parameter enforce_global_frame_id (#901)
* update vector object server docs for new parameter enforce_global_frame_id Signed-off-by: wen-shuo hsu <wen-shuo.hsu@idealworks.com> * fix trailing white space Signed-off-by: wen-shuo hsu <wen-shuo.hsu@idealworks.com> --------- Signed-off-by: wen-shuo hsu <wen-shuo.hsu@idealworks.com>
1 parent 039f1ee commit c6b99b9

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

configuration/packages/map_server/configuring-vector-object-server.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,17 @@ Parameters
9696
Description:
9797
The name of the coordinate frame where the map is being published at.
9898

99+
:enforce_global_frame_id:
100+
101+
============== =============================
102+
Type Default
103+
-------------- -----------------------------
104+
bool false
105+
============== =============================
106+
107+
Description:
108+
Enforce the use of the global frame ID for all shapes. Any shape with a non-empty frame ID, different than the global frame ID, will lead to failure. This will also disable the creation of the TF listener.
109+
99110
:resolution:
100111

101112
============== =============================
@@ -288,6 +299,7 @@ Here is an example of configuration YAML for the Vector Object server:
288299
ros__parameters:
289300
map_topic: "vo_map"
290301
global_frame_id: "map"
302+
enforce_global_frame_id: False
291303
resolution: 0.05
292304
default_value: -1
293305
overlay_type: 0

0 commit comments

Comments
 (0)