Changes between Version 6 and Version 7 of doc/app/virtual_flight_parameters

Timestamp:

Jul 6, 2016 11:32:46 AM (9 years ago)

Author:

suehring

Comment:

--

doc/app/virtual_flight_parameters

@@ -26 +26 @@
 {{{#!td
 Horizontal flight angle (in degrees) describing the flight direction. 
-For example, if [#flight_angle flight_angle] = 0.0 (180.0), the aircraft moves parallel to the x-axis in positive (negative) x-direction, respectively. If [#flight_angle flight_angle] = 90.0 (270.0), the aircraft moves parallel to the y-axis in positive (negative) y-direction, respectively. Please note, the parameters has only an effect if the respective [#leg_mode leg_mode] is in 'cyclic'-mode, else the flight direction is determined directly by [#x_start x_start], [#x_end x_end], [#y_start y_start] and [#y_end y_end]. \\
-[#flight_angle flight_angle] must be within the range between 0 and 360.
+Please note, the parameters has only an effect if the respective [#leg_mode leg_mode] is in 'cyclic'-mode, else the flight direction is determined directly by [#x_start x_start], [#x_end x_end], [#y_start y_start] and [#y_end y_end]. [#flight_angle flight_angle] must be within the range between 0 and 360. \\
+
+The convention is as following: \\
+- [#flight_angle flight_angle]=0.0   - aircraft moves to the east
+- [#flight_angle flight_angle]=90.0  - aircraft moves to the north
+- [#flight_angle flight_angle]=180.0 - aircraft moves to the west
+- [#flight_angle flight_angle]=270.0 - aircraft moves to the south
+
+For example, if [#flight_angle flight_angle] = 0.0 (180.0), the aircraft moves parallel to the x-axis in positive (negative) x-direction, respectively. If [#flight_angle flight_angle] = 90.0 (270.0), the aircraft moves parallel to the y-axis in positive (negative) y-direction, respectively. 
 }}}
 |----------------
@@ -66 +73 @@
 }}}
 {{{#!td
-Flight mode, either 'cyclic' or 'return'. In case of 'cyclic', the sensor keep moving further if the end-position (see [#x_end x_end] and [#y_end y_end]) is reached, i.e. the sensor moves cyclically through the model domain. Instead, in case of 'return', the sensor turns around at the end-position and flies back, where it turns around again at the start-position and so on, i.e. the sensor only moves between start- and end-position until [#flight_end flight_end] is reached.    
+Flight mode, either 'cyclic' or 'return'. In case of 'cyclic', starting at ([#x_start x_start],[#y_start y_start]), the flight direction is determined only by [#flight_angle flight_angle] ([#x_end x_end],[#y_end y_end] are ignored) and the sensor moves cyclically through the model domain. Instead, in case of 'return', the flight direction is determined by ([#x_start x_start],[#y_start y_start]) and ([#x_end x_end],[#y_end y_end]) (here, [#flight_angle flight_angle] is ignored), i.e. the sensor turns around at the end-position and flies back, where it turns around again at the start-position and so on, until [#flight_end flight_end] is reached.    
 }}}
 |----------------
@@ -92 +99 @@
 }}}
 {{{#!td
-Maximum possible elevation change in case [#rate_of_climb rate_of_climb] is not equal to zero. If the maximum elevation change is reached, the virtual aircraft start descending until the original start level is reached again. For longer flights, the sensor moves vertically between [#flight_level flight_level] and [#flight_level flight_level] + [#max_elev_change max_elev_change]. Please note, [#flight_level flight_level] + [#max_elev_change max_elev_change] must not exceed the top of the model domain.
+Maximum possible elevation change in case [#rate_of_climb rate_of_climb] is not equal to zero. If the maximum elevation change is reached, the virtual aircraft starts descending until the original start level is reached again. For longer flights, the sensor moves vertically between [#flight_level flight_level] and [#flight_level flight_level] + [#max_elev_change max_elev_change]. Please note, [#flight_level flight_level] + [#max_elev_change max_elev_change] must not exceed the top of the model domain.
 }}}
 |----------------
@@ -134 +141 @@
 End-position of the flight leg along x in meter. Please note, this parameter has only an effect if [#leg_mode leg_mode]='return'.
 In case [#leg_mode leg_mode]='cyclic', the aircraft moves cyclically through the model domain.
-Moreover, [#x_end x_end] must be <= [#x_start x_start] in case of [#leg_mode leg_mode]='return'.
+Moreover, [#x_end x_end] must be >= [#x_start x_start] in case of [#leg_mode leg_mode]='return'.
 }}}
 |----------------
@@ -164 +171 @@
 End-position of the flight leg along y in meter. Please note, this parameter has only an effect if [#leg_mode leg_mode]='return'.
 In case [#leg_mode leg_mode]='cyclic', the aircraft moves cyclically through the model domain. 
-Moreover, [#y_end y_end] must be <= [#y_start y_start] in case of [#leg_mode leg_mode]='return'.
+Moreover, [#y_end y_end] must be >= [#y_start y_start] in case of [#leg_mode leg_mode]='return'.
 }}}
 |----------------