yasmin_ros Namespace Reference

Namespaces
namespace	basic_outcomes
	Provides common outcome constants for ROS 2.

Classes
class	ActionState
	A state class for handling ROS 2 action client operations. More...
class	MonitorState
	Template class to monitor a ROS 2 topic and process incoming messages. More...
class	ServiceState
	A state class that interacts with a ROS 2 service. More...
class	YasminNode
	A ROS 2 node for managing and handling YASMIN-based applications. More...

Functions
void	set_ros_loggers ()
	Sets the logging functions for ROS, linking ROS 2 log levels to YASMIN loggers.
void	ros_log_error (const char *file, const char *function, int line, const char *text,...)
	Logs an error message with formatted text to the ROS logger.
void	ros_log_warn (const char *file, const char *function, int line, const char *text,...)
	Logs a warning message with formatted text to the ROS logger.
void	ros_log_info (const char *file, const char *function, int line, const char *text,...)
	Logs an informational message with formatted text to the ROS logger.
void	ros_log_debug (const char *file, const char *function, int line, const char *text,...)
	Logs a debug message with formatted text to the ROS logger.

Function Documentation

ros_log_debug()

void yasmin_ros::ros_log_debug	(	const char *	file,
		const char *	function,
		int	line,
		const char *	text,
			... )

Logs a debug message with formatted text to the ROS logger.

Parameters

file	The name of the source file where the log call is made.
function	The name of the function where the log call is made.
line	The line number in the source file where the log call is made.
text	The format string for the message to be logged, followed by any format arguments.

ros_log_error()

void yasmin_ros::ros_log_error	(	const char *	file,
		const char *	function,
		int	line,
		const char *	text,
			... )

Logs an error message with formatted text to the ROS logger.

Parameters

file	The name of the source file where the log call is made.
function	The name of the function where the log call is made.
line	The line number in the source file where the log call is made.
text	The format string for the message to be logged, followed by any format arguments.

ros_log_info()

void yasmin_ros::ros_log_info	(	const char *	file,
		const char *	function,
		int	line,
		const char *	text,
			... )

Logs an informational message with formatted text to the ROS logger.

Parameters

file	The name of the source file where the log call is made.
function	The name of the function where the log call is made.
line	The line number in the source file where the log call is made.
text	The format string for the message to be logged, followed by any format arguments.

ros_log_warn()

void yasmin_ros::ros_log_warn	(	const char *	file,
		const char *	function,
		int	line,
		const char *	text,
			... )

Logs a warning message with formatted text to the ROS logger.

Parameters

file	The name of the source file where the log call is made.
function	The name of the function where the log call is made.
line	The line number in the source file where the log call is made.
text	The format string for the message to be logged, followed by any format arguments.

set_ros_loggers()

void yasmin_ros::set_ros_loggers

(

)

Sets the logging functions for ROS, linking ROS 2 log levels to YASMIN loggers.

This function configures YASMIN to use ROS 2 logging mechanisms for error, warning, info, and debug levels, ensuring messages from YASMIN are routed through ROS 2 loggers.

Note

This function should be called once to set up the loggers before any logging occurs within YASMIN components.