Skip to main content

PlatformStorageDataMessage Struct

Message for reporting platform storage data (MessageType::PLATFORM_STORAGE_DATA, version 1). More...

Declaration​

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

Included Headers​

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

Public Member Attributes Index​

uint32_tdata_length_bytes = 0

Number of bytes in data contents. More...

DataTypedata_type = DataType::INVALID

The type of data contained in this message. More...

DataVersiondata_version

Version of data contents. More...

uint8_tflags = 0

DataType specific flags. More...

Responseresponse = Response::OK

The status of the specified data type on the device. More...

ConfigurationSourcesource = ConfigurationSource::ACTIVE

The source this data was copied from. More...

Public Static Attributes Index​

static constexpr uint8_tFLAG_USER_CONFIG_PLATFORM_EMBEDDED = 2

DataType::USER_CONFIG flag for embedded platforms. More...

static constexpr uint8_tFLAG_USER_CONFIG_PLATFORM_EMBEDDED_SSR = 3

DataType::USER_CONFIG flag for embedded SSR platforms. More...

static constexpr uint8_tFLAG_USER_CONFIG_PLATFORM_NOT_SPECIFIED = 0

DataType::USER_CONFIG flag field is not set. More...

static constexpr uint8_tFLAG_USER_CONFIG_PLATFORM_POSIX = 1

DataType::USER_CONFIG flag for POSIX platforms. More...

static constexpr uint8_tFLAG_USER_CONFIG_SSR_CLIENT = 254

DataType::USER_CONFIG flag for the SSR client library. More...

static constexpr MessageTypeMESSAGE_TYPE = ...
static constexpr uint8_tMESSAGE_VERSION = 3

Description​

Message for reporting platform storage data (MessageType::PLATFORM_STORAGE_DATA, version 1).

This message will be followed by data_length_bytes bytes containing the data storage contents:

 {MessageHeader, PlatformStorageDataMessage, Payload[data_length_bytes]}

See also ExportDataMessage.

Changes:

  • Version 1: Added data_validity field.
  • Version 2: Changed data_validity to a Response enum and added source field.
  • Version 3: Added flags field.

Definition at line 1471 of file configuration.h.

Public Member Attributes​

data_length_bytes​

uint32_t point_one::fusion_engine::messages::PlatformStorageDataMessage::data_length_bytes = 0

Number of bytes in data contents.

Definition at line 1514 of file configuration.h.

1514 uint32_t data_length_bytes = 0;

data_type​

DataType point_one::fusion_engine::messages::PlatformStorageDataMessage::data_type = DataType::INVALID

The type of data contained in this message.

Definition at line 1490 of file configuration.h.

1490 DataType data_type = DataType::INVALID;

data_version​

DataVersion point_one::fusion_engine::messages::PlatformStorageDataMessage::data_version

Version of data contents.

Definition at line 1512 of file configuration.h.

1512 DataVersion data_version;

flags​

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

DataType specific flags.

Currently, only defined for DataType::USER_CONFIG contents. This value can optionally set to one of the FLAG_USER_CONFIG_PLATFORM_* values to indicate which type of platform the UserConfig is valid for. This value can be left at 0 for backwards compatibility or to indicate the platform type is unknown.

Definition at line 1510 of file configuration.h.

1510 uint8_t flags = 0;

response​

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

The status of the specified data type on the device.

Definition at line 1494 of file configuration.h.

1494 Response response = Response::OK;

source​

ConfigurationSource point_one::fusion_engine::messages::PlatformStorageDataMessage::source = ConfigurationSource::ACTIVE

The source this data was copied from.

If the data_type doesn't separate active and saved data, this will be set to ConfigurationSource::ACTIVE.

Definition at line 1500 of file configuration.h.

1500 ConfigurationSource source = ConfigurationSource::ACTIVE;

Public Static Attributes​

FLAG_USER_CONFIG_PLATFORM_EMBEDDED​

constexpr uint8_t point_one::fusion_engine::messages::PlatformStorageDataMessage::FLAG_USER_CONFIG_PLATFORM_EMBEDDED = 2
 constexpr static

DataType::USER_CONFIG flag for embedded platforms.

Definition at line 1481 of file configuration.h.

1481 static constexpr uint8_t FLAG_USER_CONFIG_PLATFORM_EMBEDDED = 2;

FLAG_USER_CONFIG_PLATFORM_EMBEDDED_SSR​

constexpr uint8_t point_one::fusion_engine::messages::PlatformStorageDataMessage::FLAG_USER_CONFIG_PLATFORM_EMBEDDED_SSR = 3
 constexpr static

DataType::USER_CONFIG flag for embedded SSR platforms.

Definition at line 1483 of file configuration.h.

1483 static constexpr uint8_t FLAG_USER_CONFIG_PLATFORM_EMBEDDED_SSR = 3;

FLAG_USER_CONFIG_PLATFORM_NOT_SPECIFIED​

constexpr uint8_t point_one::fusion_engine::messages::PlatformStorageDataMessage::FLAG_USER_CONFIG_PLATFORM_NOT_SPECIFIED = 0
 constexpr static

DataType::USER_CONFIG flag field is not set.

Definition at line 1477 of file configuration.h.

1477 static constexpr uint8_t FLAG_USER_CONFIG_PLATFORM_NOT_SPECIFIED = 0;

FLAG_USER_CONFIG_PLATFORM_POSIX​

constexpr uint8_t point_one::fusion_engine::messages::PlatformStorageDataMessage::FLAG_USER_CONFIG_PLATFORM_POSIX = 1
 constexpr static

DataType::USER_CONFIG flag for POSIX platforms.

Definition at line 1479 of file configuration.h.

1479 static constexpr uint8_t FLAG_USER_CONFIG_PLATFORM_POSIX = 1;

FLAG_USER_CONFIG_SSR_CLIENT​

constexpr uint8_t point_one::fusion_engine::messages::PlatformStorageDataMessage::FLAG_USER_CONFIG_SSR_CLIENT = 254
 constexpr static

DataType::USER_CONFIG flag for the SSR client library.

Definition at line 1485 of file configuration.h.

1485 static constexpr uint8_t FLAG_USER_CONFIG_SSR_CLIENT = 254;

MESSAGE_TYPE​

constexpr MessageType point_one::fusion_engine::messages::PlatformStorageDataMessage::MESSAGE_TYPE
 constexpr static
Initialiser
= MessageType::PLATFORM_STORAGE_DATA

Definition at line 1472 of file configuration.h.

1472 static constexpr MessageType MESSAGE_TYPE =

MESSAGE_VERSION​

constexpr uint8_t point_one::fusion_engine::messages::PlatformStorageDataMessage::MESSAGE_VERSION = 3
 constexpr static

Definition at line 1474 of file configuration.h.

1474 static constexpr uint8_t MESSAGE_VERSION = 3;

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

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.