point_one::fusion_engine::messages::ShutdownRequest Struct Reference

Detailed Description

Perform a device shutdown (MessageType::SHUTDOWN_REQUEST, version 1.0).

Expected Response

The device will respond with a CommandResponseMessage indicating whether or not the request succeeded.

Definition at line 334 of file control.h.

Inheritance diagram for point_one::fusion_engine::messages::ShutdownRequest:

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

Public Attributes
uint64_t	shutdown_flags = 0
	A bitmask of flags associated with the event. More...

Static Public Attributes
static constexpr MessageType	MESSAGE_TYPE = MessageType::SHUTDOWN_REQUEST
static constexpr uint8_t	MESSAGE_VERSION = 0
static constexpr uint64_t	STOP_CURRENT_LOG = 0x0000000000000002
	If a log is being generated, end that log. More...
static constexpr uint64_t	STOP_ENGINE = 0x0000000000000001
	Stop navigation engine and flush state to non-volatile storage. More...

Member Data Documentation

MESSAGE_TYPE

constexpr MessageType point_one::fusion_engine::messages::ShutdownRequest::MESSAGE_TYPE = MessageType::SHUTDOWN_REQUEST

staticconstexpr

Definition at line 335 of file control.h.

MESSAGE_VERSION

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

staticconstexpr

Definition at line 336 of file control.h.

shutdown_flags

uint64_t point_one::fusion_engine::messages::ShutdownRequest::shutdown_flags = 0

A bitmask of flags associated with the event.

Note

For backwards compatibility, a value of 0 is treated as if the STOP_ENGINE bit is set (0x0000000000000001).

Definition at line 353 of file control.h.

STOP_CURRENT_LOG

constexpr uint64_t point_one::fusion_engine::messages::ShutdownRequest::STOP_CURRENT_LOG = 0x0000000000000002

staticconstexpr

If a log is being generated, end that log.

Definition at line 345 of file control.h.

STOP_ENGINE

constexpr uint64_t point_one::fusion_engine::messages::ShutdownRequest::STOP_ENGINE = 0x0000000000000001

staticconstexpr

Stop navigation engine and flush state to non-volatile storage.

Definition at line 341 of file control.h.

---

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

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