A BT::DecoratorNode that ticks its child at a specified rate. More...
#include <nav2_behavior_tree/include/nav2_behavior_tree/plugins/decorator/rate_controller.hpp>
Inheritance diagram for nav2_behavior_tree::RateController:
Collaboration diagram for nav2_behavior_tree::RateController:
Public Member Functions | |
| RateController (const std::string &name, const BT::NodeConfiguration &conf) | |
| A constructor for nav2_behavior_tree::RateController. More... | |
| void | initialize () |
| Function to read parameters and initialize class variables. | |
Static Public Member Functions | |
| static BT::PortsList | providedPorts () |
| Creates list of BT ports. More... | |
Detailed Description
A BT::DecoratorNode that ticks its child at a specified rate.
- Note
- This is an Asynchronous (long-running) node which may return a RUNNING state while executing. It will re-initialize when halted.
Definition at line 31 of file rate_controller.hpp.
Constructor & Destructor Documentation
◆ RateController()
| nav2_behavior_tree::RateController::RateController | ( | const std::string & | name, |
| const BT::NodeConfiguration & | conf | ||
| ) |
A constructor for nav2_behavior_tree::RateController.
- Parameters
-
name Name for the XML tag for this node conf BT node configuration
Definition at line 23 of file rate_controller.cpp.
Member Function Documentation
◆ providedPorts()
|
inlinestatic |
Creates list of BT ports.
- Returns
- BT::PortsList Containing node-specific ports
Definition at line 52 of file rate_controller.hpp.
The documentation for this class was generated from the following files:
- nav2_behavior_tree/include/nav2_behavior_tree/plugins/decorator/rate_controller.hpp
- nav2_behavior_tree/plugins/decorator/rate_controller.cpp
