OpenCPN Partial API docs
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123]
 Ncatalog_mgr
 Ndownload_mgr
 NocpnStyle
 Nstd
 C_Extent
 C_ExtentPI
 C_OEdgeTableEntry
 C_OGdkPoint
 C_OGdkRectangle
 C_OGdkRegion
 C_OGdkSegment
 C_OPOINTBLOCK
 C_OScanLineList
 C_OScanLineListBlock
 C_OSENC_AreaGeometry_Record_Base
 C_OSENC_AreaGeometry_Record_Payload
 C_OSENC_Attribute_Record
 C_OSENC_Attribute_Record_Base
 C_OSENC_Attribute_Record_Payload
 C_OSENC_COVR_Record
 C_OSENC_COVR_Record_Base
 C_OSENC_COVR_Record_Payload
 C_OSENC_EXTENT_Record
 C_OSENC_EXTENT_Record_Payload
 C_OSENC_Feature_Identification_Record_Base
 C_OSENC_Feature_Identification_Record_Payload
 C_OSENC_LineGeometry_Record_Base
 C_OSENC_LineGeometry_Record_Payload
 C_OSENC_MultipointGeometry_Record_Base
 C_OSENC_MultipointGeometry_Record_Payload
 C_OSENC_NOCOVR_Record
 C_OSENC_NOCOVR_Record_Base
 C_OSENC_NOCOVR_Record_Payload
 C_OSENC_PointGeometry_Record
 C_OSENC_PointGeometry_Record_Payload
 C_OSENC_Record
 C_OSENC_Record_Base
 C_OSENC_VCT_Record
 C_OSENC_VCT_Record_Base
 C_OSENC_VET_Record
 C_OSENC_VET_Record_Base
 C_SYSTEMTIME
 C_TIME_ZONE_INFORMATION
 Cabbr_entry
 Cabout
 CAboutFrameClass AboutFrame
 CAboutFrameImpl
 CAbstractBlacklistPlugins could be blacklisted in runtime if they are unloadable or in hardcoded, compile-time list
 CAbstractCommDriverCommon interface for all drivers
 CAbstractPlatform
 CAbstractRestServerOpencpn REST API
 CAcceptObjectDialog"Accept Object" Dialog Definition
 CAcceptObjectDlgResultReturned status from RunAcceptObjectDlg
 CActiveLegDat
 CActiveTrack
 CAdapterInfo
 CAddPluginPanel
 CAdvancedCatalogDialogCatalog handler GUI
 CAis8_001_22
 CAis8_001_22_SubArea
 CAisBitstring
 CAisDataAIS data point for a vessel
 CAisDecoder
 CAisDecoderCallbacks
 CAisInfoGui
 CAisMeteoDataMeteo points are Meteorological and Hydrographic data received by NMEA0183 (AIS) VDM message 8 dac:001 fi: 31 or Ais8_367_33
 CAisMeteoPointAdd a new point to the list of Meteo stations
 CAisMeteoPointsList of Meteo stations, a singleton
 CAISTargetAlertDialog
 CAisTargetCallbacks
 CAisTargetData
 CAisTargetDataMakerSingleton factory
 CAISTargetListDialog
 CAISTargetQueryDialog
 CAISTargetTrackPoint
 CAnnunText
 CAppMsg
 CAppMsgBusApplication layer messaging, a singleton
 Catomic_queue
 CBasePlatform
 CBasicNavDataMsg
 CBlacklistUIHandle messages for blacklisted plugins
 CblockRuntime representation of a plugin block
 CButtonsSizerThe Done button
 CCachedLine
 CCacheEntry
 CCacheSizer
 CCandidateButtonsPanelThe two buttons 'install' and 'website', the latter optionally hidden
 CCanHeaderCAN v2.0 29 bit header as used by NMEA 2000
 CcanvasConfig
 CCanvasConfigSelect
 CCanvasMenuHandler
 CCanvasOptions
 CCatalogChoiceSelect master, beta, alpha, custom drop-down
 CCatalogCtxThe result from parsing the xml catalog i
 CCatalogDataDatatypes and methods to parse ocpn-plugins.xml XML data, either complete catalog or a single plugin
 CCatalogEntry
 CCatalogEntryKey
 CCatalogEntryValue
 CCatalogHandlerPlugin catalog management: Check for available versions and branches, download as required
 CCatalogMgrPanel
 CCatalogSettingsDialogModal dialog, displays settings for plugin catalog
 CCatalogSizerCatalog channel selection panel
 CCDI
 CCell_Info_Block
 CChartBarWin
 CChartBase
 CChartBaseBSB
 CChartCanvas
 CChartClassDescriptor
 CChartDatabase
 CChartDB
 CChartDirInfo
 CChartDirPanelHardBreakWrapper
 CChartDummy
 CChartGEO
 CChartGroup
 CChartGroupElement
 CChartGroupsUI
 CChartKAP
 CChartMBTiles
 CChartPlugInWrapper
 CChartStack
 CChartTableEntry
 CChartTableEntry_onDisk_14
 CChartTableEntry_onDisk_15
 CChartTableEntry_onDisk_16
 CChartTableEntry_onDisk_17
 CChartTableEntry_onDisk_18
 CChartTableHeader
 CChInfoWin
 Ccircular_buffer
 CCliPlatformAbstractPlatform adapted for console/CLI usage
 Ccm93_attr_block
 Ccm93_dictionary
 Ccm93_point
 Ccm93_point_3d
 Ccm93chart
 Ccm93compchart
 Ccm93manager
 CCM93OffsetDialog
 CCommBridge
 CCommDecoder
 CCommDriverN0183
 CCommDriverN0183AndroidBT
 CCommDriverN0183AndroidBTEvent
 CCommDriverN0183AndroidInt
 CCommDriverN0183AndroidIntEvent
 CCommDriverN0183Net
 CCommDriverN0183NetEvent
 CCommDriverN0183Serial
 CCommDriverN0183SerialEvent
 CCommDriverN0183SerialThread
 CCommDriverN2K
 CCommDriverN2KNet
 CCommDriverN2KNetEvent
 CCommDriverN2KSerial
 CCommDriverN2KSerialEvent
 CCommDriverN2KSerialThread
 CCommDriverN2KSocketCAN
 CCommDriverN2KSocketCanImplLocal driver implementation, not visible outside this file
 CCommDriverRegistryThe global driver registry, a singleton
 CCommDriverSignalK
 CCommDriverSignalKNet
 CCommDriverSignalKNetEvent
 CCommDriverSignalKNetThread
 CCommOutQueueQueue of NMEA0183 messages which only holds a limited amount of each message type
 CCommOutQueueSingleA CommOutQueue limited to one message of each kind
 CCommOverflowDlg
 CCompatOs
 CCompatSizerPlugin compatibility panel
 CCompatTextCurrent selected compatibility
 Ccompress_target
 CCompressedCacheHeader
 CCompressionPoolThread
 Cconfig_blockHardcoded representation of a blocked plugin
 CConfigCreateDialog
 CConfigMgrManages the user config matrix
 CConfigPanel
 CConfigVarWrapper for configuration variables which lives in a wxBaseConfig object
 CConnBoldLabelA wxStaticText bold label with correct width, see #2538
 CConnectionEditDialog
 CConnectionParams
 CConnectionParamsPanel
 CConnectionsDialog
 CConsoleCanvas
 CContourRegion
 CCopyableTextNon-editable TextCtrl, used like wxStaticText but is copyable
 Ccovr_set
 Ccpo_sat_data
 CCustomCatalogCtrlThe custom URL text entry
 CCustomMsgA generic message containing a const pointer to basically anything, the pointer neds to be casted to the proper type on the receiving side
 CD800_Pvt_Data_Type
 CD800_Pvt_Data_Type_Aligned
 CDataPrioNeededIssued when there are multiple sources providing 'what' with priority == 0
 CDATUM
 CDB_HEADER_PUBLIC
 CDbusCtxEvent handler context
 CDbusInstanceCheckInstanceCheck implementation based on DBus
 CDbusLocalClientImplement LocalClientApi on linux using Dbus mechanisms
 CDbusServerBasic interface to low-level DBus library
 Cdevice_data
 CDownloaderHandle downloading of files from remote urls
 CdPoint
 CDriverListenerInterface implemented by transport layer and possible other parties like test code which should handle incoming messages
 CDummyCommOutQueueSimple FIFO queue without added logic
 CDummyInstanceChkEmpty place holder, primarely for Android
 CDummyIpcClient
 CDummyIpcServerUseless place holder for LocalServerApi
 CDummyTextCtrl
 CDummyWatchDaemonEmpty placeholder, does not do anything meaningful
 CELLIPSOID
 Cemboss_data
 CEnumClassHash
 CEventVarGeneric event handling between MVC Model and Controller based on a shared EventVar variable
 CFastMessageMapTrack fast message fragments eventually forming complete messages
 CFileCommDriverRead and write data to/from files test driver
 CFindCM93Dictionary
 CFirstUseWizClass FirstUseWiz
 CFirstUseWizImpl
 CFlexHash
 Cfont_cache_record
 CFontMgrManages the font list
 CGARMIN_Serial_Thread
 CGARMIN_USB_Thread
 CGarminProtocolHandler
 CGenericPosDatEx
 CGeodesic
 Cgeometry_descriptor
 CGeoRef
 CglChartCanvas
 CGlobalVarWrapper for global variable, supports notification events when value changes
 CGLShaderProgram
 CglTestCanvas
 CglTexFactory
 CglTexTile
 CglTextureDescriptor
 CglTextureManager
 CGnssFixGPS, Galileo, etc
 CGoToPositionDialog
 CGPSWatchdogMsg
 CGpxDocument
 CGSHHSChart
 CGshhsPoint
 CGshhsPolyCell
 CGshhsPolygon
 CGshhsPolyReader
 CGshhsReader
 CGuiDownloaderAdd progress and final message dialogs to the basic Downloader
 CHardBreakWrapper
 Charmonic_file_entry
 Cheader_struct
 CHostHost ABI encapsulation and plugin compatibility checks
 CHyperlink
 CIDX_entry
 CiENCToolbar
 CInstallButtonDownload and install a PluginMetadata item when clicked
 CInstanceCheckCommon interface for all instance checkers
 CInstanceHandler
 CIpcClient
 CIpcClientConnectionImplement LocalClientApi using a filesystem fifo/socket
 CIpcConnectionStarted by IpcServer on filesystem fifo/socket connects
 CIpcServerImplement LocalServerApi using a filesystem fifo/socket
 CJobTicket
 CJsonEventHandle sending of wxJson messages to all plugins
 CKEY
 CKeyProviderInterface implemented by classes which listens
 CKml
 CKmlFormatDialog
 CLatLonKeyLatitude/longitude key for 1 degree cells
 CLatLonTextCtrl
 CLayer
 CLinkPropDlgDefClass LinkPropDlgDef
 CLinkPropImplClass LinkPropImpl
 CLinuxUsbWatchDaemonListen to DBus system bus signals reflecting for example suspend/resume, new USB devicesbeing plugged in, etc; update EventVars in SysEvents accordingly
 CListenersByKeyPrivate helper class
 Clm_control_type
 Clm_data_type
 CLoadError
 CLoadErrorsDlgUnloadable plugins report message box
 CLoadErrorsDlgCtrlRun a dialog if there are load errors encountered in plugin_loader
 CLocalApiException
 CLocalClientApiBase interface for local clients
 CLocalServerApiBase interface for local server command handling
 CLoggerTransient logger class, instantiated/used by the LOG macros
 CM_COVR_Desc
 CMarkIcon
 CMarkInfoDlgClass MarkInfoDef
 CMdnsCacheSingleton cache for hosts looked up using mdns
 CMeasuredCommOutQueueAdd unit test measurements to CommOutQueue
 CMemoryStruct
 CMessageHardBreakWrapper
 CMMSI_Props_Panel
 CMMSIEditDialog
 CMMSIListCtrl
 CMmsiProperties
 CModuleInfo
 CMouseZoom
 CMouseZoomSlider
 CMrqContainer
 Cmru_entry
 CMUIBar
 CMUIButton
 CMUITextButton
 CMultiplexer
 CMuxLogCallbacks
 CMyApp
 CMyConfig
 CMyFlPoint
 CMyFontDesc
 CMyFrame
 CMyPrintout
 CMyRoutePrintout
 CMyTrackPrintout
 Cn0183_atomic_queue
 CN0183DlgCtx
 Cn2k_atomic_queue
 CN2kNameN2k uses CAN which defines the basic properties of messages
 CN2kPGN
 CNavAddrWhere messages are sent to or received from
 CNavAddr0183
 CNavAddr2000
 CNavAddrPlugin
 CNavAddrSignalK
 CNavAddrTest
 CNavData
 CNavDataIdFacade for BasicNavDataMsg
 CNavMsgActual data sent between application and transport layer
 CNavMsgBusThe raw message layer, a singleton
 CNavObjectChanges
 CNavObjectCollection1
 CNMEA0183IdFacade for NavAddr0183
 CNmea0183MsgA regular Nmea0183 message
 CNMEA2000IdFacade for NavAddr2000
 CNmea2000MsgSee: https://github.com/OpenCPN/OpenCPN/issues/2729#issuecomment-1179506343
 CNmeaLog
 CNMEALogWindowThis class provides access to the NMEA log/debug window
 CNullNavMsgAn invalid message, error return value
 CObject
 COBRESINFO
 CObservableThe observable notify/listen basic nuts and bolts
 CObservableListenerKeeps listening over it's lifespan, removes itself on destruction
 CObservedEvtAdds a std::shared<void> element to wxCommandEvent
 CObsListenerDefine an action to be performed when a KeyProvider is notified
 CocpCursor
 COCPN_AlertDialog
 COCPN_AUIManager
 COCPN_BUILDSENC_ThreadEvent
 COCPN_CompressionThreadEvent
 Cocpn_DNS_record_t
 COCPN_downloadEvent
 COCPN_GLCaps
 COCPN_MonitorInfoStructure to hold information about a monitor
 COCPN_MsgEvent
 COCPN_OSDetail
 COCPN_ThreadMessageEvent
 COCPN_TimedHTMLMessageDialog
 COCPNChartDirPanel
 COCPNCheckedListCtrl
 COCPNColourPickerCtrl
 CocpnCompass
 COCPNConfigCatalog
 COCPNConfigObject
 CocpnDC
 COCPNFatCombo
 CocpnFloatingToolbarDialog
 COCPNFontPreviewer
 CocpnGenericFontDialog
 CocpnGLOptions
 COCPNIconCombo
 COCPNListCtrl
 COcpnLogLogging interface
 CocpnMemDC
 COCPNMessageDialog
 COCPNOffsetListCtrl
 COCPNPlatform
 COCPNRegion
 COCPNRegionIterator
 COCPNRegionRefData
 COCPNSoundPanel
 COCPNStopWatch
 CocpnToolBarSimple
 CocpnToolBarTool
 COCPNTrackListCtrl
 COcpnUpdateScrolledWindowThe list of download candidates in a scrolled window + OK and Settings button
 COCPNwxFontList
 COEdgeTable
 Copencpn_plugin
 Copencpn_plugin_110
 Copencpn_plugin_111
 Copencpn_plugin_112
 Copencpn_plugin_113
 Copencpn_plugin_114
 Copencpn_plugin_115
 Copencpn_plugin_116
 Copencpn_plugin_117
 Copencpn_plugin_118
 Copencpn_plugin_16
 Copencpn_plugin_17
 Copencpn_plugin_18
 Copencpn_plugin_19
 CopncpnPalette
 Coptions
 COsenc
 COsenc_instream
 COsenc_instreamFile
 COsenc_outstream
 COsenc_outstreamFile
 CPanelHardBreakWrapper
 CParseENCWorkerThread
 CPeerData
 CPerfCounter
 CPI_DLEvtHandler
 CPI_line_segment_element
 CPI_S57Obj
 CPiano
 CPianoKeyElement
 CPincodeA random generated int value with accessors for string and hashcode
 CPinConfirmDlg
 CPINCreateDialog
 CPixelCache
 CPlatformChoiceSelect compatibility drop-down
 CPlatSpec
 Cplug_data
 CPlugBlacklist
 CPluginPlugin ABI encapsulation
 CPlugin_Active_Leg_Info
 CPlugIn_AIS_Target
 CPlugin_Hyperlink
 CPlugIn_Position_Fix
 CPlugIn_Position_Fix_Ex
 CPlugIn_Route
 CPlugIn_Route_Ex
 CPlugIn_Track
 CPlugIn_ViewPort
 CPlugIn_Waypoint
 CPlugIn_Waypoint_Ex
 CPlugInChartBase
 CPlugInChartBaseExtended
 CPlugInChartBaseExtendedPlus2
 CPlugInChartBaseGL
 CPlugInChartBaseGLPlus2
 CPlugInContainerData for a loaded plugin, including dl-loaded library
 CPlugInDataBasic data for a loaded plugin, trivially copyable
 CPluginDownloadDialog
 CPluginHandler
 CPluginIconPanelA plugin icon, scaled to about 2/3 of available space
 CPluginListPanel
 CPluginLoaderPluginLoader is a backend module without any direct GUI functionality
 CPlugInManager
 CPlugInMenuItemContainer
 CPluginMetadataPlugin metadata, reflects the xml format directly
 CPluginMsgA plugin to plugin json message over the REST interface
 CPluginMsgIdFacade for NavAddrPluginMsg
 CPluginNavdataAvailable decoded data for plugins
 CPluginPanel
 CPluginPaths
 CPluginTextPanelPlugin name, version, summary + an optionally shown description
 CPlugInToolbarToolContainer
 CpluginUtilHandler
 CPlypoint
 CPolygonFileHeader
 CPopUpDSlide
 CPosition
 CPositionParser
 CPrintCellThis class takes multilined string and modifies it to fit into given width for given device
 CPrintTableExtension of a class Table with printing into dc
 CPriorityContainer
 CPriorityDlg
 CPriorityEntry
 Cproduct_info
 CProgressInfoItem
 CQuilt
 CQuiltCandidate
 CQuiltPatch
 CRefpoint
 CRestIoEvtData
 CRestServerAbstractRestServer implementation and interface to underlying IO thread
 CRestServerDlgCtxCallbacks for handling dialogs and RouteManager updates
 CRolloverWin
 CRoute
 CRouteCtxCallbacks for handling routes and tracks
 CRouteGui
 CRouteman
 CRouteManagerDialog
 CRoutemanDlgCtxRouteman callbacks
 CRoutemanGui
 CRoutePoint
 CRoutePointGui
 CRoutePrintSelection
 CRoutePropDlgClass RoutePropDlg
 CRoutePropDlgCtxCallbacks for RoutePropDlg
 CRoutePropDlgImpl
 CS52PLIB_Context
 Cs57chart
 CS57ExtraQueryInfoDlg
 CS57Light
 CS57ObjectDesc
 CS57QueryDialog
 Cs57Sector_t
 CSaveDefaultsDialogClass SaveDefaultsDialog
 Cscale
 Csegment_pair
 CSelect
 CSelectCtx
 CSelectItem
 CSemanticVersionVersions uses a modified semantic versioning scheme: major.minor.revision.post-tag+build
 CSENCBuildThread
 CSENCJobTicket
 CSENCThreadManager
 CSendToGpsDlgRoute "Send to GPS..." Dialog Definition
 CSendToPeerDlgRoute "Send to Peer..." Dialog Definition
 CSentenceListDlg
 Cservice_t
 CSetScaleDialog
 CShapeBaseChartBasemap
 CShapeBaseChartSetSet of basemaps at different resolutions
 CSignalkIdFacade for NavAddrSignalK
 CSignalkMsgA parsed SignalK message over ipv4
 CSimpleCatalogDialog
 Cssfn_font_t
 Cssfn_glyph_t
 Cssfn_t
 CStation_Data
 CStClient
 CStConnection
 CStdInstanceCheckInstanceCheck implementation based on <unistd.h> i
 CStServer
 CSubTrack
 CSVGBitmapCache
 Csymlink
 CSystemEvents
 CTableRepresents a NxM simple table with captions
 CTCDataFactory
 CTCDataSource
 CTCDS_Ascii_Harmonic
 CTCDS_Binary_Harmonic
 CTCMgr
 CTCWin
 CThumbData
 CThumbWin
 CTIDE_HEADER_DATA
 CTIDE_INDEX
 CTIDE_RECORD
 CTIDE_STATION_HEADER
 CTileOffsetCache
 CTimeCtrl
 CTimedMessageBox
 CTimedPopupWin
 CToolbarChoicesDialog
 CToolbarItemContainer
 CToolbarMOBDialog
 CToolTipWin
 CTrack
 CTrackGui
 CTrackPoint
 CTrackPointGui
 CTrackPrintSelection
 CTrackPropDlgClass TrackPropDlg
 CTTYScroll
 CTTYWindow
 Ctz_info_entry
 CUncopyable
 CUndo
 CUndoAction
 Cunit
 Cunit_info_type_
 CUpdateDialogModal dialog, displays available updates (possibly just one) and lets user select and eventually confirm update
 CUpdateWebsiteButtonInvokes client browser on plugin info_url when clicked
 Cusbdata
 CUSBDevice
 CUsbListenFrame
 CUsbWatchDaemonListen to hardware events and notifies SystemEvents when new devices are plugged in
 Cvector_record_descriptor
 CViewPort
 CVoidDriverListener
 CWaitContinue
 CWatchdogs
 CWayPointman
 CWayPointmanGui
 CWebsiteButtonInvokes client browser on plugin info_url when clicked
 CWebSocketThread
 CWindowDestroyListener
 CWinUsbWatchDaemonListen to OS signals reflecting for example suspend/resume, new USB devicesbeing plugged in, etc; update EventVars in SysEvents accordingly
 CWorkerManages reading the N2K data stream provided by some N2K gateways from the declared serial port
 CwxCrashPrintWxCrashPrint
 CWxInstanceCheckThin wrapper for wxSingleInstanceChecker implementing InstanceCheck
 CwxLineF