creos_messages::UserEvent Struct Reference

An event meant for a robot user. More...

#include <creos/messages/user_event.hpp>

Public Types
enum class	Severity {   kTrace , kInfo , kWarn , kError ,   kFatal }
	The severity of an event This information can be used to filter events based on their importance to the user. More...
enum class	DisplayMethod { kLog , kNotification }
	The (suggested) method to display the message to the user. This information can be used to determine how to display the message to the user. Internal robot systems can suggest how an event should be shown to the user, either as a log message or as a notification. More...

Public Attributes
creos::RobotClock::time_point	time
	The moment in time when the event was generated.
Severity	severity = Severity::kInfo
	The severity of the event.
DisplayMethod	display_method = DisplayMethod::kLog
	The method to display the event to the user.
std::string	source_id
	The id of the source that generated the event.
std::string	message
	The message to display to the user.
std::string	component
	The name of the component that generated the event.

Detailed Description

An event meant for a robot user.

Member Enumeration Documentation

DisplayMethod

enum class creos_messages::UserEvent::DisplayMethod

strong

The (suggested) method to display the message to the user. This information can be used to determine how to display the message to the user. Internal robot systems can suggest how an event should be shown to the user, either as a log message or as a notification.

Enumerator
kLog	The message should be logged.
kNotification	The message should be displayed as a notification.

Severity

enum class creos_messages::UserEvent::Severity

strong

The severity of an event This information can be used to filter events based on their importance to the user.

Enumerator
kTrace	A trace message, used for debugging purposes.
kInfo	An informational message.
kWarn	A warning message.
kError	An error message.
kFatal	A fatal error message.

---

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

• creos_msgs/include/creos/messages/user_event.hpp