src/Units/Units.hpp

   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 #ifndef XCSOAR_UNITS_HPP
  25 #define XCSOAR_UNITS_HPP
  26
  27 #include "Units/Settings.hpp"
  28 #include "Units/System.hpp"
  29 #include "Math/fixed.hpp"
  30 #include "Compiler.h"
  31
  32 #include <tchar.h>
  33
  34 class AtmosphericPressure;
  35
  36 #define DEG "°"
  37
  38 /**
  39  * Namespace to manage unit conversions.
  40  * internal system units are (metric SI).
  41  */
  42 namespace Units
  43 {
  44   extern UnitSetting current;
  45
  46   void SetConfig(const UnitSetting &new_config);
  47
  48   /**
  49    * Returns the user-specified unit for a horizontal distance
  50    * @return The user-specified unit for a horizontal distance
  51    */
  52   gcc_pure
  53   Unit GetUserDistanceUnit();
  54
  55   /**
  56    * Returns the user-specified unit for an altitude
  57    * @return The user-specified unit for an altitude
  58    */
  59   gcc_pure
  60   Unit GetUserAltitudeUnit();
  61
  62   /**
  63    * Returns the user-specified unit for a temperature
  64    * @return The user-specified unit for a temperature
  65    */
  66   gcc_pure
  67   Unit GetUserTemperatureUnit();
  68
  69   /**
  70    * Returns the user-specified unit for a horizontal speed
  71    * @return The user-specified unit for a horizontal speed
  72    */
  73   gcc_pure
  74   Unit GetUserSpeedUnit();
  75
  76   /**
  77    * Returns the user-specified unit for a task speed
  78    * @return The user-specified unit for a task speed
  79    */
  80   gcc_pure
  81   Unit GetUserTaskSpeedUnit();
  82
  83   /**
  84    * Returns the user-specified unit for a vertical speed
  85    * @return The user-specified unit for a vertical speed
  86    */
  87   gcc_pure
  88   Unit GetUserVerticalSpeedUnit();
  89
  90   /**
  91    * Returns the user-specified unit for a wind speed
  92    * @return The user-specified unit for a wind speed
  93    */
  94   gcc_pure
  95   Unit GetUserWindSpeedUnit();
  96
  97   /**
  98    * Returns the user-specified unit for a pressure
  99    * @return The user-specified unit for a pressure
 100    */
 101   gcc_pure
 102   Unit GetUserPressureUnit();
 103
 104   gcc_pure
 105   Unit GetUserUnitByGroup(UnitGroup group);
 106
 107   gcc_pure
 108   const TCHAR *GetSpeedName();
 109
 110   gcc_pure
 111   const TCHAR *GetVerticalSpeedName();
 112
 113   gcc_pure
 114   const TCHAR *GetWindSpeedName();
 115
 116   gcc_pure
 117   const TCHAR *GetDistanceName();
 118
 119   gcc_pure
 120   const TCHAR *GetAltitudeName();
 121
 122   gcc_pure
 123   const TCHAR *GetTemperatureName();
 124
 125   gcc_pure
 126   const TCHAR *GetTaskSpeedName();
 127
 128   gcc_pure
 129   const TCHAR *GetPressureName();
 130
 131   static inline fixed
 132   ToUserAltitude(fixed value)
 133   {
 134     return ToUserUnit(value, current.altitude_unit);
 135   }
 136
 137   static inline fixed
 138   ToSysAltitude(fixed value)
 139   {
 140     return ToSysUnit(value, current.altitude_unit);
 141   }
 142
 143   static inline fixed
 144   ToUserTemperature(fixed value)
 145   {
 146     return ToUserUnit(value, current.temperature_unit);
 147   }
 148
 149   static inline fixed
 150   ToSysTemperature(fixed value)
 151   {
 152     return ToSysUnit(value, current.temperature_unit);
 153   }
 154
 155   static inline fixed
 156   ToUserDistance(fixed value)
 157   {
 158     return ToUserUnit(value, current.distance_unit);
 159   }
 160
 161   static inline fixed
 162   ToSysDistance(fixed value)
 163   {
 164     return ToSysUnit(value, current.distance_unit);
 165   }
 166
 167   static inline fixed
 168   ToUserSpeed(fixed value)
 169   {
 170     return ToUserUnit(value, current.speed_unit);
 171   }
 172
 173   static inline fixed
 174   ToSysSpeed(fixed value)
 175   {
 176     return ToSysUnit(value, current.speed_unit);
 177   }
 178
 179   static inline fixed
 180   ToUserVSpeed(fixed value)
 181   {
 182     return ToUserUnit(value, current.vertical_speed_unit);
 183   }
 184
 185   static inline fixed
 186   ToSysVSpeed(fixed value)
 187   {
 188     return ToSysUnit(value, current.vertical_speed_unit);
 189   }
 190
 191   static inline fixed
 192   ToUserTaskSpeed(fixed value)
 193   {
 194     return ToUserUnit(value, current.task_speed_unit);
 195   }
 196
 197   static inline fixed
 198   ToSysTaskSpeed(fixed value)
 199   {
 200     return ToSysUnit(value, current.task_speed_unit);
 201   }
 202
 203   static inline fixed
 204   ToUserWindSpeed(fixed value)
 205   {
 206     return ToUserUnit(value, current.wind_speed_unit);
 207   }
 208
 209   static inline fixed
 210   ToSysWindSpeed(fixed value)
 211   {
 212     return ToSysUnit(value, current.wind_speed_unit);
 213   }
 214
 215   static inline fixed
 216   ToUserPressure(fixed Value)
 217   {
 218     return ToUserUnit(Value, current.pressure_unit);
 219   }
 220
 221   gcc_const
 222   fixed
 223   ToUserPressure(AtmosphericPressure value);
 224
 225   static inline fixed
 226   ToSysPressure(fixed Value)
 227   {
 228     return ToSysUnit(Value, current.pressure_unit);
 229   }
 230
 231   /**
 232    * Convert a pressure value from the user unit to an
 233    * #AtmosphericPressure object.
 234    */
 235   gcc_const
 236   AtmosphericPressure
 237   FromUserPressure(fixed value);
 238 };
 239
 240 #endif