Skip to content

Commit

Permalink
correct line break
Browse files Browse the repository at this point in the history
  • Loading branch information
Karsten1987 committed Dec 13, 2018
1 parent e1af826 commit a6038ad
Showing 1 changed file with 20 additions and 10 deletions.
30 changes: 20 additions & 10 deletions lifecycle/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -198,17 +198,22 @@ Every child of LifecycleNodes have a set of callbacks provided.
These callbacks go along with the applied state machine attached to it.
These callbacks are:
.. code-block:: c
* ``rclcpp_lifecycle::node_interfaces::LifecycleNodeInterface::CallbackReturn
on_configure(const rclcpp_lifecycle::State & previous_state)``
* ``rclcpp_lifecycle::node_interfaces::LifecycleNodeInterface::CallbackReturn
on_activate(const rclcpp_lifecycle::State & previous_state)``
* ``rclcpp_lifecycle::node_interfaces::LifecycleNodeInterface::CallbackReturn
on_deactivate(const rclcpp_lifecycle::State & previous_state)``
* ``rclcpp_lifecycle::node_interfaces::LifecycleNodeInterface::CallbackReturn
on_cleanup(const rclcpp_lifecycle::State & previous_state)``
* ``rclcpp_lifecycle::node_interfaces::LifecycleNodeInterface::CallbackReturn
on_shutdown(const rclcpp_lifecycle::State & previous_state)``
rclcpp_lifecycle::node_interfaces::LifecycleNodeInterface::CallbackReturn
on_configure(const rclcpp_lifecycle::State & previous_state)
rclcpp_lifecycle::node_interfaces::LifecycleNodeInterface::CallbackReturn
on_activate(const rclcpp_lifecycle::State & previous_state)
rclcpp_lifecycle::node_interfaces::LifecycleNodeInterface::CallbackReturn
on_deactivate(const rclcpp_lifecycle::State & previous_state)
rclcpp_lifecycle::node_interfaces::LifecycleNodeInterface::CallbackReturn
on_cleanup(const rclcpp_lifecycle::State & previous_state)
rclcpp_lifecycle::node_interfaces::LifecycleNodeInterface::CallbackReturn
on_shutdown(const rclcpp_lifecycle::State & previous_state)
In the following we assume that we are inside the namespace ``rclcpp_lifecycle::node_interfaces::LifecycleNodeInterface`` to shorten the name of the return type.
All these callbacks have a positive default return value (\ ``return CallbackReturn::SUCCESS``\ ).
Expand All @@ -227,20 +232,25 @@ At the same time, every lifecycle node has by default 5 different communication
* Publisher ``<node_name>__transition_event``\ : publishes in case a transition is happening.
This allows users to get notified of transition events within the network.
* Service ``<node_name>__get_state``\ : query about the current state of the node.
Return either a primary or transition state.
* Service ``<node_name>__change_state``\ : triggers a transition for the current node.
This service call takes a transition id.
Only in the case, that this transition ID is a valid transition of the current state, the transition is fulfilled.
All other cases are getting ignored.
* Service ``<node_name>__get_available_states``\ : This is meant to be an introspection tool.
It returns a list of all possible states this node can be.
* Service ``<node_name>__get_available_transitions``\ : Same as above, meant to an introspection tool.
It returns a list of all possible transitions this node can execute.
Expand Down

0 comments on commit a6038ad

Please sign in to comment.