nav2_behavior_tree::DistanceController Class Reference

A BT::DecoratorNode that ticks its child every time the robot travels a specified distance. More...

#include <nav2_behavior_tree/include/nav2_behavior_tree/plugins/decorator/distance_controller.hpp>

Inheritance diagram for nav2_behavior_tree::DistanceController:

Collaboration diagram for nav2_behavior_tree::DistanceController:

Public Member Functions
	DistanceController (const std::string &name, const BT::NodeConfiguration &conf)
	A constructor for nav2_behavior_tree::DistanceController. More...

Static Public Member Functions
static BT::PortsList	providedPorts ()
	Creates list of BT ports. More...

Detailed Description

A BT::DecoratorNode that ticks its child every time the robot travels a specified distance.

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 37 of file distance_controller.hpp.

Constructor & Destructor Documentation

DistanceController()

nav2_behavior_tree::DistanceController::DistanceController	(	const std::string &	name,
		const BT::NodeConfiguration &	conf
	)

A constructor for nav2_behavior_tree::DistanceController.

Parameters

name	Name for the XML tag for this node
conf	BT node configuration

Definition at line 33 of file distance_controller.cpp.

Member Function Documentation

providedPorts()

static BT::PortsList nav2_behavior_tree::DistanceController::providedPorts ( )

inlinestatic

Creates list of BT ports.

Returns

BT::PortsList Containing node-specific ports

Definition at line 53 of file distance_controller.hpp.

---

The documentation for this class was generated from the following files:

• nav2_behavior_tree/include/nav2_behavior_tree/plugins/decorator/distance_controller.hpp
• nav2_behavior_tree/plugins/decorator/distance_controller.cpp