MoveIt Pro Behavior
Core Behaviors for MoveIt Pro
moveit_studio::behavior::LoggerBase Class Referenceabstract

Base class to allow Behaviors to report messages with detailed explanations to MoveIt Studio UI. More...

#include <logger.hpp>

Inheritance diagram for moveit_studio::behavior::LoggerBase:

Public Member Functions

virtual ~LoggerBase ()=default
 
virtual void publishFailureMessage (const std::string &error_source_name, const std::string &details="")=0
 Virtual function to publish a failure message. More...
 
virtual void publishWarnMessage (const std::string &source_name, const std::string &details="")=0
 Virtual function to publish a warning message. More...
 
virtual void publishInfoMessage (const std::string &source_name, const std::string &details="")=0
 Virtual function to publish an info message. More...
 
virtual void publishMessage (const int32_t log_level, const std::string &details)=0
 Virtual generic function to publish a message. More...
 

Detailed Description

Base class to allow Behaviors to report messages with detailed explanations to MoveIt Studio UI.

Constructor & Destructor Documentation

◆ ~LoggerBase()

virtual moveit_studio::behavior::LoggerBase::~LoggerBase ( )
virtualdefault

Member Function Documentation

◆ publishFailureMessage()

virtual void moveit_studio::behavior::LoggerBase::publishFailureMessage ( const std::string &  error_source_name,
const std::string &  details = "" 
)
pure virtual

Virtual function to publish a failure message.

Parameters
error_source_nameName used to identify the source of the failure.
detailsA detailed message describing the failure. For example, the contents of an exception's message.

Implemented in moveit_studio::behavior::LoggerROS.

◆ publishInfoMessage()

virtual void moveit_studio::behavior::LoggerBase::publishInfoMessage ( const std::string &  source_name,
const std::string &  details = "" 
)
pure virtual

Virtual function to publish an info message.

Parameters
source_nameName used to identify the source of the info.
detailsA detailed message describing the information.

Implemented in moveit_studio::behavior::LoggerROS.

◆ publishMessage()

virtual void moveit_studio::behavior::LoggerBase::publishMessage ( const int32_t  log_level,
const std::string &  details 
)
pure virtual

Virtual generic function to publish a message.

Parameters
log_levelmoveit_studio_agent_msgs::msg::ERROR/WARN/INFO
detailsContains the information message

Implemented in moveit_studio::behavior::LoggerROS.

◆ publishWarnMessage()

virtual void moveit_studio::behavior::LoggerBase::publishWarnMessage ( const std::string &  source_name,
const std::string &  details = "" 
)
pure virtual

Virtual function to publish a warning message.

Parameters
source_nameName used to identify the source of the warning.
detailsA detailed message describing the warning.

Implemented in moveit_studio::behavior::LoggerROS.


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