Locked down interface published in 5.14.0. More...

#include <ocpn_plugin.h>

Inheritance diagram for HostApi121:

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

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 7252 of file ocpn_plugin.h.

Member Enumeration Documentation

◆ PiContextObjectType

enum class HostApi121::PiContextObjectType

strong

Definition at line 7268 of file ocpn_plugin.h.

Constructor & Destructor Documentation

◆ HostApi121()

HostApi121::HostApi121 ( )

inline

Definition at line 7254 of file ocpn_plugin.h.

Member Function Documentation

◆ ActivateRoutePI()

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

virtual

Definition at line 925 of file api_121.cpp.

◆ AddNoShowDirectory()

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

virtual

Definition at line 1028 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 874 of file api_121.cpp.

◆ AisShowAllTracks()

void HostApi121::AisShowAllTracks ( bool show )

virtual

Definition at line 1056 of file api_121.cpp.

◆ AisTargetCreateWpt()

void HostApi121::AisTargetCreateWpt ( wxString ais_mmsi )

virtual

Definition at line 1052 of file api_121.cpp.

◆ AISToggleShowCPA()

void HostApi121::AISToggleShowCPA ( const wxString & ais_mmsi )

virtual

Definition at line 1001 of file api_121.cpp.

◆ AISToggleShowTrack()

void HostApi121::AISToggleShowTrack ( const wxString & ais_mmsi )

virtual

Definition at line 993 of file api_121.cpp.

◆ AisToggleTrack()

void HostApi121::AisToggleTrack ( wxString ais_mmsi )

virtual

Definition at line 1058 of file api_121.cpp.

◆ AreRouteWaypointNamesVisible()

bool HostApi121::AreRouteWaypointNamesVisible ( wxString route_guid )

virtual

Definition at line 977 of file api_121.cpp.

◆ CancelMeasure()

void HostApi121::CancelMeasure ( int canvas_index )

virtual

Definition at line 1018 of file api_121.cpp.

◆ CenterToAisTarget()

void HostApi121::CenterToAisTarget ( wxString ais_mmsi )

virtual

Definition at line 1048 of file api_121.cpp.

◆ ClearNoShowVector()

void HostApi121::ClearNoShowVector ( )

virtual

Definition at line 1036 of file api_121.cpp.

◆ DoMeasurePI()

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

virtual

Definition at line 917 of file api_121.cpp.

◆ DropMarkPI()

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

virtual

Definition at line 909 of file api_121.cpp.

◆ EnableDefaultConsole()

void HostApi121::EnableDefaultConsole ( bool enable )

virtual

Definition at line 929 of file api_121.cpp.

◆ EnableDefaultContextMenus()

void HostApi121::EnableDefaultContextMenus ( bool enable )

virtual

Definition at line 933 of file api_121.cpp.

◆ FinishRoute()

void HostApi121::FinishRoute ( int canvas_index )

virtual

Definition at line 971 of file api_121.cpp.

◆ GetContextAtPoint()

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

virtual

Definition at line 945 of file api_121.cpp.

◆ GetContextMenuMask()

int HostApi121::GetContextMenuMask ( )

virtual

Definition at line 1063 of file api_121.cpp.

◆ GetNearestTideStation()

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

virtual

Definition at line 1071 of file api_121.cpp.

◆ GetNoShowVector()

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

virtual

Definition at line 1038 of file api_121.cpp.

◆ GetObjectIcon_PlugIn()

wxBitmap HostApi121::GetObjectIcon_PlugIn ( const wxString & name )

virtual

Definition at line 950 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 882 of file api_121.cpp.

◆ GetTideHeight()

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

virtual

Definition at line 1076 of file api_121.cpp.

◆ IsAIS_CPAVisible()

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

virtual

Definition at line 997 of file api_121.cpp.

◆ IsAISTrackVisible()

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

virtual

Definition at line 989 of file api_121.cpp.

◆ IsMeasureActive()

bool HostApi121::IsMeasureActive ( int canvas_index )

virtual

Definition at line 1014 of file api_121.cpp.

◆ IsRouteActive()

bool HostApi121::IsRouteActive ( wxString route_guid )

virtual

Definition at line 954 of file api_121.cpp.

◆ IsRouteBeingCreated()

bool HostApi121::IsRouteBeingCreated ( int canvas_index )

virtual

Definition at line 973 of file api_121.cpp.

◆ NavigateToWaypoint()

void HostApi121::NavigateToWaypoint ( wxString waypoint_guid )

virtual

Definition at line 985 of file api_121.cpp.

◆ NavToHerePI()

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

virtual

