OpenCPN Partial API docs
Loading...
Searching...
No Matches
ConnectionParams Class Reference

Connection data container close to a POD struct. More...

#include <conn_params.h>

Public Member Functions

 ConnectionParams (const wxString &config_str)
std::string GetKey () const
 Return string unique for each instance.
wxString Serialize () const
void Deserialize (const wxString &config_str)
wxString GetPortDirectionValueStr () const
 Return translated name for direction, like _("Input").
wxString GetDSPort () const
 Return port description including for example serial port or network address/port, possibly empty.
bool IsPortValid () const
 Return true if port data like com port or network address are sane.
std::string GetLastDSPort () const
 Return Last known network "address:protocol:port" for network connections, else "Serial: <port>".
NavAddr::Bus GetCommProtocol () const
 Return NavAddr::Bus corresponding to network address/port or serial parameters.
NavAddr::Bus GetLastCommProtocol () const
 Return NavAddr::Bus corresponding to last known network address/port or serial parameters.
std::string GetStrippedDSPort () const
 Return port string with possible windows extra data removed, in some cases empty.
bool SentencePassesFilter (const wxString &sentence, FilterDirection direction) const
 Return true if given sentence and direction passes connection filters.

Public Attributes

ConnectionType type
NetworkProtocol net_protocol
DataProtocol data_protocol
wxString network_address
int network_port
wxString serial_port
wxString socket_can_port
PortDirection direction
DataProtocol last_data_protocol
NetworkProtocol last_net_protocol
bool auto_sk_discover
bool checksum_check
bool disable_echo
bool FurunoGP3X
bool GarminUpload
bool is_enabled
bool is_garmin
bool is_server
bool is_setup
bool is_valid
bool no_data_reconnect
int baudrate
int last_network_port
ListType input_sentence_list_type
ListType output_sentence_list_type
wxArrayString input_sentence_list
wxArrayString output_sentence_list
wxString auth_token
wxString last_network_address
wxString user_comment
ConnectionParamsPanel * options_panel

Detailed Description

Connection data container close to a POD struct.

Definition at line 76 of file conn_params.h.

Constructor & Destructor Documentation

◆ ConnectionParams() [1/2]

ConnectionParams::ConnectionParams ( )

Definition at line 74 of file conn_params.cpp.

◆ ConnectionParams() [2/2]

ConnectionParams::ConnectionParams ( const wxString & config_str)
explicit

Definition at line 70 of file conn_params.cpp.

Member Function Documentation

◆ Deserialize()

void ConnectionParams::Deserialize ( const wxString & config_str)

Definition at line 101 of file conn_params.cpp.

◆ GetCommProtocol()

NavAddr::Bus ConnectionParams::GetCommProtocol ( ) const
nodiscard

Return NavAddr::Bus corresponding to network address/port or serial parameters.

Definition at line 305 of file conn_params.cpp.

◆ GetDSPort()

wxString ConnectionParams::GetDSPort ( ) const
nodiscard

Return port description including for example serial port or network address/port, possibly empty.

Definition at line 200 of file conn_params.cpp.

◆ GetKey()

std::string ConnectionParams::GetKey ( ) const
nodiscard

Return string unique for each instance.

Definition at line 178 of file conn_params.cpp.

◆ GetLastCommProtocol()

NavAddr::Bus ConnectionParams::GetLastCommProtocol ( ) const
nodiscard

Return NavAddr::Bus corresponding to last known network address/port or serial parameters.

Definition at line 323 of file conn_params.cpp.

◆ GetLastDSPort()

std::string ConnectionParams::GetLastDSPort ( ) const
nodiscard

Return Last known network "address:protocol:port" for network connections, else "Serial: <port>".

Definition at line 251 of file conn_params.cpp.

◆ GetPortDirectionValueStr()

wxString ConnectionParams::GetPortDirectionValueStr ( ) const
nodiscard

Return translated name for direction, like _("Input").

Definition at line 190 of file conn_params.cpp.

◆ GetStrippedDSPort()

std::string ConnectionParams::GetStrippedDSPort ( ) const
nodiscard

Return port string with possible windows extra data removed, in some cases empty.

