OpenCPN Partial API docs
Loading...
Searching...
No Matches
PlugIn_Position_Fix_Ex Class Reference

Extended position fix information. More...

#include <ocpn_plugin.h>

Public Attributes

double Lat
 Latitude in decimal degrees.
 
double Lon
 Longitude in decimal degrees.
 
double Cog
 Course over ground in degrees.
 
double Sog
 Speed over ground in knots.
 
double Var
 Magnetic variation in degrees, typically from RMC message.
 
double Hdm
 Heading magnetic in degrees.
 
double Hdt
 Heading true in degrees.
 
time_t FixTime
 UTC time of fix.
 
int nSats
 Number of satellites used in the fix.
 

Detailed Description

Extended position fix information.

This class provides position and navigation data that may come from various sources:

  • GNSS receiver (primary source)
  • Last known position (when GNSS signal is lost)
  • User-defined position (when manually moved on map)
  • Dead reckoning (calculated from last known position and movement)
Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 242 of file ocpn_plugin.h.

Member Data Documentation

◆ Cog

double PlugIn_Position_Fix_Ex::Cog

Course over ground in degrees.

Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 261 of file ocpn_plugin.h.

◆ FixTime

time_t PlugIn_Position_Fix_Ex::FixTime

UTC time of fix.

  • If GNSS available: Time from most recent GNSS message
  • If GNSS watchdog expired: Current system time
Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 290 of file ocpn_plugin.h.

◆ Hdm

double PlugIn_Position_Fix_Ex::Hdm

Heading magnetic in degrees.

May be NaN if heading sensor data is not available.

Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 276 of file ocpn_plugin.h.

◆ Hdt

double PlugIn_Position_Fix_Ex::Hdt

Heading true in degrees.

May be NaN if true heading cannot be calculated (requires both magnetic heading and variation).

Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 283 of file ocpn_plugin.h.

◆ Lat

double PlugIn_Position_Fix_Ex::Lat

Latitude in decimal degrees.

May represent last known position rather than current true position if:

  • GNSS signal is lost
  • Position has been manually set by user on map
Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 250 of file ocpn_plugin.h.

◆ Lon

double PlugIn_Position_Fix_Ex::Lon

Longitude in decimal degrees.

May represent last known position rather than current true position if:

  • GNSS signal is lost
  • Position has been manually set by user on map
Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 258 of file ocpn_plugin.h.

◆ nSats

int PlugIn_Position_Fix_Ex::nSats

Number of satellites used in the fix.

Will be 0 if:

  • GNSS watchdog has expired
  • Position is not from GNSS
Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 298 of file ocpn_plugin.h.

◆ Sog

double PlugIn_Position_Fix_Ex::Sog

Speed over ground in knots.

May be NaN if speed cannot be determined.

Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 267 of file ocpn_plugin.h.

◆ Var

double PlugIn_Position_Fix_Ex::Var

Magnetic variation in degrees, typically from RMC message.

Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 270 of file ocpn_plugin.h.


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