SentenceDescriptor¶

struct nmeasim::core::nmea0183::SentenceDescriptor · Library API

Static description of one sentence: its identity, its defaults and the encoder that produces it.

#include <nmeasim/core/nmea0183/registry.hpp>

Declared in src/core/include/nmeasim/core/nmea0183/registry.hpp (line 63)

The string views of the descriptors in SentenceRegistry::standard refer to string literals and stay valid for the whole program.

Summary¶

Public data members

Name	Description
`id`	Unique key used in the profile and on the command line, for example `"RMC"` or `"MWV-T"`.
`formatter`	Three-character sentence formatter, for example `"RMC"`.
`default_talker`	Two-character talker identifier used unless the profile sets another.
`group`	Functional group the sentence is enabled or disabled with.
`default_period`	Interval between two emissions unless the profile sets another; positive.
`enabled_by_default`	Whether the sentence is sent when the profile does not mention it.
`description`	One-line summary of the sentence contents, shown in the interface and by the command-line tool.
`encoder`	Function that produces the sentences for one emission from a vessel state; never null in the standard registry.

std::string_view id

Unique key used in the profile and on the command line, for example "RMC" or "MWV-T".

It is the formatter, with a suffix when one formatter has several variants.

std::string_view formatter

Three-character sentence formatter, for example "RMC".

std::string_view default_talker

Two-character talker identifier used unless the profile sets another.

SentenceGroup group

Functional group the sentence is enabled or disabled with.

std::chrono::milliseconds default_period

Interval between two emissions unless the profile sets another; positive.

bool enabled_by_default

Whether the sentence is sent when the profile does not mention it.

std::string_view description

One-line summary of the sentence contents, shown in the interface and by the command-line tool.

Encoder encoder

Function that produces the sentences for one emission from a vessel state; never null in the standard registry.