Inheritance diagram for HostApi122:

Public Types
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 Member Functions
	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 Attributes inherited from HostApi121
const int	kContextMenuDisableWaypoint
const int	kContextMenuDisableRoute
const int	kContextMenuDisableTrack
const int	kContextMenuDisableAistarget

Detailed Description

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

Definition at line 7393 of file ocpn_plugin.h.

Member Enumeration Documentation

◆ EventType

enum class HostApi122::EventType

strong

Reported events bitmask.

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

Definition at line 7398 of file ocpn_plugin.h.

Constructor & Destructor Documentation

◆ HostApi122()

HostApi122::HostApi122 ( Api122Impl * support )

inline

Definition at line 7395 of file ocpn_plugin.h.

Member Function Documentation

◆ GetActiveMessages()

const std::set< std::string > & HostApi122::GetActiveMessages ( )

virtual

Return currently known messages types flowing through system.

General item format: <bus>::<key> bus ::= "nmea0183" | "nmea2000" | "SignalK" | "Plugin" <key> depends on bus – TBD

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

Definition at line 58 of file api_122.cpp.

◆ GetSignalkPayload()

std::string HostApi122::GetSignalkPayload ( ObservedEvt ev )

virtual

Get SignalK payload after receiving a message.

Returns

json text data. Typical usage:

std::string json_payload = GetSignalkPayload(ev);
... parse and use json_payload

json_payload is a map containing the following entries:

"Data": the raw json message
"Context": string, message context
"ContextSelf": string, own ship context.

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

Definition at line 49 of file api_122.cpp.

◆ RegisterApiEventCallback()

void HostApi122::RegisterApiEventCallback	(	const std::string &	plugin_name,
		std::function< void(EventType what)>	callback )

virtual

Register a new callback invoked when an EventType event occurs.

Parameters

plugin_name	Invoking plugin name as of GetCommonName().
callback	Invoked with an EventType argument defining the actual event which occurred. Use nullptr to deregister possibly existing callback

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

Definition at line 42 of file api_122.cpp.

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

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h
/home/runner/work/main/main/opencpn/gui/src/api_122.cpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ EventType

Constructor & Destructor Documentation

◆ HostApi122()

Member Function Documentation

◆ GetActiveMessages()

◆ GetSignalkPayload()

◆ RegisterApiEventCallback()