Talk:Property tree: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
m (signing)
Line 41: Line 41:
for example
for example


:: As previously mentioned, it would be far better to collect all this information in a separate article, something along the lines of [[Property Tree Reference]], this would be directly targeted at contributors wishing to deal with the property tree in order to help them look up property names and purposes. In addition, it's probably worth pointing out that you don't have to come up with these properties manually, you can have FlightGear create a dump for you at runtime, either by using nasal or the built-in GUI wrapper provided by the property browser (see for example [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg10114.html]:"and the third addition is a value dump function: if you Shift-click on the '.' entry, then you get a dump to the terminal of all values."). Also, it's probably a good idea to differentiate between system-wide properties that are aircraft and session-agnostic and those ones that are specific to certain (types of) aircraft. However, in the long run, maintaining such a reference on the wiki may become tedious given that properties can be simply made up and renamed arbitrarily by aircraft developers/contributors, encouraging or even requiring contributors to introduce new properties with a corresponding "description" attribute would be far better given that this information would also be available at runtime (within the simulation), so that it could for example be used to dynamically display tooltip-like interactive help to describe the purpose of a property (see [http://wiki.flightgear.org/index.php/Recommended_Property_Tree_Enhancements#Suggested_new_attributes_in_PropertyList_XML_files] or [http://wiki.flightgear.org/index.php/Recommended_Project_Policies#Node_Descriptions_.26_Comments]). In addition, Nasal scripts could for example even write out such references to a text or even PDF file easily.
:: As previously mentioned, it would be far better to collect all this information in a separate article, something along the lines of [[Property Tree Reference]], this would be directly targeted at contributors wishing to deal with the property tree in order to help them look up property names and purposes. In addition, it's probably worth pointing out that you don't have to come up with these properties manually, you can have FlightGear create a dump for you at runtime, either by using nasal or the built-in GUI wrapper provided by the property browser (see for example [http://www.mail-archive.com/flightgear-devel@lists.sourceforge.net/msg10114.html]:"and the third addition is a value dump function: if you Shift-click on the '.' entry, then you get a dump to the terminal of all values."). Also, it's probably a good idea to differentiate between system-wide properties that are aircraft and session-agnostic and those ones that are specific to certain (types of) aircraft. However, in the long run, maintaining such a reference on the wiki may become tedious given that properties can be simply made up and renamed arbitrarily by aircraft developers/contributors, encouraging or even requiring contributors to introduce new properties with a corresponding "description" attribute would be far better given that this information would also be available at runtime (within the simulation), so that it could for example be used to dynamically display tooltip-like interactive help to describe the purpose of a property (see [http://wiki.flightgear.org/index.php/Recommended_Property_Tree_Enhancements#Suggested_new_attributes_in_PropertyList_XML_files] or [http://wiki.flightgear.org/index.php/Recommended_Project_Policies#Node_Descriptions_.26_Comments]). In addition, Nasal scripts could for example even write out such references to a text or even PDF file easily.--[[User:MILSTD|MILSTD]] 08:20, 8 September 2009 (EDT)


=Controls=
=Controls=

Revision as of 12:20, 8 September 2009

TODO

To add

Setting a property that does not exist in the property tree creates it. This gives you the ability to create your own properties in the FlightGear property tree just by bringing them into existence in your NASAL scripts or XML files.

Suggestion

I've been looking at the README.protocol which is here:

http://cvs.flightgear.org/viewvc/source/docs-mini/README.properties?view=markup

This seems to be broken down into two main areas as follows

  • Controls
    • Flight Controls
    • Engines
    • Fuel
    • Gear
    • Anti-Ice
    • Hydraulics
    • Electric
    • .. etc
  • FDM (Aircraft Settings)
    • Position
    • Orientation
    • Velocities
    • Engines
      • Common
      • Piston
    • .. etc
  • Light
    • Umm?

So that structure is nice and clear to me anyway about where the target property should be.

So the suggested format based on the above would be covering each node. with a brief description Having the nodes in plain text format (for cut and paste), and then a more detailed notes below. Also the nested tructure would make it nice with the navigation

for example

As previously mentioned, it would be far better to collect all this information in a separate article, something along the lines of Property Tree Reference, this would be directly targeted at contributors wishing to deal with the property tree in order to help them look up property names and purposes. In addition, it's probably worth pointing out that you don't have to come up with these properties manually, you can have FlightGear create a dump for you at runtime, either by using nasal or the built-in GUI wrapper provided by the property browser (see for example [1]:"and the third addition is a value dump function: if you Shift-click on the '.' entry, then you get a dump to the terminal of all values."). Also, it's probably a good idea to differentiate between system-wide properties that are aircraft and session-agnostic and those ones that are specific to certain (types of) aircraft. However, in the long run, maintaining such a reference on the wiki may become tedious given that properties can be simply made up and renamed arbitrarily by aircraft developers/contributors, encouraging or even requiring contributors to introduce new properties with a corresponding "description" attribute would be far better given that this information would also be available at runtime (within the simulation), so that it could for example be used to dynamically display tooltip-like interactive help to describe the purpose of a property (see [2] or [3]). In addition, Nasal scripts could for example even write out such references to a text or even PDF file easily.--MILSTD 08:20, 8 September 2009 (EDT)

Controls

Flight Controls

Main control surfaces for aircraft, blah blah blah. These are read from the sim on /controlsurfaces/

/controls/flight/aileron
/controls/flight/aileron-trim
/controls/flight/elevator
/controls/flight/elevator-trim
/controls/flight/rudder
/controls/flight/rudder-trim
/controls/flight/flaps
/controls/flight/slats
/controls/flight/BLC			// Boundary Layer Control
/controls/flight/spoilers
/controls/flight/speedbrake
/controls/flight/wing-sweep
/controls/flight/wing-fold
/controls/flight/drag-chute

Speed brakes are only blah blah..

Engines

Engine introduction. Thes appears in the FDM as

/controls/engines/throttle_idle
/controls/engines/engine[%d]/throttle
/controls/engines/engine[%d]/starter
/controls/engines/engine[%d]/fuel-pump
/controls/engines/engine[%d]/fire-switch
/controls/engines/engine[%d]/fire-bottle-discharge
/controls/engines/engine[%d]/cutoff
/controls/engines/engine[%d]/mixture
/controls/engines/engine[%d]/propeller-pitch
/controls/engines/engine[%d]/magnetos
/controls/engines/engine[%d]/boost
/controls/engines/engine[%d]/WEP
/controls/engines/engine[%d]/cowl-flaps-norm
/controls/engines/engine[%d]/feather
/controls/engines/engine[%d]/ignition
/controls/engines/engine[%d]/augmentation
/controls/engines/engine[%d]/afterburner
/controls/engines/engine[%d]/reverser
/controls/engines/engine[%d]/water-injection
/controls/engines/engine[%d]/condition

Other notes about above

FDM (Aircraft settings)

Engine

Intro to engine notes

common:

/engines/engine[%d]/fuel-flow-gph
/engines/engine[%d]/fuel-flow_pph
/engines/engine[%d]/thrust_lb
/engines/engine[%d]/running
/engines/engine[%d]/starter
/engines/engine[%d]/cranking

piston:

/engines/engine[%d]/mp-osi
/engines/engine[%d]/egt-degf
/engines/engine[%d]/oil-temperature-degf
/engines/engine[%d]/oil-pressure-psi
/engines/engine[%d]/cht-degf
/engines/engine[%d]/rpm

turbine:

/engines/engine[%d]/n1
/engines/engine[%d]/n2
/engines/engine[%d]/epr
/engines/engine[%d]/augmentation
/engines/engine[%d]/water-injection
/engines/engine[%d]/ignition
/engines/engine[%d]/nozzle-pos-norm
/engines/engine[%d]/inlet-pos-norm
/engines/engine[%d]/reversed
/engines/engine[%d]/cutoff

propeller:

/engines/engine[%d]/rpm
/engines/engine[%d]/pitch
/engines/engine[%d]/torque

ac001 05:45, 7 September 2009 (EDT)