Destination¶
struct nmeasim::core::model::Destination ยท Library API
The waypoint the vessel steers for.
#include <nmeasim/core/model/vessel_state.hpp>
Declared in src/core/include/nmeasim/core/model/vessel_state.hpp (line 181)
The autopilot sentences (APB, RMB, XTE) describe the leg from origin to position; the cross-track error is the distance of the vessel from that leg. The vessel does not steer towards it by itself.
See also
Summary¶
Public data members
| Name | Description |
|---|---|
name |
Waypoint identifier sent in the sentences. |
position |
Position of the waypoint, sent in RMB. |
origin |
Start of the leg, normally the vessel's position when the destination was set. |
arrival_radius_m |
Radius of the arrival circle around the destination; the arrival flags of APB and RMB are set once the vessel is within it. |
Public data members¶
name¶
std::string name{"WPT"}
Waypoint identifier sent in the sentences.
The encoders drop spaces, non-printable characters and NMEA reserved characters, keep at most kMaxWaypointNameLength characters and send WPT when nothing is left.
Declared in src/core/include/nmeasim/core/model/vessel_state.hpp:185
position¶
geo::Position position
Position of the waypoint, sent in RMB.
Declared in src/core/include/nmeasim/core/model/vessel_state.hpp:187
origin¶
geo::Position origin
Start of the leg, normally the vessel's position when the destination was set.
Declared in src/core/include/nmeasim/core/model/vessel_state.hpp:189
arrival_radius_m¶
double arrival_radius_m{100.0}
Radius of the arrival circle around the destination; the arrival flags of APB and RMB are set once the vessel is within it.
Declared in src/core/include/nmeasim/core/model/vessel_state.hpp:192