OpenCPN Partial API docs
Loading...
Searching...
No Matches
Public Attributes | List of all members
PlugIn_Route_Ex Class Reference

Extended route class for managing complex route features. More...

#include <ocpn_plugin.h>

Public Attributes

wxString m_NameString
 User-visible name of the route.
 
wxString m_StartString
 Description of route start point.
 
wxString m_EndString
 Description of route end point.
 
wxString m_GUID
 Globally unique identifier.
 
bool m_isActive
 True if this is the active route.
 
bool m_isVisible
 True if route should be displayed.
 
wxString m_Description
 Optional route description/notes.
 
Plugin_WaypointExList * pWaypointList
 List of waypoints making up this route in order.
 

Detailed Description

Extended route class for managing complex route features.

This class extends the basic route functionality to provide additional capabilities for managing routes with extended properties and waypoint collections.

Key features include:

  • Route naming and description
  • Start/end point labeling
  • Visibility control
  • Active route status
  • Extended waypoint list management
  • Global unique identification

Used when advanced route management capabilities are needed beyond the basic PlugIn_Route class.

Note
Requires OpenCPN API version 1.17 or later
Works with PlugIn_Waypoint_Ex for extended waypoint features
Used by navigation and routing plugins
Examples
/home/mk/src/OpenCPN/include/ocpn_plugin.h.

Definition at line 5157 of file ocpn_plugin.h.

Constructor & Destructor Documentation

◆ PlugIn_Route_Ex()

PlugIn_Route_Ex::PlugIn_Route_Ex ( void )

Definition at line 1881 of file ocpn_plugin_gui.cpp.

◆ ~PlugIn_Route_Ex()

PlugIn_Route_Ex::~PlugIn_Route_Ex ( void )

Definition at line 1885 of file ocpn_plugin_gui.cpp.

Member Data Documentation

◆ m_Description

wxString PlugIn_Route_Ex::m_Description

Optional route description/notes.

Definition at line 5168 of file ocpn_plugin.h.

◆ m_EndString

wxString PlugIn_Route_Ex::m_EndString

Description of route end point.

Definition at line 5164 of file ocpn_plugin.h.

◆ m_GUID

wxString PlugIn_Route_Ex::m_GUID

Globally unique identifier.

Definition at line 5165 of file ocpn_plugin.h.

◆ m_isActive

bool PlugIn_Route_Ex::m_isActive

True if this is the active route.

Definition at line 5166 of file ocpn_plugin.h.

◆ m_isVisible

bool PlugIn_Route_Ex::m_isVisible

True if route should be displayed.

Definition at line 5167 of file ocpn_plugin.h.

◆ m_NameString

wxString PlugIn_Route_Ex::m_NameString

User-visible name of the route.

Definition at line 5162 of file ocpn_plugin.h.

◆ m_StartString

wxString PlugIn_Route_Ex::m_StartString

Description of route start point.

Definition at line 5163 of file ocpn_plugin.h.

◆ pWaypointList

Plugin_WaypointExList* PlugIn_Route_Ex::pWaypointList

List of waypoints making up this route in order.

First point is start, last point is end. Uses PlugIn_Waypoint_Ex for extended waypoint features.

Definition at line 5175 of file ocpn_plugin.h.

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