Routeman Class Reference

Public Member Functions
	Routeman (struct RoutePropDlgCtx prop_dlg_ctx, struct RoutemanDlgCtx route_dlg_ctx, NmeaLog &nmea_log)
bool	DeleteTrack (Track *pTrack)
bool	DeleteRoute (Route *pRoute, NavObjectChanges *nav_obj_changes)
void	DeleteAllRoutes (NavObjectChanges *nav_obj_changes)
bool	IsRouteValid (Route *pRoute)
Route *	FindRouteByGUID (const wxString &guid)
Track *	FindTrackByGUID (const wxString &guid)
Route *	FindRouteContainingWaypoint (RoutePoint *pWP)
Route *	FindVisibleRouteContainingWaypoint (RoutePoint *pWP)
wxArrayPtrVoid *	GetRouteArrayContaining (RoutePoint *pWP)
bool	DoesRouteContainSharedPoints (Route *pRoute)
void	RemovePointFromRoute (RoutePoint *point, Route *route, int route_state)
bool	ActivateRoute (Route *pRouteToActivate, RoutePoint *pStartPoint=NULL)
bool	ActivateRoutePoint (Route *pA, RoutePoint *pRP)
bool	ActivateNextPoint (Route *pr, bool skipped)
RoutePoint *	FindBestActivatePoint (Route *pR, double lat, double lon, double cog, double sog)
bool	UpdateAutopilot ()
bool	DeactivateRoute (bool b_arrival=false)
bool	IsAnyRouteActive (void)
Route *	GetpActiveRoute ()
RoutePoint *	GetpActivePoint ()
double	GetCurrentRngToActivePoint ()
double	GetCurrentBrgToActivePoint ()
double	GetCurrentRngToActiveNormalArrival ()
double	GetCurrentXTEToActivePoint ()
void	ZeroCurrentXTEToActivePoint ()
double	GetCurrentSegmentCourse ()
int	GetXTEDir ()
void	SetColorScheme (ColorScheme cs, double displayDPmm)
wxPen *	GetRoutePen (void)
wxPen *	GetTrackPen (void)
wxPen *	GetSelectedRoutePen (void)
wxPen *	GetActiveRoutePen (void)
wxPen *	GetActiveRoutePointPen (void)
wxPen *	GetRoutePointPen (void)
wxBrush *	GetRouteBrush (void)
wxBrush *	GetSelectedRouteBrush (void)
wxBrush *	GetActiveRouteBrush (void)
wxBrush *	GetActiveRoutePointBrush (void)
wxBrush *	GetRoutePointBrush (void)
wxString	GetRouteReverseMessage (void)
wxString	GetRouteResequenceMessage (void)
struct RoutemanDlgCtx &	GetDlgContext ()

Public Attributes
bool	m_bDataValid
EventVar	json_msg
	Notified with message targeting all plugins. More...
EventVar	json_leg_info
	Notified with a shared_ptr<ActiveLegDat>, leg info to all plugins. More...
EventVar	on_message_sent
	Notified when a message available as GetString() is sent to garmin.
EventVar	on_routes_update
	Notified when list of routes is updated (no data in event)

Friends
class	RoutemanGui

Detailed Description

Definition at line 117 of file routeman.h.

Member Function Documentation

ActivateNextPoint()

bool Routeman::ActivateNextPoint	(	Route *	pr,
		bool	skipped
	)

if (pRoutePropDialog && pRoutePropDialog->IsShown()) { if (pRoutePropDialog->GetRoute() == pr) { pRoutePropDialog->SetEnroutePoint(pActivePoint); } }

Definition at line 369 of file routeman.cpp.

ActivateRoutePoint()

bool Routeman::ActivateRoutePoint	(	Route *	pA,
		RoutePoint *	pRP
	)

if (pRoutePropDialog && pRoutePropDialog->IsShown()) { if (pRoutePropDialog->GetRoute() == pA) { pRoutePropDialog->SetEnroutePoint(pActivePoint); } }

Definition at line 294 of file routeman.cpp.

DeleteRoute()

bool Routeman::DeleteRoute	(	Route *	pRoute,
		NavObjectChanges *	nav_obj_changes
	)

if (pRoutePropDialog && (pRoutePropDialog->IsShown()) && (pRoute == pRoutePropDialog->GetRoute())) { pRoutePropDialog->Hide(); }

Definition at line 751 of file routeman.cpp.

Member Data Documentation

json_leg_info

EventVar Routeman::json_leg_info

Notified with a shared_ptr<ActiveLegDat>, leg info to all plugins.

Definition at line 190 of file routeman.h.

json_msg

EventVar Routeman::json_msg

Notified with message targeting all plugins.

Contains a message type string and a wxJSONValue shared_ptr.

Definition at line 187 of file routeman.h.

---

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

• /home/runner/work/OpenCPN/OpenCPN/model/include/model/routeman.h
• /home/runner/work/OpenCPN/OpenCPN/model/src/routeman.cpp