Goby3  3.1.5a
2024.05.23
goby::middleware::MAVLinkRegistry Struct Reference

A registry of mavlink types used for decoding. More...

#include <goby/middleware/marshalling/mavlink.h>

Static Public Member Functions

template<std::size_t Size>
static void register_dialect_entries (std::array< mavlink::mavlink_msg_entry_t, Size > entries)
 Register a new Mavlink dialect. More...
 
static const mavlink::mavlink_msg_entry_t * get_msg_entry (uint32_t msgid)
 Retrieve a entry given a message id. More...
 
static void register_default_dialects ()
 

Detailed Description

A registry of mavlink types used for decoding.

You should register the MESSAGE_ENTRIES for the dialect(s) you're using with this registry, if other than common and minimal. Parsing and serialization will still work if you don't, but you will get CRC errors for the unknown types.

Definition at line 52 of file mavlink.h.

Member Function Documentation

◆ get_msg_entry()

static const mavlink::mavlink_msg_entry_t* goby::middleware::MAVLinkRegistry::get_msg_entry ( uint32_t  msgid)
inlinestatic

Retrieve a entry given a message id.

Parameters
msgidMavlink message id to look up
Returns
The mavlink_msg_entry_t for the given msgid or nullptr if the msgid isn't loaded.

Definition at line 68 of file mavlink.h.

◆ register_default_dialects()

static void goby::middleware::MAVLinkRegistry::register_default_dialects ( )
static

◆ register_dialect_entries()

template<std::size_t Size>
static void goby::middleware::MAVLinkRegistry::register_dialect_entries ( std::array< mavlink::mavlink_msg_entry_t, Size >  entries)
inlinestatic

Register a new Mavlink dialect.

Parameters
entriesMavlink autogenerated MESSAGE_ENTRIES, i.e. mavlink::my_dialect::MESSAGE_ENTRIES

Definition at line 58 of file mavlink.h.


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