src/Time/fg_time.hxx

   1 // fg_time.hxx -- data structures and routines for managing time related stuff.
   2 //
   3 // Written by Curtis Olson, started August 1997.
   4 //
   5 // Copyright (C) 1997  Curtis L. Olson  - curt@infoplane.com
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _FG_TIME_HXX
  25 #define _FG_TIME_HXX
  26
  27
  28 #ifndef __cplusplus
  29 # error This library requires C++
  30 #endif
  31
  32
  33 #ifdef HAVE_CONFIG_H
  34 #  include <config.h>
  35 #endif
  36
  37 #ifdef HAVE_WINDOWS_H
  38 #  include <windows.h>
  39 #endif
  40
  41 #include <GL/glut.h>
  42
  43 #include "Include/compiler.h"
  44 #ifdef FG_HAVE_STD_INCLUDES
  45 #  include <ctime>
  46 #else
  47 #  include <time.h>
  48 #endif
  49
  50 #include <FDM/flight.hxx>
  51
  52 #include "timezone.h"
  53 #include "lowleveltime.h"
  54
  55 // Define a structure containing global time parameters
  56 class FGTime {
  57
  58 private:
  59     // tzContainer stores all the current Timezone control points/
  60     TimezoneContainer* tzContainer;
  61
  62     //Store the current local timezone name;
  63     char *zonename;
  64
  65     // Unix "calendar" time in seconds
  66     time_t cur_time;
  67
  68     // Break down of GMT time
  69     struct tm *gmt;
  70
  71     // Julian date
  72     double jd;
  73
  74     // modified Julian date
  75     double mjd;
  76
  77     double last_mjd, last_dy;
  78     int last_mn, last_yr;
  79
  80     // side real time at prime meridian
  81     double gst;
  82
  83     // local side real time
  84     double lst;
  85
  86     // the difference between the precise sidereal time algorithm
  87     // result and the course result.  course + diff has good accuracy
  88     // for the short term
  89     double gst_diff;
  90
  91     // An offset in seconds from the true time.  Allows us to adjust
  92     // the effective time of day.
  93     long int warp;
  94
  95     // How much to change the value of warp each iteration.  Allows us
  96     // to make time progress faster than normal.
  97     long int warp_delta;
  98
  99     // Paused?
 100     bool pause;
 101
 102     void local_update_sky_and_lighting_params( void );
 103
 104 public:
 105
 106     FGTime();
 107     ~FGTime();
 108
 109     inline double getMjd() const { return mjd; };
 110     inline double getLst() const { return lst; };
 111     inline double getGst() const { return gst; };
 112     inline time_t get_cur_time() const { return cur_time; };
 113     inline struct tm* getGmt()const { return gmt; };
 114     inline bool getPause() const { return pause; };
 115
 116     void adjust_warp(int val) { warp += val; };
 117     void adjust_warp_delta(int val) { warp_delta += val; };
 118     void togglePauseMode() { pause = !pause; };
 119
 120     // Initialize the time dependent variables
 121     void init(const FGInterface& f);
 122
 123     // Update the time dependent variables
 124     void update(const FGInterface& f);
 125
 126     void cal_mjd (int mn, double dy, int yr);
 127     void utc_gst();
 128     double sidereal_precise (double lng);
 129     double sidereal_course(double lng);
 130     static FGTime *cur_time_params;
 131
 132     // Some other stuff which were changed to FGTime members on
 133     // questionable grounds -:)
 134     // time_t get_start_gmt(int year);
 135     time_t get_gmt(int year, int month, int day,
 136                    int hour, int minute, int second);
 137     time_t get_gmt(struct tm* the_time);
 138
 139     char* format_time( const struct tm* p, char* buf );
 140     long int fix_up_timezone( long int timezone_orig );
 141 };
 142
 143
 144 inline time_t FGTime::get_gmt(struct tm* the_time) // this is just a wrapper
 145 {
 146   //printf("Using: %24s as input\n", asctime(the_time));
 147   return get_gmt(the_time->tm_year,
 148           the_time->tm_mon,
 149           the_time->tm_mday,
 150           the_time->tm_hour,
 151           the_time->tm_min,
 152           the_time->tm_sec);
 153 }
 154
 155
 156 #endif // _FG_TIME_HXX