nmeasim::core::model¶
namespace nmeasim::core::model ยท Library API
The simulated vessel and its environment at one instant, part of the nmeasim::core library.
Every quantity is stored in the unit named by its suffix: angles in degrees, speeds in knots, lengths in metres, temperatures in degrees Celsius. Angles are true unless the name says magnetic. A simulation source advances the state on every tick; encoders only read it. The types are plain aggregates that validate nothing: the sources keep the values in the documented ranges and the encoders clamp where a protocol field demands it.
Types¶
| Type | Description |
|---|---|
GnssFix |
State of the GNSS receiver: fix, satellites and dilution of precision. |
Navigation |
Position, motion and heading of the vessel. |
Steering |
Steering gear state. |
Water |
Depth sounder and water temperature readings. |
Wind |
True and apparent wind measured on board. |
Engine |
One propulsion engine. |
Destination |
The waypoint the vessel steers for. |
AisStatic |
Static data of the own vessel for the AIS messages, plus the message options. |
VesselState |
Complete snapshot of the vessel that every encoder reads. |
Summary¶
Enumerations
| Name | Description |
|---|---|
FixQuality |
Quality of the GNSS solution; the enumerator values are the GGA fix quality codes. |
Variables
| Name | Description |
|---|---|
kMaxWaypointNameLength |
Longest waypoint identifier, in characters, that the encoders send; longer names are truncated. |
Enumerations¶
FixQuality¶
enum class FixQuality
Quality of the GNSS solution; the enumerator values are the GGA fix quality codes.
| Enumerator | Value | Description |
|---|---|---|
Invalid |
0 |
No valid fix, sent as GGA quality 0. |
Gps |
1 |
Autonomous GNSS fix, sent as GGA quality 1. |
Differential |
2 |
Differential fix, sent as GGA quality 2. |
See also
- NMEA 0183, sentence GGA, field "GPS quality indicator".
Declared in src/core/include/nmeasim/core/model/vessel_state.hpp:33
Variables¶
kMaxWaypointNameLength¶
std::size_t kMaxWaypointNameLength{16}
Longest waypoint identifier, in characters, that the encoders send; longer names are truncated.
Declared in src/core/include/nmeasim/core/model/vessel_state.hpp:197