point_one::fusion_engine::messages::EventNotificationMessage Struct Reference

Notification of a system event for logging purposes (MessageType::EVENT_NOTIFICATION, version 1.0). More...

#include <point_one/fusion_engine/messages/control.h>

Inheritance diagram for point_one::fusion_engine::messages::EventNotificationMessage:

Public Types
enum	EventType : uint8_t { EventType::LOG = 0, EventType::RESET = 1, EventType::CONFIG_CHANGE = 2 }

Static Public Member Functions
static const char *	to_string (EventType type)

Public Attributes
char *	event_description [0]
	This is a dummy entry to provide a pointer to this offset. More...
uint16_t	event_description_len_bytes = 0
	The number of bytes in the event_description string. More...
uint64_t	event_flags = 0
	A bitmask of flags associated with the event. More...
int64_t	system_time_ns = 0
	The current system timestamp (in ns). More...
EventType	type = EventType::LOG
	The type of event that occurred. More...

Static Public Attributes
static constexpr MessageType	MESSAGE_TYPE = MessageType::EVENT_NOTIFICATION
static constexpr uint8_t	MESSAGE_VERSION = 0

Detailed Description

Notification of a system event for logging purposes (MessageType::EVENT_NOTIFICATION, version 1.0).

Definition at line 315 of file control.h.

Member Enumeration Documentation

EventType

enum point_one::fusion_engine::messages::EventNotificationMessage::EventType : uint8_t

strong

Enumerator
LOG
RESET
CONFIG_CHANGE

Definition at line 316 of file control.h.

Member Function Documentation

to_string()

static const char* point_one::fusion_engine::messages::EventNotificationMessage::to_string ( EventType  type )

inlinestatic

Definition at line 322 of file control.h.

Member Data Documentation

event_description

char* point_one::fusion_engine::messages::EventNotificationMessage::event_description[0]

This is a dummy entry to provide a pointer to this offset.

This is used for populating string describing the event, where applicable.

Definition at line 362 of file control.h.

event_description_len_bytes

uint16_t point_one::fusion_engine::messages::EventNotificationMessage::event_description_len_bytes = 0

The number of bytes in the event_description string.

Definition at line 353 of file control.h.

event_flags

uint64_t point_one::fusion_engine::messages::EventNotificationMessage::event_flags = 0

A bitmask of flags associated with the event.

Definition at line 350 of file control.h.

MESSAGE_TYPE

constexpr MessageType point_one::fusion_engine::messages::EventNotificationMessage::MESSAGE_TYPE = MessageType::EVENT_NOTIFICATION

staticconstexpr

Definition at line 338 of file control.h.

MESSAGE_VERSION

constexpr uint8_t point_one::fusion_engine::messages::EventNotificationMessage::MESSAGE_VERSION = 0

staticconstexpr

Definition at line 339 of file control.h.

system_time_ns

int64_t point_one::fusion_engine::messages::EventNotificationMessage::system_time_ns = 0

The current system timestamp (in ns).

Definition at line 347 of file control.h.

type

EventType point_one::fusion_engine::messages::EventNotificationMessage::type = EventType::LOG

The type of event that occurred.

Definition at line 342 of file control.h.

---

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

• src/point_one/fusion_engine/messages/control.h