Get rid of FGGeneral; expose equivlanet values via properties.

[flightgear.git] / docs-mini / README.digitalfilters

diff --git a/docs-mini/README.digitalfilters b/docs-mini/README.digitalfilters
index 3ebda47f73f7a55bb289c28d201673f75c50e4da..9f65b8ae9445bc4edd6a05daef5f64de9b8a34ed 100644 (file)
--- a/docs-mini/README.digitalfilters
+++ b/docs-mini/README.digitalfilters
@@ -1,3 +1,9 @@
+NOTE:
+This manual may contain outdated information. For documentation of the most recent features
+refer to
+http://wiki.flightgear.org/index.php/Howto:_Design_an_autopilot
+http://wiki.flightgear.org/index.php/Autopilot_Configuration_Reference
+
 COMMON SETTINGS
 ==============================================================================
 
@@ -26,6 +32,11 @@ The complete XML syntax for a InputValue is
   <offset>0.0</offset>
   <max>infinity</max>
   <min>-infinity<min>
+  <abs>false</abs>
+  <period>
+    <min>-180.0</min>
+    <max>-180.0</max>
+  </period>
 </some-element>
 
 The enclosing element <some-element> is the element defined in each filter, like <input>, <u_min>, 
@@ -55,6 +66,7 @@ The default values for elements not given are:
 <property/> : none
 <min/>   : unclipped
 <max/>   : unclipped
+<abs/>   : false
 
 Some examples:
 <input>
@@ -115,10 +127,14 @@ Example: Set the gain to 3.0 if /autopilot/locks/heading equals dg-heading-hold
     <value>2.0</value>
   <gain>
 <digital-filter>
+
+If the element <abs> is used and set to the value "true", only the absolute value of the input
+(the positive part) is used for further computations. The abs function is applied after all 
+other computations are completed.
     
 OutputValue           
 ==============================================================================
-Each filter drives one to many output properties. No scaling of offsetting is implemented
+Each filter drives one to many output properties. No scaling or offsetting is implemented
 for the output value, these should be done in the filter itself.
 The output properties are defined in the <output/> element by adding <property/> elements
 within the <output/> element. For just a single output property, the <property/> element
@@ -161,6 +177,8 @@ Example:
                           min or max value defaults to 0 (zero).
                           Note: <u_min> and <u_max> may also occour within a <config> element.
                           <min> and <max> may be used as a substitude for the corresponding u_xxx element.
+<period>      Complex     Define a periodical input or output value. The phase width is defined by the 
+                          child elements <min> and <max> which are of type InputValue
 
 Example: Limit the pilot's body temperature to a constant minimum of 36 and a maximum defined in
          /pilots/max-body-temperature-degc, initialized to 40.0
@@ -177,6 +195,17 @@ Implicit definition of the minimum value of 0 (zero) and defining a maximum of 1
   <u_max>100.0</u_max>
 </config>
 
+This defines the input or output as a periodic value with a phase width of 360, like 
+the compass rose.  Any value reaching the filter's input or leaving the filter at the 
+output will be transformed to fit into the given range by adding or substracting one phase 
+width of 360. Values of -270, 90 or 450 applied to this periodical element will allways 
+result in +90. A value of 630, 270 or -90 will be normalized to -90 in the given example.
+<period>
+  <min>-180.0</min>
+  <max>180.0</max>
+</period>
+
+
 <enable>      Complex     Define a condition to enable or disable the filter. For disabled
                           filters, no output computations are performed. Only enabled
                           filters fill the output properties. The default for undefined