GetMessageRate Struct

Get the configured output rate for the he requested message type on the specified interface (MessageType::GET_MESSAGE_RATE, version 1). More...

Declaration

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

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

uint16_t	message_id = ALL_MESSAGES_ID
	The ID of the desired message type (e.g., 10000 for FusionEngine MessageType::POSE messages). More...
InterfaceID	output_interface {TransportType::CURRENT}
	The output interface to be queried. More...
ProtocolType	protocol = ProtocolType::INVALID
	The desired message protocol. More...
ConfigurationSource	request_source = ConfigurationSource::ACTIVE
	The source of the parameter value (active, saved, etc.). More...

Public Static Attributes Index

static constexpr MessageType	MESSAGE_TYPE = MessageType::GET_MESSAGE_RATE
static constexpr uint8_t	MESSAGE_VERSION = 0

Description

Get the configured output rate for the he requested message type on the specified interface (MessageType::GET_MESSAGE_RATE, version 1).

Multiple message rates can be requested with a single command if wild cards are used for the protocol, or message ID.

Expected Response

The device will respond with a MessageRateResponse containing the requested values or an error Response value if the request did not succeed.

Definition at line 2440 of file configuration.h.

Public Member Attributes

message_id

uint16_t point_one::fusion_engine::messages::GetMessageRate::message_id = ALL_MESSAGES_ID

The ID of the desired message type (e.g., 10000 for FusionEngine MessageType::POSE messages).

See NmeaMessageType for NMEA-0183 messages. If ALL_MESSAGES_ID, return the current settings for all supported messages on the selected interface and protocol.

Definition at line 2467 of file configuration.h.

2467 uint16_t message_id = ALL_MESSAGES_ID;

output_interface

InterfaceID point_one::fusion_engine::messages::GetMessageRate::output_interface {TransportType::CURRENT}

The output interface to be queried.

TransportType::ALL is not supported. To query for multiple transports, send separate requests.

Definition at line 2450 of file configuration.h.

2450 InterfaceID output_interface{TransportType::CURRENT};

protocol

ProtocolType point_one::fusion_engine::messages::GetMessageRate::protocol = ProtocolType::INVALID

The desired message protocol.

If ProtocolType::ALL, return the current settings for all supported protocols.

Definition at line 2456 of file configuration.h.

2456 ProtocolType protocol = ProtocolType::INVALID;

request_source

ConfigurationSource point_one::fusion_engine::messages::GetMessageRate::request_source = ConfigurationSource::ACTIVE

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

Definition at line 2459 of file configuration.h.

2459 ConfigurationSource request_source = ConfigurationSource::ACTIVE;

Public Static Attributes

MESSAGE_TYPE

constexpr MessageType point_one::fusion_engine::messages::GetMessageRate::MESSAGE_TYPE = MessageType::GET_MESSAGE_RATE

constexpr static

Definition at line 2441 of file configuration.h.

2441 static constexpr MessageType MESSAGE_TYPE = MessageType::GET_MESSAGE_RATE;

MESSAGE_VERSION

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

constexpr static

Definition at line 2442 of file configuration.h.

2442 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.