1 // sg_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 - http://www.flightgear.org/~curt
7 // This library is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU Library General Public
9 // License as published by the Free Software Foundation; either
10 // version 2 of the License, or (at your option) any later version.
12 // This library is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // Library 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
25 # include <simgear_config.h>
28 #include <simgear/compiler.h>
30 #include <errno.h> // for errno
38 #ifdef HAVE_SYS_TIME_H
39 # include <sys/time.h> // for get/setitimer, gettimeofday, struct timeval
41 #ifdef HAVE_SYS_TIMEB_H
42 # include <sys/timeb.h> // for ftime() and struct timeb
45 # include <unistd.h> // for gettimeofday()
48 #include <math.h> // for NAN
50 #include <simgear/constants.h>
51 #include <simgear/debug/logstream.hxx>
52 #include <simgear/misc/sg_path.hxx>
54 #include "sg_time.hxx"
56 #include "lowleveltime.h"
58 #define DEGHR(x) ((x)/15.)
59 #define RADHR(x) DEGHR(x*SGD_RADIANS_TO_DEGREES)
62 static const double MJD0 = 2415020.0;
63 static const double J2000 = 2451545.0 - MJD0;
64 static const double SIDRATE = 0.9972695677;
67 void SGTime::init( double lon_rad, double lat_rad,
68 const string& root, time_t init_time )
70 SG_LOG( SG_EVENT, SG_INFO, "Initializing Time" );
77 cur_time = time(NULL);
80 SG_LOG( SG_EVENT, SG_INFO,
81 "Current greenwich mean time = " << asctime(gmtime(&cur_time)));
82 SG_LOG( SG_EVENT, SG_INFO,
83 "Current local time = " << asctime(localtime(&cur_time)));
87 zone.append( "zone.tab" );
88 SG_LOG( SG_EVENT, SG_INFO, "Reading timezone info from: "
90 tzContainer = new SGTimeZoneContainer( zone.c_str() );
92 SGGeoCoord location( SGD_RADIANS_TO_DEGREES * lat_rad, SGD_RADIANS_TO_DEGREES * lon_rad );
93 SGGeoCoord* nearestTz = tzContainer->getNearest(location);
96 name.append( nearestTz->getDescription() );
97 zonename = name.str();
98 SG_LOG( SG_EVENT, SG_INFO, "Using zonename = " << zonename );
100 SG_LOG( SG_EVENT, SG_INFO, "*** NO TIME ZONE NAME ***" );
106 SGTime::SGTime( double lon_rad, double lat_rad, const string& root,
109 init( lon_rad, lat_rad, root, init_time );
113 SGTime::SGTime( const string& root ) {
114 init( 0.0, 0.0, root, 0 );
119 init( 0.0, 0.0, "", 0 );
129 // given Julian Date and Longitude (decimal degrees West) compute
130 // Local Sidereal Time, in decimal hours.
132 // Provided courtesy of ecdowney@noao.edu (Elwood Downey)
133 static double sidereal_precise( double mjd, double lng )
135 /* printf ("Current Lst on JD %13.5f at %8.4f degrees West: ",
138 // convert to required internal units
139 lng *= SGD_DEGREES_TO_RADIANS;
141 // compute LST and print
142 double gst = sgTimeCalcGST( mjd );
143 double lst = gst - RADHR( lng );
144 lst -= 24.0 * floor( lst / 24.0 );
145 // printf ("%7.4f\n", lstTmp);
151 // return a courser but cheaper estimate of sidereal time
152 static double sidereal_course( time_t cur_time, const struct tm *gmt, double lng )
154 time_t start_gmt, now;
155 double diff, part, days, hours, lstTmp;
159 start_gmt = sgTimeGetGMT(gmt->tm_year, 2, 21, 12, 0, 0);
161 SG_LOG( SG_EVENT, SG_DEBUG, " COURSE: GMT = "
162 << sgTimeFormatTime(gmt, tbuf) );
163 SG_LOG( SG_EVENT, SG_DEBUG, " March 21 noon (GMT) = " << start_gmt );
165 diff = (now - start_gmt) / (3600.0 * 24.0);
167 SG_LOG( SG_EVENT, SG_DEBUG,
168 " Time since 3/21/" << gmt->tm_year << " GMT = " << diff );
170 part = fmod(diff, 1.0);
172 hours = gmt->tm_hour + gmt->tm_min/60.0 + gmt->tm_sec/3600.0;
174 lstTmp = (days - lng)/15.0 + hours - 12;
176 while ( lstTmp < 0.0 ) {
180 SG_LOG( SG_EVENT, SG_DEBUG,
181 " days = " << days << " hours = " << hours << " lon = "
182 << lng << " lst = " << lstTmp );
188 // Update the time related variables
189 void SGTime::update( double lon_rad, double lat_rad,
190 time_t ct, long int warp )
192 double gst_precise, gst_course;
198 SG_LOG( SG_EVENT, SG_DEBUG, "Updating time" );
200 // get current Unix calendar time (in seconds)
201 // warp += warp_delta;
203 cur_time = ct + warp;
205 cur_time = time(NULL) + warp;
207 SG_LOG( SG_EVENT, SG_DEBUG,
208 " Current Unix calendar time = " << cur_time
209 << " warp = " << warp );
211 // get GMT break down for current time
213 memcpy( gmt, gmtime(&cur_time), sizeof(tm) );
214 SG_LOG( SG_EVENT, SG_DEBUG,
215 " Current GMT = " << gmt->tm_mon+1 << "/"
216 << gmt->tm_mday << "/" << (1900 + gmt->tm_year) << " "
217 << gmt->tm_hour << ":" << gmt->tm_min << ":"
220 // calculate modified Julian date starting with current
221 mjd = sgTimeCurrentMJD( ct, warp );
223 // add in partial day
224 mjd += (gmt->tm_hour / 24.0) + (gmt->tm_min / (24.0 * 60.0)) +
225 (gmt->tm_sec / (24.0 * 60.0 * 60.0));
227 // convert "back" to Julian date + partial day (as a fraction of one)
229 SG_LOG( SG_EVENT, SG_DEBUG, " Current Julian Date = " << jd );
231 // printf(" Current Longitude = %.3f\n", FG_Longitude * SGD_RADIANS_TO_DEGREES);
233 // Calculate local side real time
234 if ( gst_diff < -100.0 ) {
235 // first time through do the expensive calculation & cheap
236 // calculation to get the difference.
237 SG_LOG( SG_EVENT, SG_INFO, " First time, doing precise gst" );
238 gst_precise = gst = sidereal_precise( mjd, 0.00 );
239 gst_course = sidereal_course( cur_time, gmt, 0.00 );
241 gst_diff = gst_precise - gst_course;
243 lst = sidereal_course( cur_time, gmt,
244 -(lon_rad * SGD_RADIANS_TO_DEGREES) ) + gst_diff;
246 // course + difference should drift off very slowly
247 gst = sidereal_course( cur_time, gmt, 0.00 ) + gst_diff;
248 lst = sidereal_course( cur_time, gmt,
249 -(lon_rad * SGD_RADIANS_TO_DEGREES) ) + gst_diff;
252 SG_LOG( SG_EVENT, SG_DEBUG,
253 " Current lon=0.00 Sidereal Time = " << gst );
254 SG_LOG( SG_EVENT, SG_DEBUG,
255 " Current LOCAL Sidereal Time = " << lst << " ("
256 << sidereal_precise( mjd, -(lon_rad * SGD_RADIANS_TO_DEGREES) )
257 << ") (diff = " << gst_diff << ")" );
261 // Given lon/lat, update timezone information and local_offset
262 void SGTime::updateLocal( double lon_rad, double lat_rad, const string& root ) {
264 if ( lon_rad < -SGD_PI || lon_rad> SGD_PI ) {
265 // not within -180 ... 180
268 if ( lat_rad < -SGD_PI_2 || lat_rad > SGD_PI_2 ) {
269 // not within -90 ... 90
272 if ( lon_rad != lon_rad ) {
273 // only true if lon_rad == nan
274 SG_LOG( SG_EVENT, SG_ALERT,
275 " Detected lon_rad == nan, resetting to 0.0" );
278 if ( lat_rad != lat_rad ) {
279 // only true if lat_rad == nan
280 SG_LOG( SG_EVENT, SG_ALERT,
281 " Detected lat_rad == nan, resetting to 0.0" );
285 time_t aircraftLocalTime;
286 SGGeoCoord location( SGD_RADIANS_TO_DEGREES * lat_rad,
287 SGD_RADIANS_TO_DEGREES * lon_rad );
288 SGGeoCoord* nearestTz = tzContainer->getNearest(location);
290 zone.append ( nearestTz->getDescription() );
291 zonename = zone.str();
293 //Avoid troubles when zone.tab hasn't got the right line endings
294 if (zonename[zonename.size()-1] == '\r')
296 zonename[zonename.size()-1]=0;
297 zone.set( zonename );
300 currGMT = sgTimeGetGMT( gmtime(&cur_time) );
301 aircraftLocalTime = sgTimeGetGMT( (fgLocaltime(&cur_time, zone.c_str())) );
302 local_offset = aircraftLocalTime - currGMT;
303 // cout << "Using " << local_offset << " as local time offset Timezone is "
304 // << zonename << endl;
308 // given a date in months, mn, days, dy, years, yr, return the
309 // modified Julian date (number of days elapsed since 1900 jan 0.5),
310 // mjd. Adapted from Xephem.
311 double sgTimeCalcMJD(int mn, double dy, int yr) {
314 // internal book keeping data
315 static double last_mjd, last_dy;
316 static int last_mn, last_yr;
321 if (mn == last_mn && yr == last_yr && dy == last_dy) {
326 y = (yr < 0) ? yr + 1 : yr;
332 if (yr < 1582 || (yr == 1582 && (mn < 10 || (mn == 10 && dy < 15)))) {
341 c = (long)((365.25*y) - 0.75) - 694025L;
343 c = (long)(365.25*y) - 694025L;
346 d = (int)(30.6001*(m+1));
348 mjd = b + c + d + dy - 0.5;
359 // return the current modified Julian date (number of days elapsed
360 // since 1900 jan 0.5), mjd.
361 double sgTimeCurrentMJD( time_t ct, long int warp ) {
363 struct tm m_gmt; // copy of system gmtime(&time_t) structure
364 struct tm *gmt = &m_gmt;
366 // get current Unix calendar time (in seconds)
367 // warp += warp_delta;
370 cur_time = ct + warp;
372 cur_time = time(NULL) + warp;
374 SG_LOG( SG_EVENT, SG_DEBUG,
375 " Current Unix calendar time = " << cur_time
376 << " warp = " << warp );
378 // get GMT break down for current time
379 memcpy( gmt, gmtime(&cur_time), sizeof(tm) );
380 SG_LOG( SG_EVENT, SG_DEBUG,
381 " Current GMT = " << gmt->tm_mon+1 << "/"
382 << gmt->tm_mday << "/" << (1900 + gmt->tm_year) << " "
383 << gmt->tm_hour << ":" << gmt->tm_min << ":"
386 // calculate modified Julian date
387 // t->mjd = cal_mjd ((int)(t->gmt->tm_mon+1), (double)t->gmt->tm_mday,
388 // (int)(t->gmt->tm_year + 1900));
389 double mjd = sgTimeCalcMJD( (int)(gmt->tm_mon+1), (double)gmt->tm_mday,
390 (int)(gmt->tm_year + 1900) );
396 // given an mjd, calculate greenwich mean sidereal time, gst
397 double sgTimeCalcGST( double mjd ) {
400 double day = floor(mjd-0.5)+0.5;
401 double hr = (mjd-day)*24.0;
404 T = ((int)(mjd - 0.5) + 0.5 - J2000)/36525.0;
405 x = 24110.54841 + (8640184.812866 + (0.093104 - 6.2e-6 * T) * T) * T;
407 gst = (1.0/SIDRATE)*hr + x;
409 SG_LOG( SG_EVENT, SG_DEBUG, " gst => " << gst );
415 #if defined( HAVE_TIMEGM )
416 // ignore this function
417 #elif defined( MK_TIME_IS_GMT )
418 // ignore this function
419 #else // ! defined ( MK_TIME_IS_GMT )
421 // Fix up timezone if using ftime()
422 static long int fix_up_timezone( long int timezone_orig ) {
423 # if !defined( HAVE_GETTIMEOFDAY ) && defined( HAVE_FTIME )
424 // ftime() needs a little extra help finding the current timezone
425 struct timeb current;
427 return( current.timezone * 60 );
429 return( timezone_orig );
435 /******************************************************************
436 * The following are some functions that were included as SGTime
437 * members, although they currently don't make use of any of the
438 * class's variables. Maybe this'll change in the future
439 *****************************************************************/
441 // Return time_t for Sat Mar 21 12:00:00 GMT
443 // On many systems it is ambiguous if mktime() assumes the input is in
444 // GMT, or local timezone. To address this, a new function called
445 // timegm() is appearing. It works exactly like mktime() but
446 // explicitely interprets the input as GMT.
448 // timegm() is available and documented under FreeBSD. It is
449 // available, but completely undocumented on my current Debian 2.1
452 // In the absence of timegm() we have to guess what mktime() might do.
454 // Many older BSD style systems have a mktime() that assumes the input
455 // time in GMT. But FreeBSD explicitly states that mktime() assumes
458 // The mktime() on many SYSV style systems (such as Linux) usually
459 // returns its result assuming you have specified the input time in
460 // your local timezone. Therefore, in the absence if timegm() you
461 // have to go to extra trouble to convert back to GMT.
463 // If you are having problems with incorrectly positioned astronomical
464 // bodies, this is a really good place to start looking.
466 time_t sgTimeGetGMT(int year, int month, int day, int hour, int min, int sec)
476 mt.tm_isdst = -1; // let the system determine the proper time zone
478 // For now we assume that if daylight is not defined in
479 // /usr/include/time.h that we have a machine with a mktime() that
480 // assumes input is in GMT ... this only matters if we are
481 // building on a system that does not have timegm()
482 #if !defined(HAVE_DAYLIGHT)
483 # define MK_TIME_IS_GMT 1
486 #if defined( HAVE_TIMEGM )
487 return ( timegm(&mt) );
488 #elif defined( MK_TIME_IS_GMT )
489 time_t ret = mktime(&mt);
495 // This is necessary as some mktime() calls may
496 // try to access the system timezone files
497 // if this open fails errno is set to 2
498 // CYGWIN for one does this
500 // perror( "sgTimeGetGMT()" );
504 // reset errno in any event.
508 #else // ! defined ( MK_TIME_IS_GMT )
510 // timezone seems to work as a proper offset for Linux & Solaris
511 # if defined( __linux__ ) || defined(__sun) ||defined(__CYGWIN__)
512 # define TIMEZONE_OFFSET_WORKS 1
515 #if defined(__CYGWIN__)
516 #define TIMEZONE _timezone
518 #define TIMEZONE timezone
521 time_t start = mktime(&mt);
523 SG_LOG( SG_EVENT, SG_DEBUG, "start1 = " << start );
524 // the ctime() call can screw up time progression on some versions
526 // fgPrintf( SG_EVENT, SG_DEBUG, "start2 = %s", ctime(&start));
527 SG_LOG( SG_EVENT, SG_DEBUG, "(tm_isdst = " << mt.tm_isdst << ")" );
529 TIMEZONE = fix_up_timezone( TIMEZONE );
531 # if defined( TIMEZONE_OFFSET_WORKS )
532 SG_LOG( SG_EVENT, SG_DEBUG,
533 "start = " << start << ", timezone = " << TIMEZONE );
534 return( start - TIMEZONE );
535 # else // ! defined( TIMEZONE_OFFSET_WORKS )
537 daylight = mt.tm_isdst;
538 if ( daylight > 0 ) {
540 } else if ( daylight < 0 ) {
541 SG_LOG( SG_EVENT, FG_WARN,
542 "OOOPS, problem in sg_time.cxx, no daylight savings info." );
545 long int offset = -(TIMEZONE / 3600 - daylight);
547 SG_LOG( SG_EVENT, SG_DEBUG, " Raw time zone offset = " << TIMEZONE );
548 SG_LOG( SG_EVENT, SG_DEBUG, " Daylight Savings = " << daylight );
549 SG_LOG( SG_EVENT, SG_DEBUG, " Local hours from GMT = " << offset );
551 long int start_gmt = start - TIMEZONE + (daylight * 3600);
553 SG_LOG( SG_EVENT, SG_DEBUG, " March 21 noon (CST) = " << start );
555 return ( start_gmt );
556 # endif // ! defined( TIMEZONE_OFFSET_WORKS )
557 #endif // ! defined ( MK_TIME_IS_GMT )
562 char* sgTimeFormatTime( const struct tm* p, char* buf )
564 sprintf( buf, "%d/%d/%2d %d:%02d:%02d",
565 p->tm_mon, p->tm_mday, p->tm_year,
566 p->tm_hour, p->tm_min, p->tm_sec);