Skip to content

Commit

Permalink
Update bdai_ros2_wrappers/bdai_ros2_wrappers/process.py
Browse files Browse the repository at this point in the history
Co-authored-by: mhidalgo-bdai <[email protected]>
  • Loading branch information
ggoretkin-bdai and mhidalgo-bdai authored Nov 21, 2023
1 parent a30e2c4 commit f8daf32
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions bdai_ros2_wrappers/bdai_ros2_wrappers/process.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,11 @@ def __init__(
an `argparse.Namespace` (if a CLI is specified), or nothing, and returning a integer
exit code or nothing.
prebaked: whether to instantiate a prebaked process or a bare process. Defaults to True.
- a prebaked process has an implicit node and an executor
- a bare process does not bear a node nor spin an executor, which brings them closest to standard
ROS 2 idioms.
- for `prebaked=True`, the ROS node name is the the current executable basename without its extension
(or CLI program name if one is specified)
- The ROS node name can be set to `foo` with `prebaked="foo"`
Note that:
- a prebaked process has an implicit node and an executor;
- a bare process has neither, which brings it the closest to standard ROS 2 idioms;
- when `prebaked=True`, the implicit node name will be the current executable basename without extension (or CLI program name if one is specified);
- when `prebaked="string"`, the given string will be used as the implicit node name.
autospin: whether to automatically equip the underlying scope with a background executor
or not. Defaults to True for prebaked processes and to False for bare processes.
uses_tf: whether to instantiate a tf listener bound to the process main node. Defaults to False.
Expand Down

0 comments on commit f8daf32

Please sign in to comment.