src/Dialogs/Settings/dlgBasicSettings.cpp

   1 /*
   2 Copyright_License {
   3
   4   XCSoar Glide Computer - http://www.xcsoar.org/
   5   Copyright (C) 2000-2013 The XCSoar Project
   6   A detailed list of copyright holders can be found in the file "AUTHORS".
   7
   8   This program is free software; you can redistribute it and/or
   9   modify it under the terms of the GNU General Public License
  10   as published by the Free Software Foundation; either version 2
  11   of the License, or (at your option) any later version.
  12
  13   This program is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18   You should have received a copy of the GNU General Public License
  19   along with this program; if not, write to the Free Software
  20   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21 }
  22 */
  23
  24 #include "Dialogs/Dialogs.h"
  25 #include "Dialogs/WidgetDialog.hpp"
  26 #include "Protection.hpp"
  27 #include "Blackboard/DeviceBlackboard.hpp"
  28 #include "Computer/Settings.hpp"
  29 #include "Units/Units.hpp"
  30 #include "Formatter/UserUnits.hpp"
  31 #include "Atmosphere/Temperature.hpp"
  32 #include "Form/DataField/Float.hpp"
  33 #include "Form/DataField/Listener.hpp"
  34 #include "UIGlobals.hpp"
  35 #include "Interface.hpp"
  36 #include "Components.hpp"
  37 #include "GlideSolvers/GlidePolar.hpp"
  38 #include "Task/ProtectedTaskManager.hpp"
  39 #include "Widget/RowFormWidget.hpp"
  40 #include "Form/Button.hpp"
  41 #include "Form/Form.hpp"
  42 #include "Form/ButtonPanel.hpp"
  43 #include "Language/Language.hpp"
  44 #include "Operation/MessageOperationEnvironment.hpp"
  45 #include "Event/Timer.hpp"
  46 #include "Compiler.h"
  47
  48 #include <math.h>
  49
  50 enum ControlIndex {
  51   Ballast,
  52   WingLoading,
  53   Bugs,
  54   QNH,
  55   Altitude,
  56   Temperature,
  57 };
  58
  59 enum Actions {
  60   DUMP = 100,
  61 };
  62
  63 class FlightSetupPanel final
  64   : public RowFormWidget, DataFieldListener,
  65     private Timer,
  66     public ActionListener {
  67   WndButton *dump_button;
  68
  69   PolarSettings &polar_settings;
  70
  71   fixed last_altitude;
  72
  73 public:
  74   FlightSetupPanel()
  75     :RowFormWidget(UIGlobals::GetDialogLook()),
  76      dump_button(NULL),
  77      polar_settings(CommonInterface::SetComputerSettings().polar),
  78      last_altitude(-2)
  79   {}
  80
  81   void SetDumpButton(WndButton *_dump_button) {
  82     dump_button = _dump_button;
  83   }
  84
  85   void SetButtons();
  86   void SetBallast();
  87   void SetBallastTimer(bool active);
  88   void FlipBallastTimer();
  89
  90   void PublishPolarSettings() {
  91     if (protected_task_manager != NULL)
  92       protected_task_manager->SetGlidePolar(polar_settings.glide_polar_task);
  93   }
  94
  95   void SetBallastLitres(fixed ballast_litres) {
  96     polar_settings.glide_polar_task.SetBallastLitres(ballast_litres);
  97     PublishPolarSettings();
  98     SetButtons();
  99     SetBallast();
 100   }
 101
 102   void ShowAltitude(fixed altitude);
 103   void RefreshAltitudeControl();
 104   void SetBugs(fixed bugs);
 105   void SetQNH(AtmosphericPressure qnh);
 106
 107   /* virtual methods from Widget */
 108   virtual void Prepare(ContainerWindow &parent,
 109                        const PixelRect &rc) override;
 110   virtual bool Save(bool &changed) override;
 111
 112   virtual void Show(const PixelRect &rc) override {
 113     RowFormWidget::Show(rc);
 114     Timer::Schedule(500);
 115
 116     OnTimer();
 117     SetButtons();
 118     SetBallast();
 119   }
 120
 121   virtual void Hide() override {
 122     Timer::Cancel();
 123     RowFormWidget::Hide();
 124   }
 125
 126   /* virtual methods from ActionListener */
 127   virtual void OnAction(int id) override;
 128
 129 private:
 130   /* virtual methods from DataFieldListener */
 131   virtual void OnModified(DataField &df) override;
 132   virtual void OnSpecial(DataField &df) override;
 133
 134   /* virtual methods from Timer */
 135   virtual void OnTimer() override;
 136 };
 137
 138 void
 139 FlightSetupPanel::SetButtons()
 140 {
 141   dump_button->SetVisible(polar_settings.glide_polar_task.HasBallast());
 142
 143   const ComputerSettings &settings = CommonInterface::GetComputerSettings();
 144   dump_button->SetCaption(settings.polar.ballast_timer_active
 145                           ? _("Stop") : _("Dump"));
 146 }
 147
 148 void
 149 FlightSetupPanel::SetBallast()
 150 {
 151   const bool ballastable = polar_settings.glide_polar_task.IsBallastable();
 152   SetRowVisible(Ballast, ballastable);
 153   if (ballastable)
 154     LoadValue(Ballast, polar_settings.glide_polar_task.GetBallastLitres());
 155
 156   const fixed wl = polar_settings.glide_polar_task.GetWingLoading();
 157   SetRowVisible(WingLoading, positive(wl));
 158   if (positive(wl))
 159     LoadValue(WingLoading, wl);
 160
 161   if (device_blackboard != NULL) {
 162     const Plane &plane = CommonInterface::GetComputerSettings().plane;
 163     if (positive(plane.dry_mass)) {
 164       fixed fraction = polar_settings.glide_polar_task.GetBallast();
 165       fixed overload = (plane.dry_mass + fraction * plane.max_ballast) /
 166         plane.dry_mass;
 167
 168       MessageOperationEnvironment env;
 169       device_blackboard->SetBallast(fraction, overload, env);
 170     }
 171   }
 172 }
 173
 174 void
 175 FlightSetupPanel::SetBallastTimer(bool active)
 176 {
 177   if (!polar_settings.glide_polar_task.HasBallast())
 178     active = false;
 179
 180   PolarSettings &settings = CommonInterface::SetComputerSettings().polar;
 181   if (active == settings.ballast_timer_active)
 182     return;
 183
 184   settings.ballast_timer_active = active;
 185   SetButtons();
 186 }
 187
 188 void
 189 FlightSetupPanel::FlipBallastTimer()
 190 {
 191   const ComputerSettings &settings = CommonInterface::GetComputerSettings();
 192   SetBallastTimer(!settings.polar.ballast_timer_active);
 193 }
 194
 195 void
 196 FlightSetupPanel::ShowAltitude(fixed altitude)
 197 {
 198   if (fabs(altitude - last_altitude) >= fixed(1)) {
 199     last_altitude = altitude;
 200     LoadValue(Altitude, altitude, UnitGroup::ALTITUDE);
 201   }
 202
 203   ShowRow(Altitude);
 204 }
 205
 206 void
 207 FlightSetupPanel::RefreshAltitudeControl()
 208 {
 209   const NMEAInfo &basic = CommonInterface::Basic();
 210   ComputerSettings &settings_computer = CommonInterface::SetComputerSettings();
 211
 212   if (basic.pressure_altitude_available && settings_computer.pressure_available)
 213     ShowAltitude(settings_computer.pressure.PressureAltitudeToQNHAltitude(
 214                  basic.pressure_altitude));
 215   else if (basic.baro_altitude_available)
 216     ShowAltitude(basic.baro_altitude);
 217   else
 218     HideRow(Altitude);
 219 }
 220
 221 void
 222 FlightSetupPanel::SetBugs(fixed bugs) {
 223   polar_settings.SetBugs(bugs);
 224   PublishPolarSettings();
 225
 226   if (device_blackboard != NULL) {
 227     MessageOperationEnvironment env;
 228     device_blackboard->SetBugs(bugs, env);
 229   }
 230 }
 231
 232 void
 233 FlightSetupPanel::SetQNH(AtmosphericPressure qnh)
 234 {
 235   const NMEAInfo &basic = CommonInterface::Basic();
 236   ComputerSettings &settings_computer = CommonInterface::SetComputerSettings();
 237
 238   settings_computer.pressure = qnh;
 239   settings_computer.pressure_available.Update(basic.clock);
 240
 241   if (device_blackboard != NULL) {
 242     MessageOperationEnvironment env;
 243     device_blackboard->SetQNH(qnh, env);
 244   }
 245
 246   RefreshAltitudeControl();
 247 }
 248
 249 void
 250 FlightSetupPanel::OnTimer()
 251 {
 252   const PolarSettings &settings = CommonInterface::GetComputerSettings().polar;
 253
 254   if (settings.ballast_timer_active) {
 255     /* display the new values on the screen */
 256     SetBallast();
 257   }
 258
 259   RefreshAltitudeControl();
 260 }
 261
 262 void
 263 FlightSetupPanel::OnModified(DataField &df)
 264 {
 265   if (IsDataField(Ballast, df)) {
 266     const DataFieldFloat &dff = (const DataFieldFloat &)df;
 267     SetBallastLitres(dff.GetAsFixed());
 268   } else if (IsDataField(Bugs, df)) {
 269     const DataFieldFloat &dff = (const DataFieldFloat &)df;
 270     SetBugs(fixed(1) - (dff.GetAsFixed() / 100));
 271   } else if (IsDataField(QNH, df)) {
 272     const DataFieldFloat &dff = (const DataFieldFloat &)df;
 273     SetQNH(Units::FromUserPressure(dff.GetAsFixed()));
 274   }
 275 }
 276
 277 void
 278 FlightSetupPanel::OnSpecial(DataField &df)
 279 {
 280   if (IsDataField(Ballast, df))
 281     FlipBallastTimer();
 282 }
 283
 284 void
 285 FlightSetupPanel::Prepare(ContainerWindow &parent, const PixelRect &rc)
 286 {
 287   RowFormWidget::Prepare(parent, rc);
 288
 289   const ComputerSettings &settings = CommonInterface::GetComputerSettings();
 290
 291   AddFloat(_("Ballast"),
 292            _("Ballast of the glider.  Increase this value if the pilot/cockpit load is greater than the reference pilot weight of the glide polar (typically 75kg).  Press ENTER on this field to toggle count-down of the ballast volume according to the dump rate specified in the configuration settings."),
 293            _T("%.0f l"), _T("%.0f"),
 294            fixed(0), fixed(500), fixed(5), false,
 295            fixed(0),
 296            this);
 297
 298   AddReadOnly(_("Wing loading"), NULL, _T("%.1f kg/m2"), fixed(0));
 299
 300   AddFloat(_("Bugs"), /* xgettext:no-c-format */
 301            _("How clean the glider is. Set to 0% for clean, larger numbers as the wings "
 302                "pick up bugs or gets wet.  50% indicates the glider's sink rate is doubled."),
 303            _T("%.0f %%"), _T("%.0f"),
 304            fixed(0), fixed(50), fixed(1), false,
 305            (fixed(1) - polar_settings.bugs) * 100,
 306            this);
 307
 308   WndProperty *wp;
 309   wp = AddFloat(_("QNH"),
 310                 _("Area pressure for barometric altimeter calibration.  This is set automatically if Vega connected."),
 311                 GetUserPressureFormat(), GetUserPressureFormat(),
 312                 Units::ToUserPressure(Units::ToSysUnit(fixed(850), Unit::HECTOPASCAL)),
 313                 Units::ToUserPressure(Units::ToSysUnit(fixed(1300), Unit::HECTOPASCAL)),
 314                 GetUserPressureStep(), false,
 315                 Units::ToUserPressure(settings.pressure), this);
 316   {
 317     DataFieldFloat &df = *(DataFieldFloat *)wp->GetDataField();
 318     df.SetUnits(Units::GetPressureName());
 319     wp->RefreshDisplay();
 320   }
 321
 322   AddReadOnly(_("Altitude"), NULL, _T("%.0f %s"),
 323               UnitGroup::ALTITUDE, fixed(0));
 324
 325   wp = AddFloat(_("Max. temp."),
 326                 _("Set to forecast ground temperature.  Used by convection estimator (temperature trace page of Analysis dialog)"),
 327                 _T("%.0f %s"), _T("%.0f"),
 328                 Units::ToUserTemperature(CelsiusToKelvin(fixed(-50))),
 329                 Units::ToUserTemperature(CelsiusToKelvin(fixed(60))),
 330                 fixed(1), false,
 331                 Units::ToUserTemperature(settings.forecast_temperature));
 332   {
 333     DataFieldFloat &df = *(DataFieldFloat *)wp->GetDataField();
 334     df.SetUnits(Units::GetTemperatureName());
 335     wp->RefreshDisplay();
 336   }
 337 }
 338
 339 bool
 340 FlightSetupPanel::Save(bool &changed)
 341 {
 342   ComputerSettings &settings = CommonInterface::SetComputerSettings();
 343
 344   changed |= SaveValue(Temperature, UnitGroup::TEMPERATURE,
 345                        settings.forecast_temperature);
 346
 347   return true;
 348 }
 349
 350 void
 351 FlightSetupPanel::OnAction(int id)
 352 {
 353   if (id == DUMP)
 354     FlipBallastTimer();
 355 }
 356
 357 void
 358 dlgBasicSettingsShowModal()
 359 {
 360   FlightSetupPanel *instance = new FlightSetupPanel();
 361
 362   const Plane &plane = CommonInterface::GetComputerSettings().plane;
 363   StaticString<128> caption(_("Flight Setup"));
 364   caption.append(_T(" - "));
 365   caption.append(plane.polar_name);
 366
 367   WidgetDialog dialog(UIGlobals::GetDialogLook());
 368   dialog.CreateAuto(UIGlobals::GetMainWindow(), caption, instance);
 369   instance->SetDumpButton(dialog.AddButton(_("Dump"), *instance, DUMP));
 370   dialog.AddButton(_("OK"), mrOK);
 371
 372   dialog.ShowModal();
 373 }