Definition at line 224 of file conn_params.cpp.

◆ IsPortValid()

bool ConnectionParams::IsPortValid ( ) const
nodiscard

Return true if port data like com port or network address are sane.

Definition at line 215 of file conn_params.cpp.

◆ SentencePassesFilter()

bool ConnectionParams::SentencePassesFilter ( const wxString & sentence,
FilterDirection direction ) const
nodiscard

Return true if given sentence and direction passes connection filters.

Definition at line 264 of file conn_params.cpp.

◆ Serialize()

wxString ConnectionParams::Serialize ( ) const
nodiscard

Definition at line 154 of file conn_params.cpp.

Member Data Documentation

◆ auth_token

wxString ConnectionParams::auth_token

Definition at line 110 of file conn_params.h.

◆ auto_sk_discover

bool ConnectionParams::auto_sk_discover

Definition at line 93 of file conn_params.h.

◆ baudrate

int ConnectionParams::baudrate

Definition at line 104 of file conn_params.h.

◆ checksum_check

bool ConnectionParams::checksum_check

Definition at line 94 of file conn_params.h.

◆ data_protocol

DataProtocol ConnectionParams::data_protocol

Definition at line 84 of file conn_params.h.

◆ direction

PortDirection ConnectionParams::direction

Definition at line 89 of file conn_params.h.

◆ disable_echo

bool ConnectionParams::disable_echo

Definition at line 95 of file conn_params.h.

◆ FurunoGP3X

bool ConnectionParams::FurunoGP3X

Definition at line 96 of file conn_params.h.

◆ GarminUpload

bool ConnectionParams::GarminUpload

Definition at line 97 of file conn_params.h.

◆ input_sentence_list

wxArrayString ConnectionParams::input_sentence_list

Definition at line 108 of file conn_params.h.

◆ input_sentence_list_type

ListType ConnectionParams::input_sentence_list_type

Definition at line 106 of file conn_params.h.

◆ is_enabled

bool ConnectionParams::is_enabled

Definition at line 98 of file conn_params.h.

◆ is_garmin

bool ConnectionParams::is_garmin

Definition at line 99 of file conn_params.h.

◆ is_server

bool ConnectionParams::is_server

Definition at line 100 of file conn_params.h.

◆ is_setup

bool ConnectionParams::is_setup

Definition at line 101 of file conn_params.h.

◆ is_valid

bool ConnectionParams::is_valid

Definition at line 102 of file conn_params.h.

◆ last_data_protocol

DataProtocol ConnectionParams::last_data_protocol

Definition at line 90 of file conn_params.h.

◆ last_net_protocol

NetworkProtocol ConnectionParams::last_net_protocol

Definition at line 91 of file conn_params.h.

◆ last_network_address

wxString ConnectionParams::last_network_address

Definition at line 111 of file conn_params.h.

◆ last_network_port

int ConnectionParams::last_network_port

Definition at line 105 of file conn_params.h.

◆ net_protocol

NetworkProtocol ConnectionParams::net_protocol

Definition at line 83 of file conn_params.h.

◆ network_address

wxString ConnectionParams::network_address

Definition at line 85 of file conn_params.h.

◆ network_port

int ConnectionParams::network_port

Definition at line 86 of file conn_params.h.

◆ no_data_reconnect

bool ConnectionParams::no_data_reconnect

Definition at line 103 of file conn_params.h.

◆ options_panel

ConnectionParamsPanel* ConnectionParams::options_panel

Definition at line 114 of file conn_params.h.

◆ output_sentence_list

wxArrayString ConnectionParams::output_sentence_list

Definition at line 109 of file conn_params.h.

◆ output_sentence_list_type

ListType ConnectionParams::output_sentence_list_type

Definition at line 107 of file conn_params.h.

◆ serial_port

wxString ConnectionParams::serial_port

Definition at line 87 of file conn_params.h.

◆ socket_can_port

wxString ConnectionParams::socket_can_port

Definition at line 88 of file conn_params.h.

◆ type

ConnectionType ConnectionParams::type

Definition at line 82 of file conn_params.h.

◆ user_comment

wxString ConnectionParams::user_comment

Definition at line 112 of file conn_params.h.

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