main/api-docs/config__vars_8cpp_source.html

/***************************************************************************

 *   Copyright (C) 2023 - 2025 Alec Leamas                                 *

 *                                                                         *

 *   This program is free software; you can redistribute it and/or modify  *

 *   it under the terms of the GNU General Public License as published by  *

 *   the Free Software Foundation; either version 2 of the License, or     *

 *   (at your option) any later version.                                   *

 *                                                                         *

 *   This program is distributed in the hope that it will be useful,       *

 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *

 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *

 *   GNU General Public License for more details.                          *

 *                                                                         *

 *   You should have received a copy of the GNU General Public License     *

 *   along with this program; if not, see <https://www.gnu.org/licenses/>. *

 **************************************************************************/


#include <vector>


#include "model/config_vars.h"

#include "config.h"


bool g_allow_arb_system_plugin = false;

bool g_always_send_rmb_rmc = false;

bool g_bAISRolloverShowClass = false;

bool g_bAISRolloverShowCOG = false;

bool g_bAISRolloverShowCPA = false;

bool g_bAllowShipToActive = false;

bool g_bAutoAnchorMark = false;

bool g_bAutoHideToolbar = false;

bool g_bBasicMenus = false;

bool g_bConfirmObjectDelete = false;

bool g_bCourseUp = false;

bool g_bDebugCM93 = false;

bool g_bDebugGPSD = false;

bool g_bDebugOGL = false;

bool g_bDebugS57 = false;

bool g_bDisplayGrid = false;

bool g_bEmailCrashReport = false;

bool g_benable_rotate = false;

bool g_benableUDPNullHeader = false;

bool g_bEnableZoomToCursor = false;

bool g_bfilter_cogsog = false;

bool g_bframemax = false;

bool g_bFullscreen = false;

bool g_bFullScreenQuilt = true;

bool g_bFullscreenToolbar = false;

bool g_bGarminHostUpload = false;

bool g_bGDAL_Debug = false;

bool g_bGLexpert = false;

bool g_bHighliteTracks = false;

bool g_bInlandEcdis = false;

bool g_bLookAhead = false;

bool g_bMagneticAPB = false;

bool g_bNavAidRadarRingsShown = false;

bool g_bopengl = false;

bool g_bOverruleScaMin = false;

bool g_bPermanentMOBIcon = false;

bool g_bPlayShipsBells = false;

bool g_bPreserveScaleOnX = false;

bool g_bQuiltEnable = false;

bool g_bQuiltStart = false;

bool g_bresponsive = false;

bool g_bRollover = false;

bool g_bShowActiveRouteHighway = false;

bool g_bShowChartBar = false;

bool g_bShowCompassWin = false;

bool g_bShowCurrent = false;

bool g_bShowDepthUnits = false;

bool g_bShowDetailSlider = false;

bool g_bShowLayers = false;

bool g_bShowLiveETA = false;

bool g_bShowMag = false;

bool g_bShowMenuBar = false;

bool g_bShowMuiZoomButtons = true;

bool g_bShowOutlines = false;

bool g_bShowRouteTotal = false;

bool g_bShowShipToActive = false;

bool g_bShowStatusBar = false;

bool g_bShowTide = false;

bool g_bShowTrackPointTime = false;

bool g_bShowTrue = false;

bool g_bShowWptName = false;

bool g_bsimplifiedScalebar = false;

bool g_bskew_comp = false;

bool g_bsmoothpanzoo = false;

bool g_bsmoothpanzoom = false;

bool g_bSoftwareGL = false;

bool g_bSpaceDropMark = false;

bool g_btenhertz = false;

bool g_btouch = false;

bool g_btrackContinuous = false;

bool g_bTrackDaily = false;

bool g_bTransparentToolbar = false;

bool g_bUIexpert = false;

bool g_bUseGLL = true;

bool g_bUseGreenShip = false;

bool g_bUseOnlyConfirmedAISName = false;

bool g_bUserIconsFirst = true;

bool g_bUseWptScaMin = false;

bool g_bWayPointPreventDragging = false;

bool g_bWplUsePosition = false;

bool g_config_display_size_manual = false;

bool g_declutter_anchorage = false;

bool g_enable_root_menu_debug = false;

bool g_fog_overzoom = false;

bool g_own_ship_sog_cog_calc = false;

bool g_oz_vector_scale = false;

bool g_persist_active_route = false;

bool g_useMUI = false;

bool s_bSetSystemTime = false;

bool g_kiosk_startup = false;


double g_COGAvg = 0.0;

double g_defaultBoatSpeed = 0.0;

