1 // fg_time.cxx -- data structures and routines for managing time related stuff.
3 // Written by Curtis Olson, started August 1997.
5 // Copyright (C) 1997 Curtis L. Olson - curt@infoplane.com
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.
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.
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.
28 #include <simgear/compiler.h>
30 #ifdef FG_HAVE_STD_INCLUDES
42 #ifdef HAVE_SYS_TIMEB_H
43 # include <sys/timeb.h> // for ftime() and struct timeb
46 # include <unistd.h> // for gettimeofday()
48 #ifdef HAVE_SYS_TIME_H
49 # include <sys/time.h> // for get/setitimer, gettimeofday, struct timeval
52 #include <simgear/constants.h>
53 #include <simgear/debug/logstream.hxx>
54 #include <simgear/misc/fgpath.hxx>
56 #include <Astro/solarsystem.hxx>
57 #include <FDM/flight.hxx>
58 #include <Main/options.hxx>
59 #include <Time/light.hxx>
61 #include "fg_time.hxx"
63 #include "lowleveltime.h"
64 #include "moonpos.hxx"
68 #define DEGHR(x) ((x)/15.)
69 #define RADHR(x) DEGHR(x*RAD_TO_DEG)
72 // #define MK_TIME_IS_GMT 0 // default value
73 // #define TIME_ZONE_OFFSET_WORK 0 // default value
78 if (cur_time_params) {
79 FG_LOG( FG_GENERAL, FG_ALERT,
80 "Error: only one instance of FGTime allowed" );
84 cur_time_params = this;
86 FGPath buffer( current_options.get_fg_root() );
87 buffer.append( "Timezone" );
88 buffer.append( "zone.tab" );
89 FG_LOG( FG_EVENT, FG_INFO, "Reading timezone info from: " << buffer.str() );
90 tzContainer = new TimezoneContainer( buffer.c_str() );
102 void FGTime::updateLocal()
107 time_t aircraftLocalTime;
108 GeoCoord location(RAD_TO_DEG * f->get_Latitude(),
109 RAD_TO_DEG * f->get_Longitude());
110 GeoCoord* nearestTz = tzContainer->getNearest(location);
111 FGPath buffer( current_options.get_fg_root() );
112 buffer.append ("Timezone" );
113 buffer.append ( nearestTz->getDescription() );
116 zonename = strdup(buffer.c_str());
117 currGMT = get_gmt(gmtime(&cur_time));
118 aircraftLocalTime = get_gmt((fgLocaltime(&cur_time, buffer.c_str())));
119 localOffset = aircraftLocalTime - currGMT;
120 // cerr << "Using " << localOffset << " as local time offset Timezone is "
121 // << zonename << endl;
124 // Initialize the time dependent variables (maybe I'll put this in the
125 // constructor later)
126 void FGTime::init( double lon, double lat ) {
127 FG_LOG( FG_EVENT, FG_INFO, "Initializing Time" );
129 FG_LOG( FG_EVENT, FG_DEBUG,
130 "time offset = " << current_options.get_time_offset() );
131 time_t timeOffset = current_options.get_time_offset();
132 int offsetType = current_options.get_time_offset_type();
135 time_t systemLocalTime;
136 time_t aircraftLocalTime;
138 // would it be better to put these sanity checks in the options
139 // parsing code? (CLO)
141 cur_time = time(NULL);
143 // printf ("Current greenwich mean time = %24s", asctime(gmtime(&cur_time)));
144 // printf ("Current local time = %24s", asctime(localtime(&cur_time)));
145 // time_t tmp = cur_time;
146 GeoCoord location( RAD_TO_DEG * lat, RAD_TO_DEG * lon );
148 GeoCoord* nearestTz = tzContainer->getNearest(location);
150 FGPath buffer( current_options.get_fg_root() );
151 buffer.append( "Timezone" );
152 buffer.append( nearestTz->getDescription() );
154 // printf("Using %s for timezone information\n", buffer);
155 zonename = strdup( buffer.c_str() );
156 //show( buffer.c_str(), cur_time, 1);
157 //printf ("Current greenwich mean time = %24s", asctime(gmtime(&cur_time)));
158 //printf ("Current local time = %24s", asctime(localtime(&cur_time)));
159 currGMT = get_gmt(gmtime(&cur_time));
160 systemLocalTime = get_gmt(localtime(&cur_time));
161 aircraftLocalTime = get_gmt(fgLocaltime(&cur_time, buffer.c_str()));
162 //printf ("Current greenwich mean time = %24s", asctime(gmtime(&cur_time)));
163 //printf ("Current local time = %24s", asctime(localtime(&cur_time)));
165 //printf("LT = %d\n", computerLocalTime);
166 // Okay, in principle, this trick allows to calculate the
167 // difference between GMT and localtime, in seconds.
168 // printf("Gmt = %d, SLT = %d, (difference = %d)\n", currGMT, systemLocalTime, (currGMT - systemLocalTime));
169 // printf("Gmt = %d, ALT = %d, (difference = %d)\n", currGMT, aircraftLocalTime, (currGMT - aircraftLocalTime));
171 // Okay, we now have six possible scenarios
174 case fgOPTIONS::FG_TIME_SYS_OFFSET:
177 case fgOPTIONS::FG_TIME_GMT_OFFSET:
178 warp = timeOffset - (currGMT - systemLocalTime);
180 case fgOPTIONS::FG_TIME_LAT_OFFSET:
181 // warp = timeOffset - (currGMT - systemLocalTime +
182 // (currGMT - aircraftLocalTime));
183 warp = timeOffset - (aircraftLocalTime - systemLocalTime);
185 case fgOPTIONS::FG_TIME_SYS_ABSOLUTE:
186 warp = timeOffset - cur_time;
187 //printf("warp = %d\n", warp);
189 case fgOPTIONS::FG_TIME_GMT_ABSOLUTE:
190 warp = timeOffset - (currGMT - systemLocalTime) - cur_time;
192 case fgOPTIONS::FG_TIME_LAT_ABSOLUTE:
193 warp = timeOffset - (aircraftLocalTime - systemLocalTime) -
197 printf("Unsupported type\n");
202 pause = current_options.get_pause();
206 // given a date in months, mn, days, dy, years, yr, return the
207 // modified Julian date (number of days elapsed since 1900 jan 0.5),
208 // mjd. Adapted from Xephem.
210 void FGTime::cal_mjd (int mn, double dy, int yr)
212 //static double last_mjd, last_dy;
214 //static int last_mn, last_yr;
218 if (mn == last_mn && yr == last_yr && dy == last_dy) {
224 y = (yr < 0) ? yr + 1 : yr;
230 if (yr < 1582 || (yr == 1582 && (mn < 10 || (mn == 10 && dy < 15)))) {
239 c = (long)((365.25*y) - 0.75) - 694025L;
241 c = (long)(365.25*y) - 694025L;
244 d = (int)(30.6001*(m+1));
246 mjd = b + c + d + dy - 0.5;
257 // given an mjd, calculate greenwich mean sidereal time, gst
258 void FGTime::utc_gst ()
260 double day = floor(mjd-0.5)+0.5;
261 double hr = (mjd-day)*24.0;
264 T = ((int)(mjd - 0.5) + 0.5 - J2000)/36525.0;
265 x = 24110.54841 + (8640184.812866 + (0.093104 - 6.2e-6 * T) * T) * T;
267 gst = (1.0/SIDRATE)*hr + x;
269 FG_LOG( FG_EVENT, FG_DEBUG, " gst => " << gst );
273 // given Julian Date and Longitude (decimal degrees West) compute
274 // Local Sidereal Time, in decimal hours.
276 // Provided courtesy of ecdowney@noao.edu (Elwood Downey)
278 double FGTime::sidereal_precise (double lng)
282 /* printf ("Current Lst on JD %13.5f at %8.4f degrees West: ",
285 // convert to required internal units
288 // compute LST and print
290 lstTmp = gst - RADHR (lng);
291 lstTmp -= 24.0*floor(lstTmp/24.0);
292 // printf ("%7.4f\n", lstTmp);
299 // return a courser but cheaper estimate of sidereal time
300 double FGTime::sidereal_course(double lng)
304 time_t start_gmt, now;
305 double diff, part, days, hours, lstTmp;
311 start_gmt = get_gmt(gmt->tm_year, 2, 21, 12, 0, 0);
313 FG_LOG( FG_EVENT, FG_DEBUG, " COURSE: GMT = " << format_time(gmt, tbuf) );
314 FG_LOG( FG_EVENT, FG_DEBUG, " March 21 noon (GMT) = " << start_gmt );
316 diff = (now - start_gmt) / (3600.0 * 24.0);
318 FG_LOG( FG_EVENT, FG_DEBUG,
319 " Time since 3/21/" << gmt->tm_year << " GMT = " << diff );
321 part = fmod(diff, 1.0);
323 hours = gmt->tm_hour + gmt->tm_min/60.0 + gmt->tm_sec/3600.0;
325 lstTmp = (days - lng)/15.0 + hours - 12;
327 while ( lstTmp < 0.0 ) {
331 FG_LOG( FG_EVENT, FG_DEBUG,
332 " days = " << days << " hours = " << hours << " lon = "
333 << lng << " lst = " << lstTmp );
339 // Update time variables such as gmt, julian date, and sidereal time
340 void FGTime::update( double lon ) {
341 double gst_precise, gst_course;
343 FG_LOG( FG_EVENT, FG_DEBUG, "Updating time" );
345 // get current Unix calendar time (in seconds)
347 cur_time = time(NULL) + warp;
348 FG_LOG( FG_EVENT, FG_DEBUG,
349 " Current Unix calendar time = " << cur_time
350 << " warp = " << warp << " delta = " << warp_delta );
353 // time is changing so force an update
354 local_update_sky_and_lighting_params();
357 // get GMT break down for current time
358 gmt = gmtime(&cur_time);
359 FG_LOG( FG_EVENT, FG_DEBUG,
360 " Current GMT = " << gmt->tm_mon+1 << "/"
361 << gmt->tm_mday << "/" << gmt->tm_year << " "
362 << gmt->tm_hour << ":" << gmt->tm_min << ":"
365 // calculate modified Julian date
366 // t->mjd = cal_mjd ((int)(t->gmt->tm_mon+1), (double)t->gmt->tm_mday,
367 // (int)(t->gmt->tm_year + 1900));
368 cal_mjd ((int)(gmt->tm_mon+1), (double)gmt->tm_mday,
369 (int)(gmt->tm_year + 1900));
371 // add in partial day
372 mjd += (gmt->tm_hour / 24.0) + (gmt->tm_min / (24.0 * 60.0)) +
373 (gmt->tm_sec / (24.0 * 60.0 * 60.0));
375 // convert "back" to Julian date + partial day (as a fraction of one)
377 FG_LOG( FG_EVENT, FG_DEBUG, " Current Julian Date = " << jd );
379 // printf(" Current Longitude = %.3f\n", FG_Longitude * RAD_TO_DEG);
381 // Calculate local side real time
382 if ( gst_diff < -100.0 ) {
383 // first time through do the expensive calculation & cheap
384 // calculation to get the difference.
385 FG_LOG( FG_EVENT, FG_INFO, " First time, doing precise gst" );
386 gst_precise = gst = sidereal_precise(0.00);
387 gst_course = sidereal_course(0.00);
389 gst_diff = gst_precise - gst_course;
391 lst = sidereal_course(-(lon * RAD_TO_DEG)) + gst_diff;
393 // course + difference should drift off very slowly
394 gst = sidereal_course( 0.00 ) + gst_diff;
395 lst = sidereal_course( -(lon * RAD_TO_DEG)) + gst_diff;
397 FG_LOG( FG_EVENT, FG_DEBUG,
398 " Current lon=0.00 Sidereal Time = " << gst );
399 FG_LOG( FG_EVENT, FG_DEBUG,
400 " Current LOCAL Sidereal Time = " << lst << " ("
401 << sidereal_precise(-(lon * RAD_TO_DEG))
402 << ") (diff = " << gst_diff << ")" );
406 /******************************************************************
407 * The following are some functions that were included as FGTime
408 * members, although they currently don't make use of any of the
409 * class's variables. Maybe this'll change in the future
410 *****************************************************************/
412 // Return time_t for Sat Mar 21 12:00:00 GMT
414 // On many systems it is ambiguous if mktime() assumes the input is in
415 // GMT, or local timezone. To address this, a new function called
416 // timegm() is appearing. It works exactly like mktime() but
417 // explicitely interprets the input as GMT.
419 // timegm() is available and documented under FreeBSD. It is
420 // available, but completely undocumented on my current Debian 2.1
423 // In the absence of timegm() we have to guess what mktime() might do.
425 // Many older BSD style systems have a mktime() that assumes the input
426 // time in GMT. But FreeBSD explicitly states that mktime() assumes
429 // The mktime() on many SYSV style systems (such as Linux) usually
430 // returns its result assuming you have specified the input time in
431 // your local timezone. Therefore, in the absence if timegm() you
432 // have to go to extra trouble to convert back to GMT.
434 // If you are having problems with incorrectly positioned astronomical
435 // bodies, this is a really good place to start looking.
437 time_t FGTime::get_gmt(int year, int month, int day, int hour, int min, int sec)
447 mt.tm_isdst = -1; // let the system determine the proper time zone
449 // For now we assume that if daylight is not defined in
450 // /usr/include/time.h that we have a machine with a mktime() that
451 // assumes input is in GMT ... this only matters if we are
452 // building on a system that does not have timegm()
453 #if !defined(HAVE_DAYLIGHT)
454 # define MK_TIME_IS_GMT 1
457 #if defined( HAVE_TIMEGM )
458 return ( timegm(&mt) );
459 #elif defined( MK_TIME_IS_GMT )
460 return ( mktime(&mt) );
461 #else // ! defined ( MK_TIME_IS_GMT )
463 // timezone seems to work as a proper offset for Linux & Solaris
464 # if defined( __linux__ ) || defined( __sun__ )
465 # define TIMEZONE_OFFSET_WORKS 1
468 long int start = mktime(&mt);
470 FG_LOG( FG_EVENT, FG_DEBUG, "start1 = " << start );
471 // the ctime() call can screw up time progression on some versions
473 // fgPrintf( FG_EVENT, FG_DEBUG, "start2 = %s", ctime(&start));
474 FG_LOG( FG_EVENT, FG_DEBUG, "(tm_isdst = " << mt.tm_isdst << ")" );
476 timezone = fix_up_timezone( timezone );
478 # if defined( TIMEZONE_OFFSET_WORKS )
479 FG_LOG( FG_EVENT, FG_DEBUG,
480 "start = " << start << ", timezone = " << timezone );
481 return( start - timezone );
482 # else // ! defined( TIMEZONE_OFFSET_WORKS )
484 daylight = mt.tm_isdst;
485 if ( daylight > 0 ) {
487 } else if ( daylight < 0 ) {
488 FG_LOG( FG_EVENT, FG_WARN,
489 "OOOPS, problem in fg_time.cxx, no daylight savings info." );
492 long int offset = -(timezone / 3600 - daylight);
494 FG_LOG( FG_EVENT, FG_DEBUG, " Raw time zone offset = " << timezone );
495 FG_LOG( FG_EVENT, FG_DEBUG, " Daylight Savings = " << daylight );
496 FG_LOG( FG_EVENT, FG_DEBUG, " Local hours from GMT = " << offset );
498 long int start_gmt = start - timezone + (daylight * 3600);
500 FG_LOG( FG_EVENT, FG_DEBUG, " March 21 noon (CST) = " << start );
502 return ( start_gmt );
503 # endif // ! defined( TIMEZONE_OFFSET_WORKS )
504 #endif // ! defined ( MK_TIME_IS_GMT )
507 // Fix up timezone if using ftime()
508 long int FGTime::fix_up_timezone( long int timezone_orig )
510 #if !defined( HAVE_GETTIMEOFDAY ) && defined( HAVE_FTIME )
511 // ftime() needs a little extra help finding the current timezone
512 struct timeb current;
514 return( current.timezone * 60 );
516 return( timezone_orig );
521 char* FGTime::format_time( const struct tm* p, char* buf )
523 sprintf( buf, "%d/%d/%2d %d:%02d:%02d",
524 p->tm_mon, p->tm_mday, p->tm_year,
525 p->tm_hour, p->tm_min, p->tm_sec);
530 // Force an update of the sky and lighting parameters
531 void FGTime::local_update_sky_and_lighting_params( void ) {
534 cur_light_params.Update();
538 FGTime* FGTime::cur_time_params = 0;