fly/flightgear
1
0
Fork 0
Code Activity

document the <period> element

Browse source
This commit is contained in:
torsten 2009-12-15 21:28:30 +00:00 committed by Tim Moore
parent 506f6894e4
commit 2b3e07cc5f
1 changed files with 18 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs-mini/README.digitalfilters
View file

@ -27,6 +27,10 @@ The complete XML syntax for a InputValue is
<max>infinity</max> <max>infinity</max>
<min>-infinity<min> <min>-infinity<min>
<abs>false</abs> <abs>false</abs>
<period>
<min>-180.0</min>
<max>-180.0</max>
</period>
</some-element> </some-element>
The enclosing element <some-element> is the element defined in each filter, like <input>, <u_min>, The enclosing element <some-element> is the element defined in each filter, like <input>, <u_min>,
@ -124,7 +128,7 @@ other computations are completed.
OutputValue 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. 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 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 within the <output/> element. For just a single output property, the <property/> element
@ -167,6 +171,8 @@ Example:
min or max value defaults to 0 (zero). min or max value defaults to 0 (zero).
Note: <u_min> and <u_max> may also occour within a <config> element. 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. <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 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 /pilots/max-body-temperature-degc, initialized to 40.0
@ -183,6 +189,17 @@ Implicit definition of the minimum value of 0 (zero) and defining a maximum of 1
<u_max>100.0</u_max> <u_max>100.0</u_max>
</config> </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 <enable> Complex Define a condition to enable or disable the filter. For disabled
filters, no output computations are performed. Only enabled filters, no output computations are performed. Only enabled
filters fill the output properties. The default for undefined filters fill the output properties. The default for undefined