double g_display_size_mm = 0.0;

double g_mouse_zoom_sensitivity = 0.0;

double g_n_arrival_circle_radius = 0.0;

double g_n_gps_antenna_offset_x = 0.0;

double g_n_gps_antenna_offset_y = 0.0;

double g_n_ownship_beam_meters = 0.0;

double g_n_ownship_length_meters = 0.0;

double g_overzoom_emphasis_base = 0.0;

double g_ownship_HDTpredictor_miles = 0.0;

double g_ownship_predictor_minutes = 0.0;

double g_PlanSpeed = 0.0;

double g_plus_minus_zoom_factor = 0.0;

double g_TrackDeltaDistance = 0.0;

double g_TrackIntervalSeconds = 0.0;

double g_UserVar = 0.0;


float g_fNavAidRadarRingsStep = 0.0;

float g_fWaypointRangeRingsStep = 0.0;

float g_GLMinSymbolLineWidth = 0.0;

float g_MarkScaleFactorExp = 0.0;

float g_selection_radius_mm = 2.0;

float g_selection_radius_touch_mm = 10.0;

float g_ShipScaleFactorExp = 0.0;


int g_ais_cog_predictor_width = 0;

int g_AndroidVersionCode = 0;

int g_BSBImgDebug = 0;

int g_ChartScaleFactor = 0;

int g_chart_zoom_modifier_raster = 0;

int g_chart_zoom_modifier_vector = 0;

int g_cm93_zoom_factor = 0;

int g_COGAvgSec = 15;

int g_COGFilterSec = 1;

int g_cog_predictor_endmarker = 0;

int g_cog_predictor_style = 0;

int g_cog_predictor_width = 0;

int g_default_font_size = 0;

int g_detailslider_dialog_x = 0;

int g_detailslider_dialog_y = 0;

int g_ENCSoundingScaleFactor = 0;

int g_ENCTextScaleFactor = 0;

int g_GUIScaleFactor = 0;

int g_iDistanceFormat = 0;

int g_iENCToolbarPosX = 0;

int g_iENCToolbarPosY = 0;

int g_iHeightFormat = 0;

int g_iNavAidRadarRingsNumberVisible = 0;

int g_iSDMMFormat = 0;

int g_iSoundDeviceIndex = 0;

int g_iSpeedFormat = 0;

int g_iTempFormat = 0;

int g_iWaypointRangeRingsNumber = 0;

int g_iWaypointRangeRingsStepUnits = 0;

int g_iWindSpeedFormat = 0;

int g_iWpt_ScaMin = 0;

int g_lastClientRecth = 0;

int g_lastClientRectw = 0;

int g_lastClientRectx = 0;

int g_lastClientRecty = 0;

int g_maintoolbar_x = 0;

int g_maintoolbar_y = 0;

int g_maxWPNameLength;

int g_maxzoomin = 0;

int g_mbtilesMaxLayers = 2;

int g_memCacheLimit = 0;

int g_MemFootMB = 0;

int g_mouse_zoom_sensitivity_ui = 0;

int g_nAutoHideToolbar = 0;

int g_navobjbackups = 1;

int g_nAWDefault = 0;

int g_nAWMax = 0;

int g_nbrightness = 100;

int g_nCacheLimit = 0;

int g_nCOMPortCheck = 32;

int g_nCPUCount = 0;

int g_nDepthUnitDisplay = 0;

int g_netmask_bits = 24;

int g_nframewin_posx = 0;

int g_nframewin_posy = 0;

int g_nframewin_x = 0;

int g_nframewin_y = 0;

int g_NMEAAPBPrecision = 3;

int g_nNMEADebug = 0;

int g_n_ownship_min_mm = 0;

int g_nTrackPrecision = 0;

int g_ownship_HDTpredictor_endmarker = 0;

int g_ownship_HDTpredictor_style = 0;

int g_ownship_HDTpredictor_width = 0;

int g_OwnShipIconType = 0;

int g_own_ship_sog_cog_calc_damp_sec = 0;

int g_pNavAidRadarRingsStepUnits = 0;

int gps_watchdog_timeout_ticks = 0;

int g_restore_dbindex = 0;

int g_restore_stackindex = 0;

int g_route_line_width = 0;

int g_route_prop_sx = 0;

int g_route_prop_sy = 0;

int g_route_prop_x = 0;

int g_route_prop_y = 0;

int g_S57_dialog_sx = 0;

int g_S57_dialog_sy = 0;

int g_S57_extradialog_sx = 0;

int g_S57_extradialog_sy = 0;

int g_SENC_LOD_pixels = 0;

