The Property Tree

A fundamental structure in FlightGear is the property tree. This is a data structure formed from SGPropertyNode instances. FlightGear has a global Property Tree, which is the one visible in the Property Browser and containing nodes such as /sim/aircraft. The C++ and Nasal code also uses many “local” property trees, which are simply trees of SGPropertyNode instances.

How to reference C++ overloads is explained in the Sphinx manual:

• cpp:func:`SGPropertyNode::alias` as well as cpp:func:`SGPropertyNode::alias()` reference an arbitrary overload of SGPropertyNode::alias(): SGPropertyNode::alias();

• cpp:func:`bool SGPropertyNode::alias(SGPropertyNode* target, bool withListener)` references a specific overload: bool SGPropertyNode::alias(SGPropertyNode* target, bool withListener);

• ditto for the other overloads bool SGPropertyNode::alias(const char* path, bool withListener) and bool SGPropertyNode::alias(const std::string& path, bool withListener).

Doxygen has a grouping feature to avoid repeating the same documentation for similar overloads and Breathe is supposed to support it, however I didn’t manage to use it successfully here (there was an XML file named xml/df/dc0/group__MyGroupNameHere.xml with seemingly good data in the Doxygen output, however my cpp:func:`...` for the groupped overloads pointed nowhere).

Classes

• SGPropertyNode
  • SGPropertyNode