3 * Data structures and routines for managing time related values.
6 // Written by Curtis Olson, started August 1997.
8 // Copyright (C) 1997 Curtis L. Olson - curt@flightgear.org
10 // This library is free software; you can redistribute it and/or
11 // modify it under the terms of the GNU Library General Public
12 // License as published by the Free Software Foundation; either
13 // version 2 of the License, or (at your option) any later version.
15 // This library is distributed in the hope that it will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 // Library General Public License for more details.
20 // You should have received a copy of the GNU Library General Public
21 // License along with this library; if not, write to the
22 // Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 // Boston, MA 02111-1307, USA.
33 # error This library requires C++
37 #include <simgear/compiler.h>
39 #ifdef SG_HAVE_STD_INCLUDES
45 #include <simgear/timing/timezone.h>
49 * A class to calculate and manage a variety of time parameters.
50 * The SGTime class provides many real-world time values. It
51 * calculates current time in seconds, GMT time, local time zone,
52 * local offset in seconds from GMT, Julian date, and sidereal
53 * time. All of these operate with seconds as their granularity so
54 * this class is not intended for timing sub-second events. These
55 * values are intended as input to things like real world lighting
56 * calculations and real astronomical object placement.
58 * To properly use the SGTime class there are a couple of things to be
59 * aware of. After creating an instance of the class, you will need to
60 * periodically (i.e. before every frame) call the update()
61 * method. Optionally, if you care about updating time zone
62 * information based on your latitude and longitude, you can call the
63 * updateLocal() method periodically as your position changes by
64 * significant amounts.
71 // tzContainer stores all the current Timezone control points/
72 TimezoneContainer* tzContainer;
74 // Points to the current local timezone name;
77 // Unix "calendar" time in seconds
80 // Break down of equivalent GMT time
81 #if defined(_MSC_VER) || defined(__MINGW32__)
82 struct tm m_gmt; // copy of system gmtime(&time_t) structure
87 // offset of local time relative to GMT
93 // modified Julian date
96 // side real time at prime meridian
99 // local sidereal time
102 // the difference between the precise / expensive sidereal time
103 // algorithm result and the quick course result. course_gst +
104 // gst_diff has pretty good accuracy over the span of a couple hours
109 /** Default constructor */
113 * Create an instance based on a specified position and data file path.
114 * This creates an instance of the SGTime object. When calling the
115 * constructor you need to provide a root path pointing to your
116 * time zone definition tree. Optionally, you can call a form of
117 * the constructor that accepts your current longitude and
118 * latitude in radians.
120 * If you don't know your position when you call the SGTime
121 * constructor, you can just use the first form (which assumes 0,
123 * @param lon current longitude
124 * @param lat current latitude
125 * @param root root path point to data file location (timezone, etc.) */
126 SGTime( double lon, double lat, const string& root );
129 * Create an instance given a data file path.
130 * @param root root path point to data file location (timezone, etc.)
132 SGTime( const string& root );
138 * Update the time related variables.
139 * The update() method requires you to pass in your position and
140 * an optional time offset in seconds. The offset (or warp) allows
141 * you to offset "sim" time relative to "real" time. The update()
142 * method is designed to be called by the host application before
144 * @param lon current longitude
145 * @param lat current latitude
146 * @param warp an optional time offset specified in seconds. This
147 * allows us to advance or rewind "time" if we choose to. */
148 void update( double lon, double lat, long int warp = 0 );
151 * Given lon/lat, update timezone information and local_offset
152 * The updateLocal() method is intended to be called less
153 * frequently - only when your position is likely to be changed
154 * enough that your timezone may have changed as well. In the
155 * FlightGear project we call updateLocal() every few minutes from
156 * our periodic event manager.
157 * @param lon current longitude
158 * @param lat current latitude
159 * @param root base path containing time zone directory */
160 void updateLocal( double lon, double lat, const string& root );
162 /** @return current system/unix time in seconds */
163 inline time_t get_cur_time() const { return cur_time; };
165 /** @return time zone name for your current position*/
166 inline char* get_zonename() const { return zonename; }
168 /** @return GMT in a "brokent down" tm structure */
169 #if defined(_MSC_VER) || defined(__MINGW32__)
170 inline struct tm* getGmt()const { return (struct tm *)&m_gmt; };
172 inline struct tm* getGmt()const { return gmt; };
175 /** @return julian date */
176 inline double getJD() const { return jd; };
178 /** @return modified julian date */
179 inline double getMjd() const { return mjd; };
181 /** @return local side real time */
182 inline double getLst() const { return lst; };
184 /** @return grenich side real time (lst when longitude == 0) */
185 inline double getGst() const { return gst; };
189 // Some useful utility functions that don't make sense to be part of
194 * Return unix time in seconds for the given data (relative to GMT)
195 * @param year current GMT year
196 * @param month current GMT month
197 * @param day current GMT day
198 * @param hour current GMT hour
199 * @param minute current minute
200 * @param second current second
201 * @return unix/system time in seconds
203 time_t sgTimeGetGMT(int year, int month, int day,
204 int hour, int minute, int second);
208 * this is just a wrapper for sgTimeGetGMT that allows an alternate
209 * form of input parameters.
210 * @param the_time the current GMT time in the tm structure
211 * @return unix/system time in seconds
213 inline time_t sgTimeGetGMT(struct tm* the_time) {
214 // printf("Using: %24s as input\n", asctime(the_time));
215 return sgTimeGetGMT(the_time->tm_year,
225 * Given a date in our form, return the equivalent modified Julian
226 * date (number of days elapsed since 1900 jan 0.5), mjd. Adapted
231 * @return modified julian date */
232 double sgTimeCalcMJD(int mn, double dy, int yr);
236 * Given an optional offset from current time calculate the current
237 * modified julian date.
238 * @param warp number of seconds to offset from current time (0 if no offset)
239 * @return current modified Julian date (number of days elapsed
240 * since 1900 jan 0.5), mjd. */
241 double sgTimeCurrentMJD( long int warp );
245 * Given an mjd, calculate greenwich mean sidereal time, gst
246 * @param mjd modified julian date
247 * @return greenwich mean sidereal time (gst) */
248 double sgTimeCalcGST( double mjd );
252 * Format time in a pretty form
253 * @param p time specified in a tm struct
254 * @param buf buffer space to contain the result
255 * @return pointer to character array containt the result
257 char* sgTimeFormatTime( const struct tm* p, char* buf );
260 #endif // _SG_TIME_HXX