int g_ShipScaleFactor = 0;

int g_shipToActiveColor = 0;

int g_shipToActiveStyle = 0;

int g_SkewCompUpdatePeriod = 0;

int g_SOGFilterSec = 0;

int g_tcwin_scale = 0.0;

int g_trackFilterMax = 0;

int g_track_line_width = 0;

int g_WplAction = 0;

int n_NavMessageShown = 0;

int sat_watchdog_timeout_ticks = 12;


long g_maintoolbar_orient = 0L;


std::vector<std::string> TideCurrentDataSet;


unsigned g_canvasConfig = 0;


wxString g_active_route;

wxString g_AW1GUID;

wxString g_AW2GUID;

wxString g_catalog_channel;

wxString g_catalog_custom_url;

wxString g_CmdSoundString;

wxString g_cog_predictor_color;

wxString g_compatOS = PKG_TARGET;

wxString g_compatOsVersion = PKG_TARGET_VERSION;

wxString g_config_version_string;

wxString g_datetime_format;

wxString g_default_font_facename;

wxString g_default_routepoint_icon;

wxString g_default_wp_icon;

wxString g_GPS_Ident;

wxString g_gpx_path;

wxString g_hostname;

wxString g_InvisibleLayers;

wxString g_InVisiNameinLayers;

wxString g_lastAppliedTemplateGUID;

wxString g_locale;

wxString g_localeOverride;

wxString g_ObjQFileExt;

wxString g_ownship_HDTpredictor_color;

wxString g_SART_sound_file;

wxString g_TalkerIdText;

wxString g_TCData_Dir;

wxString g_toolbarConfig = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX";

wxString g_uiStyle;

wxString g_uploadConnection;

wxString g_UserPresLibData;

wxString g_VisibleLayers;

wxString g_VisiNameinLayers;

wxString g_winPluginDir;

wxString gWorldMapLocation;

wxString gWorldShapefileLocation;


static wxConfigBase* the_base_config = 0;


wxConfigBase* TheBaseConfig() {

  wxASSERT_MSG(the_base_config != 0, "Uninitialized the_base_config");

  return the_base_config;

}

void InitBaseConfig(wxConfigBase* cfg) { the_base_config = cfg; }


std::vector<size_t> g_config_display_size_mm;

g_datetime_format
wxString g_datetime_format
Date/time format to use when formatting date/time strings.
Definition config_vars.cpp:255

g_always_send_rmb_rmc
bool g_always_send_rmb_rmc
Always send RMB and RMC n0183 messages even if there is no active route.
Definition config_vars.cpp:31

g_bsmoothpanzoom
bool g_bsmoothpanzoom
Controls how the chart panning and zooming smoothing is done during user interactions.
Definition config_vars.cpp:94

g_iTempFormat
int g_iTempFormat
User-selected temperature unit format for display and input.
Definition config_vars.cpp:173

g_nDepthUnitDisplay
int g_nDepthUnitDisplay
User-selected depth (below surface) unit format for display and input.
Definition config_vars.cpp:198

g_default_font_facename
wxString g_default_font_facename
Default font size for user interface elements such as menus, dialogs, etc.
Definition config_vars.cpp:256

g_winPluginDir
wxString g_winPluginDir
Base plugin directory on Windows.
Definition config_vars.cpp:278

g_bRollover
bool g_bRollover
enable/disable mouse rollover GUI effects
Definition config_vars.cpp:71

g_bShowTide
bool g_bShowTide
not used
Definition config_vars.cpp:87

g_COGAvg
double g_COGAvg
Debug only usage.
Definition config_vars.cpp:121

g_COGAvgSec
int g_COGAvgSec
COG average period for Course Up Mode (sec)
Definition config_vars.cpp:154

g_iSpeedFormat
int g_iSpeedFormat
User-selected speed unit format for display and input.
Definition config_vars.cpp:172

g_iHeightFormat
int g_iHeightFormat
User-selected height (vertical, above reference datum) unit format for display and input.
Definition config_vars.cpp:168

g_config_display_size_mm
std::vector< size_t > g_config_display_size_mm
Size of pysical screen in millimeters.
Definition config_vars.cpp:290

g_iDistanceFormat
int g_iDistanceFormat
User-selected distance (horizontal) unit format for display and input.
Definition config_vars.cpp:165

g_bDisplayGrid
bool g_bDisplayGrid
Should lat/lon grid be displayed ?
Definition config_vars.cpp:45

g_display_size_mm
double g_display_size_mm
Physical display width (mm)
Definition config_vars.cpp:123

config_vars.h
Global variables stored in configuration file.