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

Information about the currently active route leg. More...

#include <ocpn_plugin.h>

Public Attributes

double Xte
double Btw
 Bearing to waypoint in degrees true.
double Dtw
 Distance to waypoint in nautical miles.
wxString wp_name
 Name of destination waypoint for the active leg.
bool arrival

Detailed Description

Information about the currently active route leg.

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

Definition at line 365 of file ocpn_plugin.h.

Member Data Documentation

◆ arrival

bool Plugin_Active_Leg_Info::arrival

True when vessel is within the arrival circle of the destination waypoint

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

Definition at line 372 of file ocpn_plugin.h.

◆ Btw

double Plugin_Active_Leg_Info::Btw

Bearing to waypoint in degrees true.

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

Definition at line 369 of file ocpn_plugin.h.

◆ Dtw

double Plugin_Active_Leg_Info::Dtw

Distance to waypoint in nautical miles.

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

Definition at line 370 of file ocpn_plugin.h.

◆ wp_name

wxString Plugin_Active_Leg_Info::wp_name

Name of destination waypoint for the active leg.

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

Definition at line 371 of file ocpn_plugin.h.

◆ Xte

double Plugin_Active_Leg_Info::Xte

Cross track error in nautical miles, negative values indicate left side of track

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

Definition at line 367 of file ocpn_plugin.h.


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