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

Locked down interface published in 5.14.1. More...

#include <ocpn_plugin.h>

Inheritance diagram for HostApi121:
HostApi HostApi122

Classes

struct  PiPointContext
 
class  Route
 

Public Types

enum class  PiContextObjectType {
  kObjectChart = 0 , kObjectRoutepoint , kObjectRoutesegment , kObjectTracksegment ,
  kObjectAisTarget , kObjectUnknown
}
 

Public Member Functions

virtual wxString DropMarkPI (double lat, double lon)
 
virtual wxString RouteCreatePI (int canvas_index, bool start)
 
virtual wxString NavToHerePI (double lat, double lon)
 
virtual bool ActivateRoutePI (wxString route_guid, bool activate)
 
virtual void EnableDefaultConsole (bool enable)
 
virtual void EnableDefaultContextMenus (bool enable)
 
virtual void SetMinZoomScale (double min_scale)
 
virtual void SetMaxZoomScale (double max_scale)
 
virtual wxBitmap GetObjectIcon_PlugIn (const wxString &name)
 
virtual void SetDepthUnitVisible (bool bviz)
 
virtual void SetOverzoomFlagVisible (bool bviz)
 
virtual bool IsRouteActive (wxString route_guid)
 
virtual void SetBoatPosition (double zlat, double zlon)
 
virtual void RouteInsertWaypoint (int canvas_index, wxString route_guid, double zlat, double zlon)
 
virtual void RouteAppendWaypoint (int canvas_index, wxString route_guid)
 
virtual void FinishRoute (int canvas_index)
 
virtual bool IsRouteBeingCreated (int canvas_index)
 
virtual bool AreRouteWaypointNamesVisible (wxString route_guid)
 
virtual void ShowRouteWaypointNames (wxString route_guid, bool show)
 
virtual void NavigateToWaypoint (wxString waypoint_guid)
 
virtual bool DoMeasurePI (int canvas_index, bool start)
 
virtual bool IsMeasureActive (int canvas_index)
 
virtual void CancelMeasure (int canvas_index)
 
virtual bool IsAISTrackVisible (const wxString &ais_mmsi) const
 
virtual void AISToggleShowTrack (const wxString &ais_mmsi)
 
virtual bool IsAIS_CPAVisible (const wxString &ais_mmsi) const
 
virtual void AISToggleShowCPA (const wxString &ais_mmsi)
 
virtual void ShowAISTargetQueryDialog (int canvas_index, const wxString &ais_mmsi)
 
virtual void ShowAISTargetList (int canvas_index)
 
virtual std::shared_ptr< PiPointContext > GetContextAtPoint (int x, int y, int canvas_index)
 
virtual void AddNoShowDirectory (std::string chart_dir)
 
virtual void RemoveNoShowDirectory (std::string chart_dir)
 
virtual void ClearNoShowVector ()
 
virtual const std::vector< std::string > & GetNoShowVector ()
 
virtual bool SelectChartFamily (int CanvasIndex, ChartFamilyEnumPI Family)
 
virtual void CenterToAisTarget (wxString ais_mmsi)
 
virtual void AisTargetCreateWpt (wxString ais_mmsi)
 
virtual void AisShowAllTracks (bool show)
 
virtual void AisToggleTrack (wxString ais_mmsi)
 
virtual int GetContextMenuMask ()
 
virtual void SetContextMenuMask (int mask)
 
virtual void SetTrackVisibiiity (const wxString &track_GUID, bool viz)
 
virtual bool AddRoute (Route *route, bool permanent=true)
 Add route to database, updated version of AddPlugInRouteExV2.
 
virtual bool UpdateRoute (Route *route)
 Update database route, updated version of UpdatePlugInRouteExV2.
 
virtual std::unique_ptr< HostApi121::Route > GetRoute (const wxString &guid)
 Retrieve route from database.
 
virtual bool GetNearestTideStation (double lat, double lon, PlugIn_TideStation *station)
 
virtual bool GetTideHeight (int stationIndex, time_t time, float *height)
 

Public Attributes

const int kContextMenuDisableWaypoint
 
const int kContextMenuDisableRoute
 
const int kContextMenuDisableTrack
 
const int kContextMenuDisableAistarget
 

Detailed Description

Locked down interface published in 5.14.1.

Usage something like: 

 std::shared_ptr<HostApi> host_api = std::move(GetHostApi());
 std::shared_ptr<HostApi121> api_121 =
         std::dynamic_pointer_cast<HostApi121>(m_host_api);
Examples
/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 7248 of file ocpn_plugin.h.

Member Enumeration Documentation

◆ PiContextObjectType

enum class HostApi121::PiContextObjectType
strong

Definition at line 7263 of file ocpn_plugin.h.

