Nav2 Navigation Stack - rolling  main
ROS 2 Navigation Stack
Public Member Functions | Static Public Member Functions | List of all members
nav2_behavior_tree::TimeExpiredCondition Class Reference

A BT::ConditionNode that returns SUCCESS every time a specified time period passes and FAILURE otherwise. More...

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

Inheritance diagram for nav2_behavior_tree::TimeExpiredCondition:
Inheritance graph
[legend]
Collaboration diagram for nav2_behavior_tree::TimeExpiredCondition:
Collaboration graph
[legend]

Public Member Functions

 TimeExpiredCondition (const std::string &condition_name, const BT::NodeConfiguration &conf)
 A constructor for nav2_behavior_tree::TimeExpiredCondition. 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 a specified time period passes and FAILURE otherwise.

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 33 of file time_expired_condition.hpp.

Constructor & Destructor Documentation

◆ TimeExpiredCondition()

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

A constructor for nav2_behavior_tree::TimeExpiredCondition.

Parameters
condition_nameName for the XML tag for this node
confBT node configuration

Definition at line 26 of file time_expired_condition.cpp.

Member Function Documentation

◆ providedPorts()

static BT::PortsList nav2_behavior_tree::TimeExpiredCondition::providedPorts ( )
inlinestatic

Creates list of BT ports.

Returns
BT::PortsList Containing node-specific ports

Definition at line 62 of file time_expired_condition.hpp.

◆ tick()

BT::NodeStatus nav2_behavior_tree::TimeExpiredCondition::tick ( )
override

The main override required by a BT action.

Returns
BT::NodeStatus Status of tick execution

Definition at line 41 of file time_expired_condition.cpp.

References initialize().

Here is the call graph for this function:

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