Definition at line 921 of file api_121.cpp.

◆ RemoveNoShowDirectory()

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

virtual

Definition at line 1032 of file api_121.cpp.

◆ RouteAppendWaypoint()

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

virtual

Definition at line 967 of file api_121.cpp.

◆ RouteCreatePI()

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

virtual

Definition at line 913 of file api_121.cpp.

◆ RouteInsertWaypoint()

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

virtual

Definition at line 962 of file api_121.cpp.

◆ SelectChartFamily()

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

virtual

Definition at line 1042 of file api_121.cpp.

◆ SetBoatPosition()

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

virtual

Definition at line 958 of file api_121.cpp.

◆ SetContextMenuMask()

void HostApi121::SetContextMenuMask ( int mask )

virtual

Definition at line 1065 of file api_121.cpp.

◆ SetDepthUnitVisible()

void HostApi121::SetDepthUnitVisible ( bool bviz )

virtual

Definition at line 1022 of file api_121.cpp.

◆ SetMaxZoomScale()

void HostApi121::SetMaxZoomScale ( double max_scale )

virtual

Definition at line 941 of file api_121.cpp.

◆ SetMinZoomScale()

void HostApi121::SetMinZoomScale ( double min_scale )

virtual

Definition at line 937 of file api_121.cpp.

◆ SetOverzoomFlagVisible()

void HostApi121::SetOverzoomFlagVisible ( bool bviz )

virtual

Definition at line 1024 of file api_121.cpp.

◆ SetTrackVisibiiity()

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

virtual

Definition at line 1067 of file api_121.cpp.

◆ ShowAISTargetList()

void HostApi121::ShowAISTargetList ( int canvas_index )

virtual

Definition at line 1010 of file api_121.cpp.

◆ ShowAISTargetQueryDialog()

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

virtual

Definition at line 1005 of file api_121.cpp.

◆ ShowRouteWaypointNames()

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

virtual

Definition at line 981 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 878 of file api_121.cpp.

Member Data Documentation

◆ kContextMenuDisableAistarget

const int HostApi121::kContextMenuDisableAistarget

Definition at line 7266 of file ocpn_plugin.h.

◆ kContextMenuDisableRoute

const int HostApi121::kContextMenuDisableRoute

Definition at line 7264 of file ocpn_plugin.h.

◆ kContextMenuDisableTrack

const int HostApi121::kContextMenuDisableTrack

Definition at line 7265 of file ocpn_plugin.h.

◆ kContextMenuDisableWaypoint

const int HostApi121::kContextMenuDisableWaypoint

Definition at line 7263 of file ocpn_plugin.h.

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

Classes

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ PiContextObjectType

Constructor & Destructor Documentation

◆ HostApi121()

Member Function Documentation

◆ ActivateRoutePI()

◆ AddNoShowDirectory()

◆ AddRoute()

◆ AisShowAllTracks()

◆ AisTargetCreateWpt()

◆ AISToggleShowCPA()

◆ AISToggleShowTrack()

◆ AisToggleTrack()

◆ AreRouteWaypointNamesVisible()

◆ CancelMeasure()

◆ CenterToAisTarget()

◆ ClearNoShowVector()

◆ DoMeasurePI()

◆ DropMarkPI()

◆ EnableDefaultConsole()

◆ EnableDefaultContextMenus()

◆ FinishRoute()

◆ GetContextAtPoint()

◆ GetContextMenuMask()

◆ GetNearestTideStation()

◆ GetNoShowVector()

◆ GetObjectIcon_PlugIn()

◆ GetRoute()

◆ GetTideHeight()

◆ IsAIS_CPAVisible()

◆ IsAISTrackVisible()

◆ IsMeasureActive()

◆ IsRouteActive()

◆ IsRouteBeingCreated()

◆ NavigateToWaypoint()

◆ NavToHerePI()

◆ RemoveNoShowDirectory()

◆ RouteAppendWaypoint()

◆ RouteCreatePI()

◆ RouteInsertWaypoint()

◆ SelectChartFamily()

◆ SetBoatPosition()

◆ SetContextMenuMask()

◆ SetDepthUnitVisible()

◆ SetMaxZoomScale()

◆ SetMinZoomScale()

◆ SetOverzoomFlagVisible()

◆ SetTrackVisibiiity()

◆ ShowAISTargetList()

◆ ShowAISTargetQueryDialog()

◆ ShowRouteWaypointNames()

◆ UpdateRoute()

Member Data Documentation

◆ kContextMenuDisableAistarget

◆ kContextMenuDisableRoute

◆ kContextMenuDisableTrack

◆ kContextMenuDisableWaypoint