src/Main/util.hxx

   1 // util.hxx - general-purpose utility functions.
   2 // Copyright (C) 2002  Curtis L. Olson  - http://www.flightgear.org/~curt
   3 //
   4 // This program is free software; you can redistribute it and/or
   5 // modify it under the terms of the GNU General Public License as
   6 // published by the Free Software Foundation; either version 2 of the
   7 // License, or (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful, but
  10 // WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 // General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with this program; if not, write to the Free Software
  16 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  17 //
  18 // $Id$
  19
  20
  21 #ifndef __UTIL_HXX
  22 #define __UTIL_HXX 1
  23
  24 #ifndef __cplusplus
  25 # error This library requires C++
  26 #endif
  27
  28
  29 /**
  30  * Initialize a single value through all existing weather levels.
  31  *
  32  * This function is useful mainly from the command-line.
  33  *
  34  * @param propname The name of the subproperty to initialized.
  35  * @param value The initial value.
  36  */
  37 extern void fgDefaultWeatherValue (const char * propname, double value);
  38
  39
  40 /**
  41  * Set up a plausible wind layout, boundary and aloft,
  42  * based on just a few parameters.
  43  *
  44  * @param min_hdg Minimal wind heading
  45  * @param max_hdg Maximal wind heading
  46  * @param speed Windspeed in knots
  47  * @param gust Wind gust variation in knots
  48  */
  49 extern void fgSetupWind (double min_hdg, double max_hdg,
  50                          double speed, double gust);
  51
  52 /**
  53  * Clean up and exit FlightGear.
  54  *
  55  * This function makes sure that network connections and I/O streams
  56  * are cleaned up.
  57  *
  58  * @param status The exit status to pass to the operating system.
  59  */
  60 extern void fgExit (int status = 0);
  61
  62
  63 /**
  64  * Move a value towards a target.
  65  *
  66  * This function was originally written by Alex Perry.
  67  *
  68  * @param current The current value.
  69  * @param target The target value.
  70  * @param timeratio The percentage of smoothing time that has passed
  71  *        (elapsed time/smoothing time)
  72  * @return The new value.
  73  */
  74 extern double fgGetLowPass (double current, double target, double timeratio);
  75
  76
  77 /**
  78  * Unescape string.
  79  *
  80  * @param str String possibly containing escaped characters.
  81  * @return string with escaped characters replaced by single character values.
  82  */
  83 extern std::string fgUnescape (const char *str);
  84
  85
  86 /**
  87  * Validation listener interface for io.nas, used by fgcommands.
  88  * @param path Path to be validated
  89  * @param write True for write operations and false for read operations.
  90  * @return The validated path on success or 0 if access denied.
  91  */
  92 extern const char *fgValidatePath (const char *path, bool write);
  93
  94 #endif // __UTIL_HXX