Constructor & Destructor Documentation

◆ HostApi121()

HostApi121::HostApi121 ( )
inline

Definition at line 7250 of file ocpn_plugin.h.

Member Function Documentation

◆ ActivateRoutePI()

bool HostApi121::ActivateRoutePI ( wxString  route_guid,
bool  activate 
)
virtual

Definition at line 922 of file api_121.cpp.

◆ AddNoShowDirectory()

void HostApi121::AddNoShowDirectory ( std::string  chart_dir)
virtual

Definition at line 1025 of file api_121.cpp.

◆ AddRoute()

bool HostApi121::AddRoute ( HostApi121::Route *  route,
bool  permanent = true 
)
virtual

Add route to database, updated version of AddPlugInRouteExV2.

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

Definition at line 871 of file api_121.cpp.

◆ AisShowAllTracks()

void HostApi121::AisShowAllTracks ( bool  show)
virtual

Definition at line 1053 of file api_121.cpp.

◆ AisTargetCreateWpt()

void HostApi121::AisTargetCreateWpt ( wxString  ais_mmsi)
virtual

Definition at line 1049 of file api_121.cpp.

◆ AISToggleShowCPA()

void HostApi121::AISToggleShowCPA ( const wxString &  ais_mmsi)
virtual

Definition at line 998 of file api_121.cpp.

◆ AISToggleShowTrack()

void HostApi121::AISToggleShowTrack ( const wxString &  ais_mmsi)
virtual

Definition at line 990 of file api_121.cpp.

◆ AisToggleTrack()

void HostApi121::AisToggleTrack ( wxString  ais_mmsi)
virtual

Definition at line 1055 of file api_121.cpp.

◆ AreRouteWaypointNamesVisible()

bool HostApi121::AreRouteWaypointNamesVisible ( wxString  route_guid)
virtual

Definition at line 974 of file api_121.cpp.

◆ CancelMeasure()

void HostApi121::CancelMeasure ( int  canvas_index)
virtual

Definition at line 1015 of file api_121.cpp.

◆ CenterToAisTarget()

void HostApi121::CenterToAisTarget ( wxString  ais_mmsi)
virtual

Definition at line 1045 of file api_121.cpp.

◆ ClearNoShowVector()

void HostApi121::ClearNoShowVector ( )
virtual

Definition at line 1033 of file api_121.cpp.

◆ DoMeasurePI()

bool HostApi121::DoMeasurePI ( int  canvas_index,
bool  start 
)
virtual

Definition at line 914 of file api_121.cpp.

◆ DropMarkPI()

wxString HostApi121::DropMarkPI ( double  lat,
double  lon 
)
virtual

Definition at line 906 of file api_121.cpp.

◆ EnableDefaultConsole()

void HostApi121::EnableDefaultConsole ( bool  enable)
virtual

Definition at line 926 of file api_121.cpp.

◆ EnableDefaultContextMenus()

void HostApi121::EnableDefaultContextMenus ( bool  enable)
virtual

Definition at line 930 of file api_121.cpp.

◆ FinishRoute()

void HostApi121::FinishRoute ( int  canvas_index)
virtual

Definition at line 968 of file api_121.cpp.

◆ GetContextAtPoint()

std::shared_ptr< HostApi121::PiPointContext > HostApi121::GetContextAtPoint ( int  x,
int  y,
int  canvas_index 
)
virtual

Definition at line 942 of file api_121.cpp.

◆ GetContextMenuMask()

int HostApi121::GetContextMenuMask ( )
virtual

Definition at line 1060 of file api_121.cpp.

◆ GetNearestTideStation()

bool HostApi121::GetNearestTideStation ( double  lat,
double  lon,
PlugIn_TideStation *  station 
)
virtual

Definition at line 1068 of file api_121.cpp.

◆ GetNoShowVector()

const std::vector< std::string > & HostApi121::GetNoShowVector ( )
virtual

Definition at line 1035 of file api_121.cpp.

◆ GetObjectIcon_PlugIn()

wxBitmap HostApi121::GetObjectIcon_PlugIn ( const wxString &  name)
virtual

Definition at line 947 of file api_121.cpp.

◆ GetRoute()

std::unique_ptr< HostApi121::Route > HostApi121::GetRoute ( const wxString &  guid)
virtual

Retrieve route from database.

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

Definition at line 879 of file api_121.cpp.

◆ GetTideHeight()

bool HostApi121::GetTideHeight ( int  stationIndex,
time_t  time,
float *  height 
)
virtual

Definition at line 1073 of file api_121.cpp.

◆ IsAIS_CPAVisible()

bool HostApi121::IsAIS_CPAVisible ( const wxString &  ais_mmsi) const
virtual

Definition at line 994 of file api_121.cpp.

