Inheritance diagram for grib_pi:

Public Member Functions
	grib_pi (void *ppimgr)

int	Init (void)

bool	DeInit (void)

int	GetAPIVersionMajor ()

int	GetAPIVersionMinor ()

int	GetPlugInVersionMajor ()

int	GetPlugInVersionMinor ()

wxBitmap *	GetPlugInBitmap ()
	FIXME static wxBitmap* LoadSVG(const wxString filename, unsigned int width, unsigned int height) { if (!gFrame) return new wxBitmap(width, height); // We are headless.

wxString	GetCommonName ()

wxString	GetShortDescription ()

wxString	GetLongDescription ()

bool	MouseEventHook (wxMouseEvent &event)

bool	RenderOverlay (wxDC &dc, PlugIn_ViewPort *vp)

bool	RenderOverlayMultiCanvas (wxDC &dc, PlugIn_ViewPort *vp, int canvasIndex)

void	SetCursorLatLon (double lat, double lon)

void	OnContextMenuItemCallback (int id)

void	SetPluginMessage (wxString &message_id, wxString &message_body)

bool	RenderGLOverlay (wxGLContext pcontext, PlugIn_ViewPort vp)

bool	RenderGLOverlayMultiCanvas (wxGLContext pcontext, PlugIn_ViewPort vp, int canvasIndex)

void	SendTimelineMessage (wxDateTime time)

void	SetDefaults (void)

int	GetToolBarToolCount (void)

void	ShowPreferencesDialog (wxWindow *parent)

void	OnToolbarToolCallback (int id)

bool	QualifyCtrlBarPosition (wxPoint position, wxSize size)

void	MoveDialog (wxDialog *dialog, wxPoint position)

void	SetPositionFixEx (PlugIn_Position_Fix_Ex &pfix)

void	SetCtrlBarXY (wxPoint p)

void	SetCursorDataXY (wxPoint p)

void	SetCtrlBarSizeXY (wxSize p)

void	SetColorScheme (PI_ColorScheme cs)

void	SetDialogFont (wxWindow window, wxFont font=OCPNGetFont(_("Dialog"), 0))

void	SetCurrentViewPort (PlugIn_ViewPort &vp)

PlugIn_ViewPort &	GetCurrentViewPort ()

void	OnGribCtrlBarClose ()

wxPoint	GetCtrlBarXY ()

wxPoint	GetCursorDataXY ()

int	GetTimeZone ()

void	SetTimeZone (int tz)

int	GetStartOptions ()

bool	GetCopyFirstCumRec ()
	Returns true if cumulative parameters like precipitation and cloud cover should initialize their start values from the first record.

bool	GetCopyMissWaveRec ()
	Returns true if wave data should be propagated across time periods where wave records are missing.

GRIBOverlayFactory *	GetGRIBOverlayFactory ()

void	UpdatePrefs (GribPreferencesDialog *Pref)

Public Member Functions inherited from opencpn_plugin_116
	opencpn_plugin_116 (void *pmgr)

virtual void	PrepareContextMenu (int canvasIndex)

Public Member Functions inherited from opencpn_plugin_115
	opencpn_plugin_115 (void *pmgr)

Public Member Functions inherited from opencpn_plugin_114
	opencpn_plugin_114 (void *pmgr)

Public Member Functions inherited from opencpn_plugin_113
	opencpn_plugin_113 (void *pmgr)

virtual bool	KeyboardEventHook (wxKeyEvent &event)

virtual void	OnToolbarToolDownCallback (int id)

virtual void	OnToolbarToolUpCallback (int id)

Public Member Functions inherited from opencpn_plugin_112
	opencpn_plugin_112 (void *pmgr)

virtual void	SendVectorChartObjectInfo (wxString &chart, wxString &feature, wxString &objname, double lat, double lon, double scale, int nativescale)

Public Member Functions inherited from opencpn_plugin_111
	opencpn_plugin_111 (void *pmgr)

Public Member Functions inherited from opencpn_plugin_110
	opencpn_plugin_110 (void *pmgr)

virtual void	LateInit (void)

Public Member Functions inherited from opencpn_plugin_19
	opencpn_plugin_19 (void *pmgr)

virtual void	OnSetupOptions (void)

Public Member Functions inherited from opencpn_plugin_18
	opencpn_plugin_18 (void *pmgr)

virtual bool	RenderOverlay (wxMemoryDC pmdc, PlugIn_ViewPort vp)

Public Member Functions inherited from opencpn_plugin
	opencpn_plugin (void *pmgr)

virtual int	GetToolbarToolCount (void)

virtual int	GetToolboxPanelCount (void)

virtual void	SetupToolboxPanel (int page_sel, wxNotebook *pnotebook)

virtual void	OnCloseToolboxPanel (int page_sel, int ok_apply_cancel)

virtual void	SetPositionFix (PlugIn_Position_Fix &pfix)

virtual void	SetNMEASentence (wxString &sentence)
	Receive all NMEA 0183 sentences from OpenCPN.

virtual void	SetAISSentence (wxString &sentence)
	Receive all AIS sentences from OpenCPN.

virtual void	ProcessParentResize (int x, int y)

virtual void	UpdateAuiStatus (void)

virtual wxArrayString	GetDynamicChartClassNameArray (void)

Public Attributes
GRIBOverlayFactory *	m_pGRIBOverlayFactory

int	m_MenuItem

bool	m_DialogStyleChanged

wxSize	m_coreToolbarSize

wxPoint	m_coreToolbarPosn

bool	m_bZoomToCenterAtInit

wxString	m_local_sources_catalog

double	m_boat_lat

double	m_boat_lon

double	m_boat_cog

double	m_boat_sog

time_t	m_boat_time

Detailed Description

Definition at line 88 of file grib_pi.h.

Constructor & Destructor Documentation

◆ grib_pi()

grib_pi::grib_pi ( void * ppimgr )

Definition at line 73 of file grib_pi.cpp.

◆ ~grib_pi()

grib_pi::~grib_pi ( void )

Definition at line 93 of file grib_pi.cpp.

Member Function Documentation

◆ DeInit()

bool grib_pi::DeInit ( void )

virtual

Reimplemented from opencpn_plugin.

Definition at line 174 of file grib_pi.cpp.

◆ GetAPIVersionMajor()

int grib_pi::GetAPIVersionMajor ( )

virtual

Reimplemented from opencpn_plugin.

Definition at line 187 of file grib_pi.cpp.

◆ GetAPIVersionMinor()

int grib_pi::GetAPIVersionMinor ( )

virtual

Reimplemented from opencpn_plugin.

Definition at line 189 of file grib_pi.cpp.

◆ GetCommonName()

wxString grib_pi::GetCommonName ( )

virtual

Reimplemented from opencpn_plugin.

Definition at line 197 of file grib_pi.cpp.

◆ GetCopyFirstCumRec()

bool grib_pi::GetCopyFirstCumRec ( )

inline

Returns true if cumulative parameters like precipitation and cloud cover should initialize their start values from the first record.

This avoids artificial zero values at the beginning of the time series.

Definition at line 148 of file grib_pi.h.

◆ GetCopyMissWaveRec()

bool grib_pi::GetCopyMissWaveRec ( )

inline

Returns true if wave data should be propagated across time periods where wave records are missing.

This ensures continuity of wave visualization even when data points are sparse.

Definition at line 156 of file grib_pi.h.

◆ GetCtrlBarXY()

wxPoint grib_pi::GetCtrlBarXY ( )

inline

Definition at line 137 of file grib_pi.h.

◆ GetCurrentViewPort()

PlugIn_ViewPort & grib_pi::GetCurrentViewPort ( )

inline

Definition at line 133 of file grib_pi.h.

◆ GetCursorDataXY()

wxPoint grib_pi::GetCursorDataXY ( )

inline

Definition at line 138 of file grib_pi.h.

◆ GetGRIBOverlayFactory()

GRIBOverlayFactory * grib_pi::GetGRIBOverlayFactory ( )

inline

Definition at line 159 of file grib_pi.h.

◆ GetLongDescription()

wxString grib_pi::GetLongDescription ( )

virtual

Reimplemented from opencpn_plugin.

Definition at line 201 of file grib_pi.cpp.

◆ GetPlugInBitmap()

wxBitmap * grib_pi::GetPlugInBitmap ( )

virtual

FIXME static wxBitmap* LoadSVG(const wxString filename, unsigned int width, unsigned int height) { if (!gFrame) return new wxBitmap(width, height); // We are headless.

#ifdef ANDROID return loadAndroidSVG(filename, width, height); #elif defined(ocpnUSE_SVG) wxSVGDocument svgDoc; if (svgDoc.Load(filename)) return new wxBitmap(svgDoc.Render(width, height, NULL, true, true)); else return new wxBitmap(width, height); #else return new wxBitmap(width, height); #endif }

wxBitmap* opencpn_plugin::GetPlugInBitmap() { auto bitmap = PluginLoader::getInstance()->GetPluginDefaultIcon(); return const_cast<wxBitmap*>(bitmap); }

Reimplemented from opencpn_plugin.

Definition at line 195 of file grib_pi.cpp.

◆ GetPlugInVersionMajor()

int grib_pi::GetPlugInVersionMajor ( )

virtual

Reimplemented from opencpn_plugin.

Definition at line 191 of file grib_pi.cpp.

◆ GetPlugInVersionMinor()

int grib_pi::GetPlugInVersionMinor ( )

virtual

Reimplemented from opencpn_plugin.

Definition at line 193 of file grib_pi.cpp.

◆ GetShortDescription()

wxString grib_pi::GetShortDescription ( )

virtual

Reimplemented from opencpn_plugin.

Definition at line 199 of file grib_pi.cpp.

◆ GetStartOptions()

int grib_pi::GetStartOptions ( )

inline

Definition at line 141 of file grib_pi.h.

◆ GetTimeZone()

int grib_pi::GetTimeZone ( )

inline

Definition at line 139 of file grib_pi.h.

◆ GetToolBarToolCount()

int grib_pi::GetToolBarToolCount ( void )

Definition at line 222 of file grib_pi.cpp.

◆ Init()

int grib_pi::Init ( void )

virtual

Reimplemented from opencpn_plugin.

Definition at line 99 of file grib_pi.cpp.

◆ MouseEventHook()

bool grib_pi::MouseEventHook ( wxMouseEvent & event )

virtual

Reimplemented from opencpn_plugin_112.

Definition at line 224 of file grib_pi.cpp.

◆ MoveDialog()

void grib_pi::MoveDialog	(	wxDialog *	dialog,
		wxPoint	position
	)

Definition at line 400 of file grib_pi.cpp.

◆ OnContextMenuItemCallback()

void grib_pi::OnContextMenuItemCallback ( int id )

virtual

Reimplemented from opencpn_plugin.

Definition at line 613 of file grib_pi.cpp.

◆ OnGribCtrlBarClose()

void grib_pi::OnGribCtrlBarClose ( )

Definition at line 530 of file grib_pi.cpp.

◆ OnToolbarToolCallback()

void grib_pi::OnToolbarToolCallback ( int id )

virtual

Reimplemented from opencpn_plugin.

Definition at line 422 of file grib_pi.cpp.

◆ QualifyCtrlBarPosition()

bool grib_pi::QualifyCtrlBarPosition	(	wxPoint	position,
		wxSize	size
	)

Definition at line 367 of file grib_pi.cpp.

◆ RenderGLOverlay()

bool grib_pi::RenderGLOverlay	(	wxGLContext *	pcontext,
		PlugIn_ViewPort *	vp
	)

virtual

Reimplemented from opencpn_plugin_18.

Definition at line 572 of file grib_pi.cpp.

◆ RenderGLOverlayMultiCanvas()

bool grib_pi::RenderGLOverlayMultiCanvas	(	wxGLContext *	pcontext,
		PlugIn_ViewPort *	vp,
		int	canvasIndex
	)

virtual

Reimplemented from opencpn_plugin_116.

Definition at line 598 of file grib_pi.cpp.

◆ RenderOverlay()

bool grib_pi::RenderOverlay	(	wxDC &	dc,
		PlugIn_ViewPort *	vp
	)

virtual

Reimplemented from opencpn_plugin_18.

Definition at line 555 of file grib_pi.cpp.

◆ RenderOverlayMultiCanvas()

bool grib_pi::RenderOverlayMultiCanvas	(	wxDC &	dc,
		PlugIn_ViewPort *	vp,
		int	canvasIndex
	)

virtual

Reimplemented from opencpn_plugin_116.

Definition at line 603 of file grib_pi.cpp.

◆ SendTimelineMessage()

void grib_pi::SendTimelineMessage ( wxDateTime time )

Definition at line 833 of file grib_pi.cpp.

◆ SetColorScheme()

void grib_pi::SetColorScheme ( PI_ColorScheme cs )

virtual

Reimplemented from opencpn_plugin.

Definition at line 823 of file grib_pi.cpp.

◆ SetCtrlBarSizeXY()

void grib_pi::SetCtrlBarSizeXY ( wxSize p )

inline

Definition at line 128 of file grib_pi.h.

◆ SetCtrlBarXY()

void grib_pi::SetCtrlBarXY ( wxPoint p )

inline

Definition at line 126 of file grib_pi.h.

◆ SetCurrentViewPort()

void grib_pi::SetCurrentViewPort ( PlugIn_ViewPort & vp )

inlinevirtual

Reimplemented from opencpn_plugin.

Definition at line 132 of file grib_pi.h.

◆ SetCursorDataXY()

void grib_pi::SetCursorDataXY ( wxPoint p )

inline

Definition at line 127 of file grib_pi.h.

◆ SetCursorLatLon()

void grib_pi::SetCursorLatLon	(	double	lat,
		double	lon
	)

virtual

Reimplemented from opencpn_plugin.

Definition at line 608 of file grib_pi.cpp.

◆ SetDefaults()

void grib_pi::SetDefaults ( void )

virtual

Reimplemented from opencpn_plugin.

Definition at line 220 of file grib_pi.cpp.

◆ SetDialogFont()

void grib_pi::SetDialogFont	(	wxWindow *	window,
		wxFont *	font = `OCPNGetFont(_("Dialog"), 0)`
	)

Definition at line 618 of file grib_pi.cpp.

◆ SetPluginMessage()

void grib_pi::SetPluginMessage	(	wxString &	message_id,
		wxString &	message_body
	)

virtual

Reimplemented from opencpn_plugin_18.

Definition at line 631 of file grib_pi.cpp.

◆ SetPositionFixEx()

void grib_pi::SetPositionFixEx ( PlugIn_Position_Fix_Ex & pfix )

virtual

Reimplemented from opencpn_plugin_18.

Definition at line 858 of file grib_pi.cpp.

◆ ShowPreferencesDialog()

void grib_pi::ShowPreferencesDialog ( wxWindow * parent )

virtual

Reimplemented from opencpn_plugin.

Definition at line 230 of file grib_pi.cpp.

◆ UpdatePrefs()

void grib_pi::UpdatePrefs ( GribPreferencesDialog * Pref )

Definition at line 291 of file grib_pi.cpp.

Member Data Documentation

◆ m_boat_cog

double grib_pi::m_boat_cog

Definition at line 171 of file grib_pi.h.

◆ m_boat_lat

double grib_pi::m_boat_lat

Definition at line 170 of file grib_pi.h.

◆ m_boat_lon

double grib_pi::m_boat_lon

Definition at line 170 of file grib_pi.h.

◆ m_boat_sog

double grib_pi::m_boat_sog

Definition at line 171 of file grib_pi.h.

◆ m_boat_time

time_t grib_pi::m_boat_time

Definition at line 172 of file grib_pi.h.

◆ m_bZoomToCenterAtInit

bool grib_pi::m_bZoomToCenterAtInit

Definition at line 168 of file grib_pi.h.

◆ m_coreToolbarPosn

wxPoint grib_pi::m_coreToolbarPosn

Definition at line 167 of file grib_pi.h.

◆ m_coreToolbarSize

wxSize grib_pi::m_coreToolbarSize

Definition at line 166 of file grib_pi.h.

◆ m_DialogStyleChanged

bool grib_pi::m_DialogStyleChanged

Definition at line 164 of file grib_pi.h.

◆ m_local_sources_catalog

wxString grib_pi::m_local_sources_catalog

Definition at line 169 of file grib_pi.h.

◆ m_MenuItem

int grib_pi::m_MenuItem

Definition at line 163 of file grib_pi.h.

◆ m_pGRIBOverlayFactory

GRIBOverlayFactory* grib_pi::m_pGRIBOverlayFactory

Definition at line 158 of file grib_pi.h.

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

/home/runner/work/main/main/opencpn/plugins/grib_pi/src/grib_pi.h
/home/runner/work/main/main/opencpn/plugins/grib_pi/src/grib_pi.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ grib_pi()

◆ ~grib_pi()

Member Function Documentation

◆ DeInit()

◆ GetAPIVersionMajor()

◆ GetAPIVersionMinor()

◆ GetCommonName()

◆ GetCopyFirstCumRec()

◆ GetCopyMissWaveRec()

◆ GetCtrlBarXY()

◆ GetCurrentViewPort()

◆ GetCursorDataXY()

◆ GetGRIBOverlayFactory()

◆ GetLongDescription()

◆ GetPlugInBitmap()

◆ GetPlugInVersionMajor()

◆ GetPlugInVersionMinor()

◆ GetShortDescription()

◆ GetStartOptions()

◆ GetTimeZone()

◆ GetToolBarToolCount()

◆ Init()

◆ MouseEventHook()

◆ MoveDialog()

◆ OnContextMenuItemCallback()

◆ OnGribCtrlBarClose()

◆ OnToolbarToolCallback()

◆ QualifyCtrlBarPosition()

◆ RenderGLOverlay()

◆ RenderGLOverlayMultiCanvas()

◆ RenderOverlay()

◆ RenderOverlayMultiCanvas()

◆ SendTimelineMessage()

◆ SetColorScheme()

◆ SetCtrlBarSizeXY()

◆ SetCtrlBarXY()

◆ SetCurrentViewPort()

◆ SetCursorDataXY()

◆ SetCursorLatLon()

◆ SetDefaults()

◆ SetDialogFont()

◆ SetPluginMessage()

◆ SetPositionFixEx()

◆ ShowPreferencesDialog()

◆ UpdatePrefs()

Member Data Documentation

◆ m_boat_cog

◆ m_boat_lat

◆ m_boat_lon

◆ m_boat_sog

◆ m_boat_time

◆ m_bZoomToCenterAtInit

◆ m_coreToolbarPosn

◆ m_coreToolbarSize

◆ m_DialogStyleChanged

◆ m_local_sources_catalog

◆ m_MenuItem

◆ m_pGRIBOverlayFactory