OpenCPN Partial API docs
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
CommBridge Class Reference

Process incoming messages. More...

#include <comm_bridge.h>

Inheritance diagram for CommBridge:

Public Member Functions

 CommBridge (const CommBridge &)=delete
 
CommBridge & operator= (const CommBridge &)=delete
 
bool Initialize ()
 
bool HandleN0183_AIVDO (const N0183MsgPtr &n0183_msg)
 Processes NMEA 0183 AIVDO sentences containing own vessel's AIS data.
 
bool EvalPriority (const NavMsgPtr &msg, PriorityContainer &active_priority, PriorityMap &priority_map)
 
std::vector< std::string > GetPriorityMaps () const
 
PriorityContainer & GetPriorityContainer (const std::string &category)
 
void UpdateAndApplyMaps (const std::vector< std::string > &new_maps)
 
bool LoadConfig ()
 
bool SaveConfig () const
 

Static Public Member Functions

static CommBridge & GetInstance ()
 

Detailed Description

Process incoming messages.

Listem to "known" messages and process them for example by broadcasting ship data. Also handles message source priorities i.e., which source to use for broadcasted data.

Definition at line 89 of file comm_bridge.h.

Member Function Documentation

◆ EvalPriority()

bool CommBridge::EvalPriority ( const NavMsgPtr &  msg,
PriorityContainer &  active_priority,
PriorityMap &  priority_map 
)

Definition at line 1245 of file comm_bridge.cpp.

◆ GetInstance()

CommBridge & CommBridge::GetInstance ( )
static

Definition at line 253 of file comm_bridge.cpp.

◆ GetPriorityContainer()

PriorityContainer & CommBridge::GetPriorityContainer ( const std::string &  category)

Definition at line 1169 of file comm_bridge.cpp.

◆ GetPriorityMaps()

std::vector< string > CommBridge::GetPriorityMaps ( ) const

Definition at line 536 of file comm_bridge.cpp.

◆ HandleN0183_AIVDO()

bool CommBridge::HandleN0183_AIVDO ( const N0183MsgPtr &  n0183_msg)

Processes NMEA 0183 AIVDO sentences containing own vessel's AIS data.

AIVDO messages provide navigation data broadcast by the vessel's own AIS transponder:

  • Position (latitude/longitude)
  • Movement (SOG/COG)
  • Heading (true heading)

The data is evaluated against other sources based on configured priorities. If accepted, the data updates the vessel's:

  • Position (if valid lat/lon received)
  • Speed and course (if valid SOG/COG received)
  • True heading (if valid HDT received)
Parameters
n0183_msgShared pointer to NMEA 0183 message containing AIVDO sentence
Returns
true if message was processed, false on decode error

Definition at line 1029 of file comm_bridge.cpp.

◆ Initialize()

bool CommBridge::Initialize ( )

Definition at line 278 of file comm_bridge.cpp.

◆ LoadConfig()

bool CommBridge::LoadConfig ( )

Definition at line 1190 of file comm_bridge.cpp.

◆ SaveConfig()

bool CommBridge::SaveConfig ( ) const

Definition at line 1222 of file comm_bridge.cpp.

◆ UpdateAndApplyMaps()

void CommBridge::UpdateAndApplyMaps ( const std::vector< std::string > &  new_maps)

Definition at line 1184 of file comm_bridge.cpp.

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