Property Tree Reorganization

From wiki.flightgear.org

Jump to: navigation, search
This article is a stub. You can help the wiki by expanding it..


The FlightGear property tree, being FlightGear's central nervous system, is becoming increasingly crowded with new nodes and properties, some of which may not yet be named according to existing naming conventions, or may simply not be placed in the most appropriate locations within the overall property tree structure. This page is meant to enable people to more easily keep track of such properties whose renaming/relocation may improve the overall property tree structure.

Please note that it is usually not sufficient to just simply rename properties within the corresponding XML files, as most properties are usually also referenced within core source code (C++), and other base package files (i.e. other XML and Nasal modules). So, any efforts to start renaming/moving properties, need to be carefully considered, discussed and coordinated with fellow contributors to ensure that no breakage is introduced by such efforts.

For instances where properties are modified (renamed/moved), it would probably be prudent to keep mirroring/aliasing the new property name/location using the previously used name (at least for a while) and register a nasal based listener callback to watch for any reads/writes to the old property, this would help ensure that any legacy uses of the properties are reported/tracked and don't break any functionality.

Contents

Properties with improvable names

Properties lacking unit specs (last confirmed in 04/2009)

  • /sim/presets/offset-distance (ought to be /sim/presets/offset-distance-nm according to predominant naming conventions) DONE - this was fixed in CVS/HEAD [1]
  • "nav-distance" properties under /instrumentation/nav[x] (i.e. /instrumentation/nav[0]/nav-distance) lack unit suffices
  • /instrumentation/radar/range lacks unit suffix
  • /instrumentation/turn-indicator/indicated-turn-rate lacks unit suffix

Properties using non-standard token separators

Properties with improvable locations