VesselState¶

struct nmeasim::core::model::VesselState · Library API

Complete snapshot of the vessel that every encoder reads.

#include <nmeasim/core/model/vessel_state.hpp>

Declared in src/core/include/nmeasim/core/model/vessel_state.hpp (line 245)

A default-constructed state describes a vessel at 0 degrees north, 0 degrees east at the Unix epoch, with a GPS fix, no engines and no destination; a profile seed normally replaces it.

Summary¶

Public data members

Name	Description
`time_utc`	Simulation time in UTC, sent in the time and date fields; the Unix epoch by default.
`navigation`	`Position`, motion and heading.
`gnss`	GNSS receiver state.
`steering`	Rudder state.
`water`	Depth and water temperature.
`wind`	True and apparent wind.
`engines`	Engines in profile order; empty when the vessel reports no propulsion, in which case RPM and XDR send nothing.
`destination`	The active waypoint, or `std::nullopt` when none is set; without one no autopilot sentence and no Signal K course path is sent.
`ais`	Own-vessel AIS static data and message options.

Public data members¶

time_utc¶

std::chrono::system_clock::time_point time_utc{}

Simulation time in UTC, sent in the time and date fields; the Unix epoch by default.

Declared in src/core/include/nmeasim/core/model/vessel_state.hpp:247

Navigation navigation

Position, motion and heading.

Declared in src/core/include/nmeasim/core/model/vessel_state.hpp:249

gnss¶

GnssFix gnss

GNSS receiver state.

Declared in src/core/include/nmeasim/core/model/vessel_state.hpp:251

steering¶

Steering steering

Rudder state.

Declared in src/core/include/nmeasim/core/model/vessel_state.hpp:253

water¶

Water water

Depth and water temperature.

Declared in src/core/include/nmeasim/core/model/vessel_state.hpp:255

wind¶

Wind wind

True and apparent wind.

Declared in src/core/include/nmeasim/core/model/vessel_state.hpp:257

engines¶

std::vector<Engine> engines

Engines in profile order; empty when the vessel reports no propulsion, in which case RPM and XDR send nothing.

Declared in src/core/include/nmeasim/core/model/vessel_state.hpp:260

destination¶

std::optional<Destination> destination

The active waypoint, or std::nullopt when none is set; without one no autopilot sentence and no Signal K course path is sent.

Declared in src/core/include/nmeasim/core/model/vessel_state.hpp:263

ais¶

AisStatic ais

Own-vessel AIS static data and message options.

Declared in src/core/include/nmeasim/core/model/vessel_state.hpp:265