OpenCPN Partial API docs
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Friends | List of all members
Routeman Class Reference

Public Member Functions

 Routeman (struct RoutePropDlgCtx ctx, std::function< void()> RouteMgrDlgUpdateListCtrl)
 
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)
 

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...
 

Friends

class RoutemanGui
 

Detailed Description

Definition at line 81 of file routeman.h.

Constructor & Destructor Documentation

◆ Routeman()

Routeman::Routeman ( struct RoutePropDlgCtx  ctx,
std::function< void()>  RouteMgrDlgUpdateListCtrl 
)

Definition at line 130 of file routeman.cpp.

◆ ~Routeman()

Routeman::~Routeman ( )

Definition at line 139 of file routeman.cpp.

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 387 of file routeman.cpp.

◆ ActivateRoute()

bool Routeman::ActivateRoute ( Route *  pRouteToActivate,
RoutePoint *  pStartPoint = NULL 
)

Definition at line 278 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 312 of file routeman.cpp.

◆ DeactivateRoute()

bool Routeman::DeactivateRoute ( bool  b_arrival = false)

Definition at line 433 of file routeman.cpp.

◆ DeleteAllRoutes()

void Routeman::DeleteAllRoutes ( NavObjectChanges *  nav_obj_changes)

Definition at line 814 of file routeman.cpp.

◆ DeleteRoute()

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

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

if (pRouteManagerDialog && pRouteManagerDialog->IsShown()) pRouteManagerDialog->UpdateRouteListCtrl();

Definition at line 726 of file routeman.cpp.

◆ DoesRouteContainSharedPoints()

bool Routeman::DoesRouteContainSharedPoints ( Route *  pRoute)

Definition at line 689 of file routeman.cpp.

◆ FindBestActivatePoint()

RoutePoint * Routeman::FindBestActivatePoint ( Route *  pR,
double  lat,
double  lon,
double  cog,
double  sog 
)

Definition at line 247 of file routeman.cpp.

◆ FindRouteByGUID()

Route * Routeman::FindRouteByGUID ( const wxString &  guid)

Definition at line 908 of file routeman.cpp.

◆ FindRouteContainingWaypoint()

Route * Routeman::FindRouteContainingWaypoint ( RoutePoint *  pWP)

Definition at line 153 of file routeman.cpp.

◆ FindTrackByGUID()

Track * Routeman::FindTrackByGUID ( const wxString &  guid)

Definition at line 920 of file routeman.cpp.

◆ FindVisibleRouteContainingWaypoint()

Route * Routeman::FindVisibleRouteContainingWaypoint ( RoutePoint *  pWP)

Definition at line 172 of file routeman.cpp.

◆ GetActiveRouteBrush()

wxBrush * Routeman::GetActiveRouteBrush ( void  )
inline

Definition at line 135 of file routeman.h.

◆ GetActiveRoutePen()

wxPen * Routeman::GetActiveRoutePen ( void  )
inline

Definition at line 130 of file routeman.h.

◆ GetActiveRoutePointBrush()

wxBrush * Routeman::GetActiveRoutePointBrush ( void  )
inline

Definition at line 136 of file routeman.h.

◆ GetActiveRoutePointPen()

wxPen * Routeman::GetActiveRoutePointPen ( void  )
inline

Definition at line 131 of file routeman.h.

◆ GetCurrentBrgToActivePoint()

double Routeman::GetCurrentBrgToActivePoint ( )
inline

Definition at line 117 of file routeman.h.

◆ GetCurrentRngToActiveNormalArrival()

double Routeman::GetCurrentRngToActiveNormalArrival ( )
inline

Definition at line 118 of file routeman.h.

◆ GetCurrentRngToActivePoint()

double Routeman::GetCurrentRngToActivePoint ( )
inline

Definition at line 116 of file routeman.h.

◆ GetCurrentSegmentCourse()

double Routeman::GetCurrentSegmentCourse ( )
inline

Definition at line 123 of file routeman.h.

◆ GetCurrentXTEToActivePoint()

double Routeman::GetCurrentXTEToActivePoint ( )
inline

Definition at line 121 of file routeman.h.

◆ GetpActivePoint()

RoutePoint * Routeman::GetpActivePoint ( )
inline

Definition at line 115 of file routeman.h.

◆ GetpActiveRoute()

Route * Routeman::GetpActiveRoute ( )
inline

Definition at line 114 of file routeman.h.

◆ GetRouteArrayContaining()

wxArrayPtrVoid * Routeman::GetRouteArrayContaining ( RoutePoint *  pWP)

Definition at line 191 of file routeman.cpp.

◆ GetRouteBrush()

wxBrush * Routeman::GetRouteBrush ( void  )
inline

Definition at line 133 of file routeman.h.

◆ GetRoutePen()

wxPen * Routeman::GetRoutePen ( void  )
inline

Definition at line 127 of file routeman.h.

◆ GetRoutePointBrush()

wxBrush * Routeman::GetRoutePointBrush ( void  )
inline

Definition at line 137 of file routeman.h.

◆ GetRoutePointPen()

wxPen * Routeman::GetRoutePointPen ( void  )
inline

Definition at line 132 of file routeman.h.

◆ GetRouteResequenceMessage()

wxString Routeman::GetRouteResequenceMessage ( void  )

Definition at line 902 of file routeman.cpp.

◆ GetRouteReverseMessage()

wxString Routeman::GetRouteReverseMessage ( void  )

Definition at line 896 of file routeman.cpp.

◆ GetSelectedRouteBrush()

wxBrush * Routeman::GetSelectedRouteBrush ( void  )
inline

Definition at line 134 of file routeman.h.

◆ GetSelectedRoutePen()

wxPen * Routeman::GetSelectedRoutePen ( void  )
inline

Definition at line 129 of file routeman.h.

◆ GetTrackPen()

wxPen * Routeman::GetTrackPen ( void  )
inline

Definition at line 128 of file routeman.h.

◆ GetXTEDir()

int Routeman::GetXTEDir ( )
inline

Definition at line 124 of file routeman.h.

◆ IsAnyRouteActive()

bool Routeman::IsAnyRouteActive ( void  )
inline

Definition at line 112 of file routeman.h.

◆ IsRouteValid()

bool Routeman::IsRouteValid ( Route *  pRoute)

Definition at line 143 of file routeman.cpp.

◆ RemovePointFromRoute()

void Routeman::RemovePointFromRoute ( RoutePoint *  point,
Route *  route,
int  route_state 
)

Definition at line 222 of file routeman.cpp.

◆ SetColorScheme()

void Routeman::SetColorScheme ( ColorScheme  cs,
double  displayDPmm 
)

Definition at line 854 of file routeman.cpp.

◆ UpdateAutopilot()

bool Routeman::UpdateAutopilot ( )

Definition at line 472 of file routeman.cpp.

◆ ZeroCurrentXTEToActivePoint()

void Routeman::ZeroCurrentXTEToActivePoint ( )

Definition at line 928 of file routeman.cpp.

Friends And Related Function Documentation

◆ RoutemanGui

friend class RoutemanGui
friend

Definition at line 83 of file routeman.h.

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 151 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 148 of file routeman.h.

◆ m_bDataValid

bool Routeman::m_bDataValid

Definition at line 142 of file routeman.h.

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