yasmin_ros::basic_outcomes Namespace Reference

Provides common outcome constants for ROS 2. More...

Variables
constexpr char	SUCCEED [] = "succeeded"
	Constant representing a successful action outcome.
constexpr char	ABORT [] = "aborted"
	Constant representing an aborted action outcome.
constexpr char	FAIL [] = "failed"
	Constant representing a failed action outcome.
constexpr char	CANCEL [] = "canceled"
	Constant representing a canceled action outcome.
constexpr char	TIMEOUT [] = "timeout"
	Constant representing a timed-out action outcome.
constexpr char	RETRY [] = "retry"
	Constant representing a timed-out action outcome.

Detailed Description

Provides common outcome constants for ROS 2.

The basic_outcomes namespace defines constants for common action outcomes within the yasmin_ros framework. These constants represent the status of actions or tasks, making it easier to standardize result handling.

Variable Documentation

ABORT

char yasmin_ros::basic_outcomes::ABORT[] = "aborted"

constexpr

Constant representing an aborted action outcome.

This string constant signifies that an action was aborted, likely due to an error or unexpected condition that prevented its completion.

CANCEL

char yasmin_ros::basic_outcomes::CANCEL[] = "canceled"

constexpr

Constant representing a canceled action outcome.

This string constant is used when an action is manually canceled by a user or system before it could complete.

FAIL

char yasmin_ros::basic_outcomes::FAIL[] = "failed"

constexpr

Constant representing a failed action outcome.

This string constant is used to indicate that an action has completed but resulted in failure, meaning it did not achieve its intended result.

RETRY

char yasmin_ros::basic_outcomes::RETRY[] = "retry"

constexpr

Constant representing a timed-out action outcome.

This string constant is used to indicate that an action did not complete within the allocated time, resulting in a timeout status.

SUCCEED

char yasmin_ros::basic_outcomes::SUCCEED[] = "succeeded"

constexpr

Constant representing a successful action outcome.

This string constant is used to indicate that an action has successfully completed without any issues.

TIMEOUT

char yasmin_ros::basic_outcomes::TIMEOUT[] = "timeout"

constexpr

Constant representing a timed-out action outcome.

This string constant is used to indicate that an action did not complete within the allocated time, resulting in a timeout status.