◆ IsAISTrackVisible()

bool HostApi121::IsAISTrackVisible ( const wxString &  ais_mmsi) const
virtual

Definition at line 986 of file api_121.cpp.

◆ IsMeasureActive()

bool HostApi121::IsMeasureActive ( int  canvas_index)
virtual

Definition at line 1011 of file api_121.cpp.

◆ IsRouteActive()

bool HostApi121::IsRouteActive ( wxString  route_guid)
virtual

Definition at line 951 of file api_121.cpp.

◆ IsRouteBeingCreated()

bool HostApi121::IsRouteBeingCreated ( int  canvas_index)
virtual

Definition at line 970 of file api_121.cpp.

◆ NavigateToWaypoint()

void HostApi121::NavigateToWaypoint ( wxString  waypoint_guid)
virtual

Definition at line 982 of file api_121.cpp.

◆ NavToHerePI()

wxString HostApi121::NavToHerePI ( double  lat,
double  lon 
)
virtual

Definition at line 918 of file api_121.cpp.

◆ RemoveNoShowDirectory()

void HostApi121::RemoveNoShowDirectory ( std::string  chart_dir)
virtual

Definition at line 1029 of file api_121.cpp.

◆ RouteAppendWaypoint()

void HostApi121::RouteAppendWaypoint ( int  canvas_index,
wxString  route_guid 
)
virtual

Definition at line 964 of file api_121.cpp.

◆ RouteCreatePI()

wxString HostApi121::RouteCreatePI ( int  canvas_index,
bool  start 
)
virtual

Definition at line 910 of file api_121.cpp.

◆ RouteInsertWaypoint()

void HostApi121::RouteInsertWaypoint ( int  canvas_index,
wxString  route_guid,
double  zlat,
double  zlon 
)
virtual

Definition at line 959 of file api_121.cpp.

◆ SelectChartFamily()

bool HostApi121::SelectChartFamily ( int  CanvasIndex,
ChartFamilyEnumPI  Family 
)
virtual

Definition at line 1039 of file api_121.cpp.

◆ SetBoatPosition()

void HostApi121::SetBoatPosition ( double  zlat,
double  zlon 
)
virtual

Definition at line 955 of file api_121.cpp.

◆ SetContextMenuMask()

void HostApi121::SetContextMenuMask ( int  mask)
virtual

Definition at line 1062 of file api_121.cpp.

◆ SetDepthUnitVisible()

void HostApi121::SetDepthUnitVisible ( bool  bviz)
virtual

Definition at line 1019 of file api_121.cpp.

◆ SetMaxZoomScale()

void HostApi121::SetMaxZoomScale ( double  max_scale)
virtual

Definition at line 938 of file api_121.cpp.

◆ SetMinZoomScale()

void HostApi121::SetMinZoomScale ( double  min_scale)
virtual

Definition at line 934 of file api_121.cpp.

◆ SetOverzoomFlagVisible()

void HostApi121::SetOverzoomFlagVisible ( bool  bviz)
virtual

Definition at line 1021 of file api_121.cpp.

◆ SetTrackVisibiiity()

void HostApi121::SetTrackVisibiiity ( const wxString &  track_GUID,
bool  viz 
)
virtual

Definition at line 1064 of file api_121.cpp.

◆ ShowAISTargetList()

void HostApi121::ShowAISTargetList ( int  canvas_index)
virtual

Definition at line 1007 of file api_121.cpp.

◆ ShowAISTargetQueryDialog()

void HostApi121::ShowAISTargetQueryDialog ( int  canvas_index,
const wxString &  ais_mmsi 
)
virtual

Definition at line 1002 of file api_121.cpp.

◆ ShowRouteWaypointNames()

void HostApi121::ShowRouteWaypointNames ( wxString  route_guid,
bool  show 
)
virtual

Definition at line 978 of file api_121.cpp.

◆ UpdateRoute()

bool HostApi121::UpdateRoute ( HostApi121::Route *  route)
virtual

Update database route, updated version of UpdatePlugInRouteExV2.

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

Definition at line 875 of file api_121.cpp.

Member Data Documentation

◆ kContextMenuDisableAistarget

const int HostApi121::kContextMenuDisableAistarget

Definition at line 7261 of file ocpn_plugin.h.

◆ kContextMenuDisableRoute

const int HostApi121::kContextMenuDisableRoute

Definition at line 7259 of file ocpn_plugin.h.

◆ kContextMenuDisableTrack

const int HostApi121::kContextMenuDisableTrack

Definition at line 7260 of file ocpn_plugin.h.

◆ kContextMenuDisableWaypoint

const int HostApi121::kContextMenuDisableWaypoint

Definition at line 7258 of file ocpn_plugin.h.

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