OpenCPN Partial API docs
Loading...
Searching...
No Matches
CommDriverRegistry Class Referencefinal

Registry for active, running drivers. More...

#include <comm_drv_registry.h>

Public Member Functions

void Activate (DriverPtr driver)
 Add driver to list of active drivers. More...
 
void Deactivate (DriverPtr driver)
 Remove driver from list of active drivers. More...
 
void CloseAllDrivers ()
 Close and destroy all drivers completely. More...
 
const std::vector< DriverPtr > & GetDrivers ()
 
void TestDriver (ConnectionParams *params)
 

Static Public Member Functions

static CommDriverRegistryGetInstance ()
 

Public Attributes

EventVar evt_driverlist_change
 Notified by all driverlist updates. More...
 
EventVar evt_driver_msg
 Notified for messages from drivers. More...
 

Detailed Description

Registry for active, running drivers.

Definition at line 42 of file comm_drv_registry.h.

Member Function Documentation

◆ Activate()

void CommDriverRegistry::Activate ( DriverPtr  driver)

Add driver to list of active drivers.

Definition at line 38 of file comm_drv_registry.cpp.

◆ CloseAllDrivers()

void CommDriverRegistry::CloseAllDrivers ( )

Close and destroy all drivers completely.

Definition at line 56 of file comm_drv_registry.cpp.

◆ Deactivate()

void CommDriverRegistry::Deactivate ( DriverPtr  driver)

Remove driver from list of active drivers.

Definition at line 45 of file comm_drv_registry.cpp.

◆ GetDrivers()

const std::vector< DriverPtr > & CommDriverRegistry::GetDrivers ( )
Returns
List of all activated drivers.

Definition at line 52 of file comm_drv_registry.cpp.

◆ GetInstance()

CommDriverRegistry & CommDriverRegistry::GetInstance ( )
static

Definition at line 62 of file comm_drv_registry.cpp.

Member Data Documentation

◆ evt_driver_msg

EventVar CommDriverRegistry::evt_driver_msg

Notified for messages from drivers.

The generated event contains:

  • A wxLogLevel stored as an int.
  • A string is with a prefix from originating driver class name e. g., "CommDriverN2KSerial: Something happened"

Definition at line 73 of file comm_drv_registry.h.

◆ evt_driverlist_change

EventVar CommDriverRegistry::evt_driverlist_change

Notified by all driverlist updates.

Definition at line 65 of file comm_drv_registry.h.


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