moveit_studio::behavior::LoggerROS Class Reference

A ROS-specialized implementation of LoggerBase that publishes the error message on a topic and logs it through an rclcpp Logger. More...

#include <logger.hpp>

Inheritance diagram for moveit_studio::behavior::LoggerROS:

Collaboration diagram for moveit_studio::behavior::LoggerROS:

Public Member Functions
	LoggerROS (const std::shared_ptr< rclcpp::Node > &node)
	Constructor for LoggerROS. More...
void	publishFailureMessage (const std::string &error_source_name, const std::string &details="", bool append_messages=true) override
	Log error on console and publish the error to be displayed on the UI. More...
void	publishWarnMessage (const std::string &source_name, const std::string &details="", bool append_messages=true) override
	Log warning on console and publish the warning to be displayed on the UI. More...
void	publishInfoMessage (const std::string &source_name, const std::string &details="", bool append_messages=true) override
	Log info on console and publish the info to be displayed on the UI. More...
void	publishMessage (const int32_t log_level, const std::string &details, bool append_messages=true) override
	Helper function which handles publishing custom message according to the log level specified by user. More...
void	popMessages (const std::string &default_message="") override
	Publish the vector of messages which gets propagated to the MoveIt Studio UI. More...
void	clearMessages () override
	Clears stored messages by clearing the contents of the log_messages_ class member. More...
Public Member Functions inherited from moveit_studio::behavior::LoggerBase
virtual	~LoggerBase ()=default

Detailed Description

A ROS-specialized implementation of LoggerBase that publishes the error message on a topic and logs it through an rclcpp Logger.

Constructor & Destructor Documentation

LoggerROS()

moveit_studio::behavior::LoggerROS::LoggerROS ( const std::shared_ptr< rclcpp::Node > &  node )

explicit

Constructor for LoggerROS.

Parameters

node	rclcpp Node used when creating the log publisher.

Member Function Documentation

clearMessages()

void moveit_studio::behavior::LoggerROS::clearMessages ( )

overridevirtual

Clears stored messages by clearing the contents of the log_messages_ class member.

Implements moveit_studio::behavior::LoggerBase.

popMessages()

void moveit_studio::behavior::LoggerROS::popMessages ( const std::string &  default_message = "" )

overridevirtual

Publish the vector of messages which gets propagated to the MoveIt Studio UI.

Parameters

default_message

Optional string defining the message to emit if the Logger does not have any stored messages.

Implements moveit_studio::behavior::LoggerBase.

publishFailureMessage()

void moveit_studio::behavior::LoggerROS::publishFailureMessage ( const std::string &  error_source_name, const std::string &  details = "", bool  append_messages = true  )

overridevirtual

Log error on console and publish the error to be displayed on the UI.

Parameters

error_source_name	Name used to identify the source of the failure, generally a behavior tree node identifier.
details	A detailed message describing the failure.
append_messages	If true, store the message in a vector and the vector of messages is published at the end of the Objective. The default value for this parameter is true. Assign it to false to propagate the error immediatedly to the UI

Implements moveit_studio::behavior::LoggerBase.

publishInfoMessage()

void moveit_studio::behavior::LoggerROS::publishInfoMessage ( const std::string &  source_name, const std::string &  details = "", bool  append_messages = true  )

overridevirtual

Log info on console and publish the info to be displayed on the UI.

Parameters

error_source_name	Name used to identify the source of the info, generally a behavior tree node identifier.
details	Contains the information message
append_messages	If true, store the message in a vector and the vector of messages is published at the end of the Objective. The default value for this parameter is true. Assign it to false to propagate the info immediatedly to the UI

Implements moveit_studio::behavior::LoggerBase.

publishMessage()

void moveit_studio::behavior::LoggerROS::publishMessage ( const int32_t  log_level, const std::string &  details, bool  append_messages = true  )

overridevirtual

Helper function which handles publishing custom message according to the log level specified by user.

Parameters

log_level	moveit_studio_agent_msgs::msg::ERROR/WARN/INFO
details	Contains the information message
append_messages	If true, store the message in a vector and the vector of messages is published at the end of the Objective. The default value for this parameter is true. Assign it to false to propagate the info immediatedly to the UI

Implements moveit_studio::behavior::LoggerBase.

publishWarnMessage()

void moveit_studio::behavior::LoggerROS::publishWarnMessage ( const std::string &  source_name, const std::string &  details = "", bool  append_messages = true  )

overridevirtual

Log warning on console and publish the warning to be displayed on the UI.

Parameters

error_source_name	Name used to identify the source of the warning, generally a behavior tree node identifier.
details	Contains a brief message describing the warning
append_messages	If true, store the message in a vector and the vector of messages is published at the end of the Objective. The default value for this parameter is true. Assign it to false to propagate the warning immediatedly to the UI

Implements moveit_studio::behavior::LoggerBase.

---

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

• logger.hpp
• logger.cpp