ConfigResponseMessage Struct

Response to a GetConfigMessage request (MessageType::CONFIG_RESPONSE, version 1). More...

Declaration

struct point_one::fusion_engine::messages::ConfigResponseMessage { ... }

Included Headers

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

Base struct

struct	MessagePayload
	The base class for all message payloads. More...

Public Member Attributes Index

uint32_t	config_length_bytes = 0
	The size of the parameter value (in bytes). More...
ConfigurationSource	config_source = ConfigurationSource::ACTIVE
	The source of the parameter value (active, saved, etc.). More...
ConfigType	config_type = ConfigType::INVALID
	The type of configuration parameter contained in this message. More...
uint8_t	flags = 0
	Flags that describe the configuration parameter. More...
Response	response = Response::OK
	The response status (success, error, etc.). More...

Public Static Attributes Index

static constexpr uint8_t	FLAG_ACTIVE_DIFFERS_FROM_SAVED = 0x1
	Flag to indicate the active value for this configuration differs from the value saved to persistent memory. More...
static constexpr MessageType	MESSAGE_TYPE = MessageType::CONFIG_RESPONSE
static constexpr uint8_t	MESSAGE_VERSION = 0

Description

Response to a GetConfigMessage request (MessageType::CONFIG_RESPONSE, version 1).

This message is followed by N bytes, where N is equal to config_length_bytes that make up the data associated with config_type. For example if the config_type is ConfigType::UART1_BAUD, the payload will include a single 32-bit unsigned integer:

 {MessageHeader, ConfigResponseMessage, uint32_t}

The response field will indicate the status of the requested value. If the response is not Response::OK, the parameter value may be omitted and config_length_bytes will be set to 0.

In response to a GetConfigMessage with an invalid or unsupported ConfigType, config_type in the resulting ConfigResponseMessage will be set to ConfigType::INVALID, and response will indicate the reason. Note that all GetConfigMessage requests, including invalid and rejected requests, will receive a ConfigResponseMessage, not a CommandResponseMessage.

Definition at line 598 of file configuration.h.

Public Member Attributes

config_length_bytes

uint32_t point_one::fusion_engine::messages::ConfigResponseMessage::config_length_bytes = 0

The size of the parameter value (in bytes).

Definition at line 623 of file configuration.h.

623 uint32_t config_length_bytes = 0;

config_source

ConfigurationSource point_one::fusion_engine::messages::ConfigResponseMessage::config_source = ConfigurationSource::ACTIVE

The source of the parameter value (active, saved, etc.).

Definition at line 609 of file configuration.h.

609 ConfigurationSource config_source = ConfigurationSource::ACTIVE;

config_type

ConfigType point_one::fusion_engine::messages::ConfigResponseMessage::config_type = ConfigType::INVALID

The type of configuration parameter contained in this message.

Definition at line 615 of file configuration.h.

615 ConfigType config_type = ConfigType::INVALID;

flags

uint8_t point_one::fusion_engine::messages::ConfigResponseMessage::flags = 0

Flags that describe the configuration parameter.

Definition at line 612 of file configuration.h.

612 uint8_t flags = 0;

response

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

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

Definition at line 618 of file configuration.h.

618 Response response = Response::OK;

Public Static Attributes

FLAG_ACTIVE_DIFFERS_FROM_SAVED

constexpr uint8_t point_one::fusion_engine::messages::ConfigResponseMessage::FLAG_ACTIVE_DIFFERS_FROM_SAVED = 0x1

constexpr static

Flag to indicate the active value for this configuration differs from the value saved to persistent memory.

Definition at line 606 of file configuration.h.

606 static constexpr uint8_t FLAG_ACTIVE_DIFFERS_FROM_SAVED = 0x1;

MESSAGE_TYPE

constexpr MessageType point_one::fusion_engine::messages::ConfigResponseMessage::MESSAGE_TYPE = MessageType::CONFIG_RESPONSE

constexpr static

Definition at line 599 of file configuration.h.

599 static constexpr MessageType MESSAGE_TYPE = MessageType::CONFIG_RESPONSE;

MESSAGE_VERSION

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

constexpr static

Definition at line 600 of file configuration.h.

600 static constexpr uint8_t MESSAGE_VERSION = 0;

---

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

• configuration.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.