OpenCPN Partial API docs
Route Class Reference
Inheritance diagram for Route:

Public Member Functions

virtual int GetnPoints (void)
 
void AddPoint (RoutePoint *pNewPoint, bool b_rename_in_sequence=true, bool b_deferBoxCalc=false)
 
void InsertPointAndSegment (RoutePoint *pNewPoint, int insert_after, bool b_rename_in_sequence=true, bool b_deferBoxCalc=false)
 
void AddPointAndSegment (RoutePoint *pNewPoint, bool b_rename_in_sequence=true, bool b_deferBoxCalc=false)
 
RoutePointGetPoint (int nPoint)
 
RoutePointGetPoint (const wxString &guid)
 
int GetIndexOf (RoutePoint *prp)
 
RoutePointInsertPointBefore (RoutePoint *pRP, double rlat, double rlon, bool bRenamePoints=false)
 
RoutePointInsertPointAfter (RoutePoint *pRP, double rlat, double rlon, bool bRenamePoints=false)
 
RoutePointGetLastPoint ()
 
void DeletePoint (RoutePoint *rp, bool bRenamePoints=false)
 
void RemovePoint (RoutePoint *rp, bool bRenamePoints=false)
 
void DeSelectRoute ()
 
void FinalizeForRendering ()
 
void UpdateSegmentDistance (RoutePoint *prp0, RoutePoint *prp, double planspeed=-1.0)
 
void UpdateSegmentDistances (double planspeed=-1.0)
 
LLBBox & GetBBox ()
 
void SetHiLite (int width)
 
void Reverse (bool bRenamePoints=false)
 
void RebuildGUIDList (void)
 
void RenameRoutePoints ()
 
void ReloadRoutePointIcons ()
 
wxString GetNewMarkSequenced (void)
 
void AssembleRoute ()
 
bool IsEqualTo (Route *ptargetroute)
 
void CloneRoute (Route *psourceroute, int start_nPoint, int end_nPoint, const wxString &suffix, const bool duplicate_first_point=false)
 
void ClearHighlights (void)
 
void SetVisible (bool visible=true, bool includeWpts=true)
 
void SetListed (bool visible=true)
 
bool IsVisible ()
 
bool IsListed ()
 
bool IsActive ()
 
bool IsSelected ()
 
bool ContainsSharedWP ()
 
void SetSharedWPViz (bool sharedWPVIZ)
 
bool GetSharedWPViz ()
 
double GetRouteArrivalRadius (void)
 
void SetRouteArrivalRadius (double radius)
 
void SetDepartureDate (const wxDateTime &dt)
 
wxString GetName () const
 
wxString GetTo () const
 
wxString GetGUID () const
 
void ShowWaypointNames (bool bshow)
 
bool AreWaypointNamesVisible ()
 

Public Attributes

int m_ConfigRouteNum
 
bool m_bRtIsSelected
 
bool m_bRtIsActive
 
RoutePointm_pRouteActivePoint
 
bool m_bIsBeingCreated
 
bool m_bIsBeingEdited
 
double m_route_length
 
double m_route_time
 
wxString m_RouteNameString
 
wxString m_RouteStartString
 
wxString m_RouteEndString
 
wxString m_RouteDescription
 
bool m_bDeleteOnArrival
 
wxString m_GUID
 
bool m_bIsInLayer
 
int m_LayerID
 
int m_width
 
wxPenStyle m_style
 
int m_lastMousePointIndex
 
bool m_NextLegGreatCircle
 
double m_PlannedSpeed
 
wxDateTime m_PlannedDeparture
 
wxString m_TimeDisplayFormat
 
RoutePointList * pRoutePointList
 
wxRect active_pt_rect
 
wxString m_Colour
 
bool m_btemp
 
int m_hiliteWidth
 
HyperlinkList * m_HyperlinkList
 

Friends

class RouteGui
 

Detailed Description

Definition at line 75 of file route.h.


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