Skip to content

Commit a639345

Browse files
committed
Merge branch 'fix/expose_same_api' of github.com:Koichi98/autoware_core into fix/expose_same_api
2 parents df9f845 + e8c3ebf commit a639345

2 files changed

Lines changed: 10 additions & 9 deletions

File tree

common/autoware_agnocast_wrapper/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,18 +53,18 @@ Which of the two `Node` **class definitions** is compiled is a **build-time** ch
5353
only affects the backend and the underlying-node accessors below.
5454

5555
This is a separate axis from the **runtime backend selection**: in the agnocast-enabled build, each
56-
node *instance* additionally picks `rclcpp::Node` vs `agnocast::Node` at construction from the
56+
node _instance_ additionally picks `rclcpp::Node` vs `agnocast::Node` at construction from the
5757
`ENABLE_AGNOCAST` environment variable read at runtime (`use_agnocast()`), fixed for the node's
58-
lifetime. The runtime value selects the backend; it does *not* change which `Node` definition was
58+
lifetime. The runtime value selects the backend; it does _not_ change which `Node` definition was
5959
compiled or which methods are declared — e.g. `get_agnocast_node()` is declared in every
6060
agnocast-enabled build and instead throws at runtime when the node is not in Agnocast mode.
6161

62-
| | Agnocast-disabled build<br>(`USE_AGNOCAST_ENABLED` undefined) | Agnocast-enabled build<br>(`USE_AGNOCAST_ENABLED` defined) |
63-
| ---------------------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
64-
| Backend | Always an owned `rclcpp::Node`. | `rclcpp::Node` or `agnocast::Node`, chosen at construction from the runtime `ENABLE_AGNOCAST` value and fixed for the node's lifetime. |
65-
| `get_rclcpp_node()` | Always returns the owned node. | Declared; returns the `rclcpp::Node`, but **throws** `std::runtime_error` if the node is in Agnocast mode. |
66-
| `get_agnocast_node()` | **Not declared** — calling it is a compile error. | Declared regardless of the runtime backend; returns the `agnocast::Node`, but **throws** if the node is not in Agnocast mode. |
67-
| `to_rclcpp_node(node)` | Always succeeds. | Forwards to `get_rclcpp_node()` (same throw condition). |
62+
| | Agnocast-disabled build<br>(`USE_AGNOCAST_ENABLED` undefined) | Agnocast-enabled build<br>(`USE_AGNOCAST_ENABLED` defined) |
63+
| ---------------------- | ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
64+
| Backend | Always an owned `rclcpp::Node`. | `rclcpp::Node` or `agnocast::Node`, chosen at construction from the runtime `ENABLE_AGNOCAST` value and fixed for the node's lifetime. |
65+
| `get_rclcpp_node()` | Always returns the owned node. | Declared; returns the `rclcpp::Node`, but **throws** `std::runtime_error` if the node is in Agnocast mode. |
66+
| `get_agnocast_node()` | **Not declared** — calling it is a compile error. | Declared regardless of the runtime backend; returns the `agnocast::Node`, but **throws** if the node is not in Agnocast mode. |
67+
| `to_rclcpp_node(node)` | Always succeeds. | Forwards to `get_rclcpp_node()` (same throw condition). |
6868

6969
In both builds `agnocast_wrapper::Node` does not derive from `rclcpp::Node`, so hand it to an executor or
7070
utility via `get_node_base_interface()` (e.g. `executor.add_node(node->get_node_base_interface())`).

common/autoware_agnocast_wrapper/include/autoware/agnocast_wrapper/message_filters.hpp

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,8 @@ namespace agnocast_wrapper
400400
namespace message_filters
401401
{
402402

403-
/// @brief message_filters Subscriber (non-Agnocast build). Takes the wrapper Node and forwards to its
403+
/// @brief message_filters Subscriber (non-Agnocast build). Takes the wrapper Node and forwards to
404+
/// its
404405
/// underlying rclcpp::Node, so the public API matches the Agnocast build.
405406
template <class M>
406407
class Subscriber : public ::message_filters::Subscriber<M, rclcpp::Node>

0 commit comments

Comments
 (0)