Nav2 Navigation Stack - kilted  kilted
ROS 2 Navigation Stack
Public Member Functions | Protected Attributes | List of all members
nav2_behavior_tree::RosTopicLogger Class Reference

A class to publish BT logs on BT status change. More...

#include <nav2_behavior_tree/include/nav2_behavior_tree/ros_topic_logger.hpp>

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

Public Member Functions

 RosTopicLogger (const rclcpp::Node::WeakPtr &ros_node, const BT::Tree &tree)
 A constructor for nav2_behavior_tree::RosTopicLogger. More...
 
void callback (BT::Duration timestamp, const BT::TreeNode &node, BT::NodeStatus prev_status, BT::NodeStatus status) override
 Callback function which is called each time BT changes status. More...
 
void flush () override
 Clear log buffer if any.
 

Protected Attributes

rclcpp::Clock::SharedPtr clock_
 
rclcpp::Logger logger_ {rclcpp::get_logger("bt_navigator")}
 
rclcpp::Publisher< nav2_msgs::msg::BehaviorTreeLog >::SharedPtr log_pub_
 
std::vector< nav2_msgs::msg::BehaviorTreeStatusChange > event_log_
 

Detailed Description

A class to publish BT logs on BT status change.

Definition at line 35 of file ros_topic_logger.hpp.

Constructor & Destructor Documentation

◆ RosTopicLogger()

nav2_behavior_tree::RosTopicLogger::RosTopicLogger ( const rclcpp::Node::WeakPtr &  ros_node,
const BT::Tree &  tree 
)
inline

A constructor for nav2_behavior_tree::RosTopicLogger.

Parameters
ros_nodeWeak pointer to parent rclcpp::Node
treeBT to monitor

Definition at line 43 of file ros_topic_logger.hpp.

Member Function Documentation

◆ callback()

void nav2_behavior_tree::RosTopicLogger::callback ( BT::Duration  timestamp,
const BT::TreeNode &  node,
BT::NodeStatus  prev_status,
BT::NodeStatus  status 
)
inlineoverride

Callback function which is called each time BT changes status.

Parameters
timestampTimestamp of BT status change
nodeNode that changed status
prev_statusPrevious status of the node
statusCurrent status of the node

Definition at line 61 of file ros_topic_logger.hpp.


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