point_one::fusion_engine::messages::CommandResponseMessage Struct Reference

Response to indicate if command was processed successfully (MessageType::COMMAND_RESPONSE, version 1.0). More...

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

Inheritance diagram for point_one::fusion_engine::messages::CommandResponseMessage:

Public Types
enum	Response : uint8_t {   Response::OK = 0, Response::UNSUPPORTED_CMD_VERSION = 1, Response::UNSUPPORTED_FEATURE = 2, Response::VALUE_ERROR = 3,   Response::INSUFFICIENT_SPACE = 4, Response::EXECUTION_FAILURE = 5 }
	Command response status indicators. More...

Public Attributes
Response	response = Response::OK
	The response status (success, error, etc.). More...
uint32_t	source_seq_number = 0
	The sequence number of the command that triggered this response. More...

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

Detailed Description

Response to indicate if command was processed successfully (MessageType::COMMAND_RESPONSE, version 1.0).

Definition at line 50 of file control.h.

Member Enumeration Documentation

Response

enum point_one::fusion_engine::messages::CommandResponseMessage::Response : uint8_t

strong

Command response status indicators.

Enumerator
OK
UNSUPPORTED_CMD_VERSION	A version specified in the command or subcommand could not be handled. This could mean that the version was too new, or it was old and there was not a translation for it.
UNSUPPORTED_FEATURE	The command interacts with a feature that is not present on the target device (e.g., Setting the baud rate on a device without a serial port).
VALUE_ERROR	One or more values in the command were not in acceptable ranges (e.g., An undefined enum value, or an invalid baud rate).
INSUFFICIENT_SPACE	The command would require adding too many elements to an internal storage.
EXECUTION_FAILURE	There was a runtime failure executing the command.

Definition at line 52 of file control.h.

Member Data Documentation

MESSAGE_TYPE

constexpr MessageType point_one::fusion_engine::messages::CommandResponseMessage::MESSAGE_TYPE = MessageType::COMMAND_RESPONSE

staticconstexpr

Definition at line 81 of file control.h.

MESSAGE_VERSION

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

staticconstexpr

Definition at line 82 of file control.h.

response

Response point_one::fusion_engine::messages::CommandResponseMessage::response = Response::OK

The response status (success, error, etc.).

Definition at line 88 of file control.h.

source_seq_number

uint32_t point_one::fusion_engine::messages::CommandResponseMessage::source_seq_number = 0

The sequence number of the command that triggered this response.

Definition at line 85 of file control.h.

---

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

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