Loading...
Searching...
No Matches
HostApi123 Class Reference
Unstable development API. More...
#include <ocpn_plugin.h>
Inheritance diagram for HostApi123:
Public Member Functions | |
| HostApi123 (Api122Impl *support) | |
| Public Member Functions inherited from HostApi122 | |
| HostApi122 (Api122Impl *support) | |
| virtual void | RegisterApiEventCallback (const std::string &plugin_name, std::function< void(EventType what)> callback) |
| Register a new callback invoked when an EventType event occurs. | |
| virtual const std::set< std::string > & | GetActiveMessages () |
| Return currently known messages types flowing through system. | |
| virtual std::string | GetSignalkPayload (ObservedEvt ev) |
| Get SignalK payload after receiving a message. | |
| Public Member Functions inherited from HostApi121 | |
| 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) |
Additional Inherited Members | |
| Public Types inherited from HostApi122 | |
| enum class | EventType { kNewMessageType = 1 } |
| Reported events bitmask. More... | |
| Public Types inherited from HostApi121 | |
| enum class | PiContextObjectType { kObjectChart = 0 , kObjectRoutepoint , kObjectRoutesegment , kObjectTracksegment , kObjectAisTarget , kObjectUnknown } |
| Public Attributes inherited from HostApi121 | |
| const int | kContextMenuDisableWaypoint |
| const int | kContextMenuDisableRoute |
| const int | kContextMenuDisableTrack |
| const int | kContextMenuDisableAistarget |
Detailed Description
Unstable development API.
Definition at line 7449 of file ocpn_plugin.h.
Constructor & Destructor Documentation
◆ HostApi123()
|
inline |
Definition at line 7451 of file ocpn_plugin.h.
The documentation for this class was generated from the following file:
- /home/runner/work/main/main/opencpn/include/ocpn_plugin.h
