1 // fg_props.cxx -- support for FlightGear properties.
3 // Written by David Megginson, started 2000.
5 // Copyright (C) 2000, 2001 David Megginson - david@megginson.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 #include <simgear/compiler.h>
28 #include <simgear/structure/exception.hxx>
29 #include <simgear/props/props_io.hxx>
31 #include <simgear/magvar/magvar.hxx>
32 #include <simgear/timing/sg_time.hxx>
33 #include <simgear/misc/sg_path.hxx>
34 #include <simgear/sound/soundmgr_openal.hxx>
36 #include <Aircraft/aircraft.hxx>
37 #include <FDM/flight.hxx>
40 #include "globals.hxx"
41 #include "fg_props.hxx"
44 static bool winding_ccw = true; // FIXME: temporary
46 static bool fdm_data_logging = false; // FIXME: temporary
48 static bool frozen = false; // FIXME: temporary
52 ////////////////////////////////////////////////////////////////////////
53 // Default property bindings (not yet handled by any module).
54 ////////////////////////////////////////////////////////////////////////
56 struct LogClassMapping {
59 LogClassMapping(sgDebugClass cc, string nname) { c = cc; name = nname; }
62 LogClassMapping log_class_mappings [] = {
63 LogClassMapping(SG_NONE, "none"),
64 LogClassMapping(SG_TERRAIN, "terrain"),
65 LogClassMapping(SG_ASTRO, "astro"),
66 LogClassMapping(SG_FLIGHT, "flight"),
67 LogClassMapping(SG_INPUT, "input"),
68 LogClassMapping(SG_GL, "gl"),
69 LogClassMapping(SG_VIEW, "view"),
70 LogClassMapping(SG_COCKPIT, "cockpit"),
71 LogClassMapping(SG_GENERAL, "general"),
72 LogClassMapping(SG_MATH, "math"),
73 LogClassMapping(SG_EVENT, "event"),
74 LogClassMapping(SG_AIRCRAFT, "aircraft"),
75 LogClassMapping(SG_AUTOPILOT, "autopilot"),
76 LogClassMapping(SG_IO, "io"),
77 LogClassMapping(SG_CLIPPER, "clipper"),
78 LogClassMapping(SG_NETWORK, "network"),
79 LogClassMapping(SG_INSTR, "instrumentation"),
80 LogClassMapping(SG_SYSTEMS, "systems"),
81 LogClassMapping(SG_UNDEFD, "")
86 * Get the logging classes.
91 sgDebugClass classes = logbuf::get_log_classes();
94 for (int i = 0; log_class_mappings[i].c != SG_UNDEFD; i++) {
95 if ((classes&log_class_mappings[i].c) > 0) {
98 result += log_class_mappings[i].name;
101 return result.c_str();
106 addLoggingClass (const string &name)
108 sgDebugClass classes = logbuf::get_log_classes();
109 for (int i = 0; log_class_mappings[i].c != SG_UNDEFD; i++) {
110 if (name == log_class_mappings[i].name) {
111 logbuf::set_log_classes(sgDebugClass(classes|log_class_mappings[i].c));
115 SG_LOG(SG_GENERAL, SG_WARN, "Unknown logging class: " << name);
120 * Set the logging classes.
123 setLoggingClasses (const char * c)
126 logbuf::set_log_classes(SG_NONE);
128 if (classes == "none") {
129 SG_LOG(SG_GENERAL, SG_INFO, "Disabled all logging classes");
133 if (classes.empty() || classes == "all") { // default
134 logbuf::set_log_classes(SG_ALL);
135 SG_LOG(SG_GENERAL, SG_INFO, "Enabled all logging classes: "
136 << getLoggingClasses());
140 string rest = classes;
142 int sep = rest.find('|');
144 name = rest.substr(0, sep);
145 rest = rest.substr(sep+1);
146 addLoggingClass(name);
147 sep = rest.find('|');
149 addLoggingClass(rest);
150 SG_LOG(SG_GENERAL, SG_INFO, "Set logging classes to "
151 << getLoggingClasses());
156 * Get the logging priority.
159 getLoggingPriority ()
161 switch (logbuf::get_log_priority()) {
173 SG_LOG(SG_GENERAL, SG_WARN, "Internal: Unknown logging priority number: "
174 << logbuf::get_log_priority());
181 * Set the logging priority.
184 setLoggingPriority (const char * p)
189 if (priority == "bulk") {
190 logbuf::set_log_priority(SG_BULK);
191 } else if (priority == "debug") {
192 logbuf::set_log_priority(SG_DEBUG);
193 } else if (priority.empty() || priority == "info") { // default
194 logbuf::set_log_priority(SG_INFO);
195 } else if (priority == "warn") {
196 logbuf::set_log_priority(SG_WARN);
197 } else if (priority == "alert") {
198 logbuf::set_log_priority(SG_ALERT);
200 SG_LOG(SG_GENERAL, SG_WARN, "Unknown logging priority " << priority);
202 SG_LOG(SG_GENERAL, SG_DEBUG, "Logging priority is " << getLoggingPriority());
207 * Return the current frozen state.
217 * Set the current frozen state.
224 // Stop sound on a pause
225 SGSoundMgr *s = globals->get_soundmgr();
229 } else if (!fgGetBool("/sim/sound/pause")) {
237 * Return the number of milliseconds elapsed since simulation started.
240 getElapsedTime_sec ()
242 return globals->get_sim_time_sec();
247 * Return the current Zulu time.
252 static char buf[64]; // FIXME
253 struct tm * t = globals->get_time_params()->getGmt();
254 sprintf(buf, "%.4d-%.2d-%.2dT%.2d:%.2d:%.2d",
255 t->tm_year + 1900, t->tm_mon + 1, t->tm_mday,
256 t->tm_hour, t->tm_min, t->tm_sec);
262 * Set the current Zulu time.
265 setDateString (const char * date_string)
267 static const SGPropertyNode *cur_time_override
268 = fgGetNode("/sim/time/cur-time-override", true);
270 SGTime * st = globals->get_time_params();
271 struct tm * current_time = st->getGmt();
274 // Scan for basic ISO format
275 // YYYY-MM-DDTHH:MM:SS
276 int ret = sscanf(date_string, "%d-%d-%dT%d:%d:%d",
277 &(new_time.tm_year), &(new_time.tm_mon),
278 &(new_time.tm_mday), &(new_time.tm_hour),
279 &(new_time.tm_min), &(new_time.tm_sec));
281 // Be pretty picky about this, so
282 // that strange things don't happen
283 // if the save file has been edited
286 SG_LOG(SG_INPUT, SG_WARN, "Date/time string " << date_string
287 << " not in YYYY-MM-DDTHH:MM:SS format; skipped");
291 // OK, it looks like we got six
292 // values, one way or another.
293 new_time.tm_year -= 1900;
294 new_time.tm_mon -= 1;
296 // Now, tell flight gear to use
297 // the new time. This was far
298 // too difficult, by the way.
300 mktime(&new_time) - mktime(current_time) + globals->get_warp();
301 double lon = current_aircraft.fdm_state->get_Longitude();
302 double lat = current_aircraft.fdm_state->get_Latitude();
303 globals->set_warp(warp);
304 st->update(lon, lat, cur_time_override->getLongValue(), warp);
308 * Return the GMT as a string.
314 struct tm *t = globals->get_time_params()->getGmt();
315 snprintf(buf, 16, "%.2d:%.2d:%.2d",
316 t->tm_hour, t->tm_min, t->tm_sec);
321 * Return the magnetic variation
326 return globals->get_mag()->get_magvar() * SGD_RADIANS_TO_DEGREES;
331 * Return the magnetic dip
336 return globals->get_mag()->get_magdip() * SGD_RADIANS_TO_DEGREES;
341 * Return the current heading in degrees.
347 magheading = current_aircraft.fdm_state->get_Psi() * SGD_RADIANS_TO_DEGREES - getMagVar();
348 if (magheading < 0) magheading += 360;
355 return globals->get_warp();
361 globals->set_warp(warp);
367 return globals->get_warp_delta();
371 setWarpDelta (long delta)
373 globals->set_warp_delta(delta);
383 setWindingCCW (bool state)
387 glFrontFace ( GL_CCW );
389 glFrontFace ( GL_CW );
395 return fdm_data_logging;
399 setFDMDataLogging (bool state)
401 // kludge; no getter or setter available
402 if (state != fdm_data_logging) {
403 fgToggleFDMdataLogging();
404 fdm_data_logging = state;
409 getLongitudeString ()
411 static SGConstPropertyNode_ptr n = fgGetNode("/position/longitude-deg", true);
412 static SGConstPropertyNode_ptr f = fgGetNode("/sim/lon-lat-format", true);
414 double d = n->getDoubleValue();
415 int format = f->getIntValue();
416 char c = d < 0.0 ? 'W' : 'E';
419 snprintf(buf, 32, "%3.6f%c", d, c);
421 } else if (format == 1) {
422 // dd mm.mmm' (DMM-Format) -- uses a round-off factor tailored to the
423 // required precision of the minutes field (three decimal places),
424 // preventing minute values of 60.
425 double deg = fabs(d) + 5.0E-4 / 60.0;
426 double min = fabs(deg - int(deg)) * 60.0 - 4.999E-4;
427 snprintf(buf, 32, "%d*%06.3f%c", int(d < 0.0 ? -deg : deg), min, c);
430 // mm'ss.s'' (DMS-Format) -- uses a round-off factor tailored to the
431 // required precision of the seconds field (one decimal place),
432 // preventing second values of 60.
433 double deg = fabs(d) + 0.05 / 3600.0;
434 double min = (deg - int(deg)) * 60.0;
435 double sec = (min - int(min)) * 60.0 - 0.049;
436 snprintf(buf, 32, "%d*%02d %04.1f%c", int(d < 0.0 ? -deg : deg),
437 int(min), fabs(sec), c);
446 static SGConstPropertyNode_ptr n = fgGetNode("/position/latitude-deg", true);
447 static SGConstPropertyNode_ptr f = fgGetNode("/sim/lon-lat-format", true);
449 double d = n->getDoubleValue();
450 int format = f->getIntValue();
451 char c = d < 0.0 ? 'S' : 'N';
454 snprintf(buf, 32, "%3.6f%c", d, c);
456 } else if (format == 1) {
457 double deg = fabs(d) + 5.0E-4 / 60.0;
458 double min = fabs(deg - int(deg)) * 60.0 - 4.999E-4;
459 snprintf(buf, 32, "%d*%06.3f%c", int(d < 0.0 ? -deg : deg), min, c);
462 double deg = fabs(d) + 0.05 / 3600.0;
463 double min = (deg - int(deg)) * 60.0;
464 double sec = (min - int(min)) * 60.0 - 0.049;
465 snprintf(buf, 32, "%d*%02d %04.1f%c", int(d < 0.0 ? -deg : deg),
466 int(min), fabs(sec), c);
475 ////////////////////////////////////////////////////////////////////////
476 // Tie the properties.
477 ////////////////////////////////////////////////////////////////////////
479 FGProperties::FGProperties ()
483 FGProperties::~FGProperties ()
488 FGProperties::init ()
493 FGProperties::bind ()
496 fgTie("/sim/logging/priority", getLoggingPriority, setLoggingPriority);
497 fgTie("/sim/logging/classes", getLoggingClasses, setLoggingClasses);
498 fgTie("/sim/freeze/master", getFreeze, setFreeze);
500 fgTie("/sim/time/elapsed-sec", getElapsedTime_sec);
501 fgTie("/sim/time/gmt", getDateString, setDateString);
502 fgSetArchivable("/sim/time/gmt");
503 fgTie("/sim/time/gmt-string", getGMTString);
506 fgTie("/position/latitude-string", getLatitudeString);
507 fgTie("/position/longitude-string", getLongitudeString);
510 fgTie("/orientation/heading-magnetic-deg", getHeadingMag);
512 fgTie("/environment/magnetic-variation-deg", getMagVar);
513 fgTie("/environment/magnetic-dip-deg", getMagDip);
515 fgTie("/sim/time/warp", getWarp, setWarp, false);
516 fgTie("/sim/time/warp-delta", getWarpDelta, setWarpDelta);
518 // Misc. Temporary junk.
519 fgTie("/sim/temp/winding-ccw", getWindingCCW, setWindingCCW, false);
520 fgTie("/sim/temp/fdm-data-logging", getFDMDataLogging, setFDMDataLogging);
524 FGProperties::unbind ()
527 fgUntie("/sim/logging/priority");
528 fgUntie("/sim/logging/classes");
529 fgUntie("/sim/freeze/master");
531 fgUntie("/sim/time/elapsed-sec");
532 fgUntie("/sim/time/gmt");
533 fgUntie("/sim/time/gmt-string");
535 fgUntie("/position/latitude-string");
536 fgUntie("/position/longitude-string");
539 fgUntie("/orientation/heading-magnetic-deg");
542 fgUntie("/environment/magnetic-variation-deg");
543 fgUntie("/environment/magnetic-dip-deg");
545 fgUntie("/sim/time/warp");
546 fgUntie("/sim/time/warp-delta");
548 // Misc. Temporary junk.
549 fgUntie("/sim/temp/winding-ccw");
550 fgUntie("/sim/temp/full-screen");
551 fgUntie("/sim/temp/fdm-data-logging");
555 FGProperties::update (double dt)
557 static SGPropertyNode_ptr offset = fgGetNode("/sim/time/local-offset", true);
558 offset->setIntValue(globals->get_time_params()->get_local_offset());
562 static SGPropertyNode_ptr uyear = fgGetNode("/sim/time/utc/year", true);
563 static SGPropertyNode_ptr umonth = fgGetNode("/sim/time/utc/month", true);
564 static SGPropertyNode_ptr uday = fgGetNode("/sim/time/utc/day", true);
565 static SGPropertyNode_ptr uhour = fgGetNode("/sim/time/utc/hour", true);
566 static SGPropertyNode_ptr umin = fgGetNode("/sim/time/utc/minute", true);
567 static SGPropertyNode_ptr usec = fgGetNode("/sim/time/utc/second", true);
568 static SGPropertyNode_ptr uwday = fgGetNode("/sim/time/utc/weekday", true);
569 static SGPropertyNode_ptr udsec = fgGetNode("/sim/time/utc/day-seconds", true);
571 struct tm *u = globals->get_time_params()->getGmt();
572 uyear->setIntValue(u->tm_year + 1900);
573 umonth->setIntValue(u->tm_mon + 1);
574 uday->setIntValue(u->tm_mday);
575 uhour->setIntValue(u->tm_hour);
576 umin->setIntValue(u->tm_min);
577 usec->setIntValue(u->tm_sec);
578 uwday->setIntValue(u->tm_wday);
580 udsec->setIntValue(u->tm_hour * 3600 + u->tm_min * 60 + u->tm_sec);
583 // real local date/time
584 static SGPropertyNode_ptr ryear = fgGetNode("/sim/time/real/year", true);
585 static SGPropertyNode_ptr rmonth = fgGetNode("/sim/time/real/month", true);
586 static SGPropertyNode_ptr rday = fgGetNode("/sim/time/real/day", true);
587 static SGPropertyNode_ptr rhour = fgGetNode("/sim/time/real/hour", true);
588 static SGPropertyNode_ptr rmin = fgGetNode("/sim/time/real/minute", true);
589 static SGPropertyNode_ptr rsec = fgGetNode("/sim/time/real/second", true);
590 static SGPropertyNode_ptr rwday = fgGetNode("/sim/time/real/weekday", true);
592 time_t real = time(0);
593 struct tm *r = localtime(&real);
594 ryear->setIntValue(r->tm_year + 1900);
595 rmonth->setIntValue(r->tm_mon + 1);
596 rday->setIntValue(r->tm_mday);
597 rhour->setIntValue(r->tm_hour);
598 rmin->setIntValue(r->tm_min);
599 rsec->setIntValue(r->tm_sec);
600 rwday->setIntValue(r->tm_wday);
605 ////////////////////////////////////////////////////////////////////////
607 ////////////////////////////////////////////////////////////////////////
611 * Save the current state of the simulator to a stream.
614 fgSaveFlight (std::ostream &output, bool write_all)
617 fgSetBool("/sim/presets/onground", false);
618 fgSetArchivable("/sim/presets/onground");
619 fgSetBool("/sim/presets/trim", false);
620 fgSetArchivable("/sim/presets/trim");
621 fgSetString("/sim/presets/speed-set", "UVW");
622 fgSetArchivable("/sim/presets/speed-set");
625 writeProperties(output, globals->get_props(), write_all);
626 } catch (const sg_exception &e) {
627 guiErrorMessage("Error saving flight: ", e);
635 * Restore the current state of the simulator from a stream.
638 fgLoadFlight (std::istream &input)
640 SGPropertyNode props;
642 readProperties(input, &props);
643 } catch (const sg_exception &e) {
644 guiErrorMessage("Error reading saved flight: ", e);
648 fgSetBool("/sim/presets/onground", false);
649 fgSetBool("/sim/presets/trim", false);
650 fgSetString("/sim/presets/speed-set", "UVW");
652 copyProperties(&props, globals->get_props());
653 // When loading a flight, make it the
654 // new initial state.
655 globals->saveInitialState();
661 fgLoadProps (const char * path, SGPropertyNode * props, bool in_fg_root, int default_mode)
665 SGPath loadpath(globals->get_fg_root());
666 loadpath.append(path);
667 fullpath = loadpath.str();
673 readProperties(fullpath, props, default_mode);
674 } catch (const sg_exception &e) {
675 guiErrorMessage("Error reading properties: ", e);
683 ////////////////////////////////////////////////////////////////////////
684 // Property convenience functions.
685 ////////////////////////////////////////////////////////////////////////
688 fgGetNode (const char * path, bool create)
690 return globals->get_props()->getNode(path, create);
694 fgGetNode (const char * path, int index, bool create)
696 return globals->get_props()->getNode(path, index, create);
700 fgHasNode (const char * path)
702 return (fgGetNode(path, false) != 0);
706 fgAddChangeListener (SGPropertyChangeListener * listener, const char * path)
708 fgGetNode(path, true)->addChangeListener(listener);
712 fgAddChangeListener (SGPropertyChangeListener * listener,
713 const char * path, int index)
715 fgGetNode(path, index, true)->addChangeListener(listener);
719 fgGetBool (const char * name, bool defaultValue)
721 return globals->get_props()->getBoolValue(name, defaultValue);
725 fgGetInt (const char * name, int defaultValue)
727 return globals->get_props()->getIntValue(name, defaultValue);
731 fgGetLong (const char * name, long defaultValue)
733 return globals->get_props()->getLongValue(name, defaultValue);
737 fgGetFloat (const char * name, float defaultValue)
739 return globals->get_props()->getFloatValue(name, defaultValue);
743 fgGetDouble (const char * name, double defaultValue)
745 return globals->get_props()->getDoubleValue(name, defaultValue);
749 fgGetString (const char * name, const char * defaultValue)
751 return globals->get_props()->getStringValue(name, defaultValue);
755 fgSetBool (const char * name, bool val)
757 return globals->get_props()->setBoolValue(name, val);
761 fgSetInt (const char * name, int val)
763 return globals->get_props()->setIntValue(name, val);
767 fgSetLong (const char * name, long val)
769 return globals->get_props()->setLongValue(name, val);
773 fgSetFloat (const char * name, float val)
775 return globals->get_props()->setFloatValue(name, val);
779 fgSetDouble (const char * name, double val)
781 return globals->get_props()->setDoubleValue(name, val);
785 fgSetString (const char * name, const char * val)
787 return globals->get_props()->setStringValue(name, val);
791 fgSetArchivable (const char * name, bool state)
793 SGPropertyNode * node = globals->get_props()->getNode(name);
795 SG_LOG(SG_GENERAL, SG_DEBUG,
796 "Attempt to set archive flag for non-existant property "
799 node->setAttribute(SGPropertyNode::ARCHIVE, state);
803 fgSetReadable (const char * name, bool state)
805 SGPropertyNode * node = globals->get_props()->getNode(name);
807 SG_LOG(SG_GENERAL, SG_DEBUG,
808 "Attempt to set read flag for non-existant property "
811 node->setAttribute(SGPropertyNode::READ, state);
815 fgSetWritable (const char * name, bool state)
817 SGPropertyNode * node = globals->get_props()->getNode(name);
819 SG_LOG(SG_GENERAL, SG_DEBUG,
820 "Attempt to set write flag for non-existant property "
823 node->setAttribute(SGPropertyNode::WRITE, state);
827 fgUntie (const char * name)
829 if (!globals->get_props()->untie(name))
830 SG_LOG(SG_GENERAL, SG_WARN, "Failed to untie property " << name);
834 // end of fg_props.cxx