nav2_behavior_tree::DistanceTraveledCondition Class Reference

A BT::ConditionNode that returns SUCCESS every time the robot travels a specified distance and FAILURE otherwise. More...

#include <nav2_behavior_tree/include/nav2_behavior_tree/plugins/condition/distance_traveled_condition.hpp>

Inheritance diagram for nav2_behavior_tree::DistanceTraveledCondition:

Collaboration diagram for nav2_behavior_tree::DistanceTraveledCondition:

Public Member Functions
	DistanceTraveledCondition (const std::string &condition_name, const BT::NodeConfiguration &conf)
	A constructor for nav2_behavior_tree::DistanceTraveledCondition. More...
BT::NodeStatus	tick () override
	The main override required by a BT action. 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::ConditionNode that returns SUCCESS every time the robot travels a specified distance and FAILURE otherwise.

Definition at line 36 of file distance_traveled_condition.hpp.

Constructor & Destructor Documentation

DistanceTraveledCondition()

nav2_behavior_tree::DistanceTraveledCondition::DistanceTraveledCondition	(	const std::string &	condition_name,
		const BT::NodeConfiguration &	conf
	)

A constructor for nav2_behavior_tree::DistanceTraveledCondition.

Parameters

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

Definition at line 27 of file distance_traveled_condition.cpp.

Member Function Documentation

providedPorts()

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

inlinestatic

Creates list of BT ports.

Returns

BT::PortsList Containing node-specific ports

Definition at line 65 of file distance_traveled_condition.hpp.

tick()

BT::NodeStatus nav2_behavior_tree::DistanceTraveledCondition::tick ( )

override

The main override required by a BT action.

Returns

BT::NodeStatus Status of tick execution

Definition at line 50 of file distance_traveled_condition.cpp.

References initialize().

Here is the call graph for this function:

---

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

• nav2_behavior_tree/include/nav2_behavior_tree/plugins/condition/distance_traveled_condition.hpp
• nav2_behavior_tree/plugins/condition/distance_traveled_condition.cpp