litchi_wp.altitude

Module for litchi waypoint altitude settings

 1"""
 2Module for litchi waypoint altitude settings
 3"""
 4# pylint: disable=import-error
 5from litchi_wp.enums import AltitudeMode
 6
 7
 8class Altitude:
 9    """
10    Class representing litchi waypoint altitude settings
11
12    Attributes:
13        value (float): The height in meters
14        mode (AltitudeMode): The altitude mode
15
16    """
17
18    def __init__(self, value: float = -1.0, mode: AltitudeMode = AltitudeMode.AGL):
19        """
20        Constructor
21        Args:
22            value (float): The height in meters
23            mode (AltitudeMode): The altitude mode (MSL or AGL)
24
25        Raises:
26            ValueError: If mode is no valid AltitudeMode or value cannot be float
27
28        """
29        self.value = float(value)
30        self.mode = AltitudeMode(mode)
31
32    def set_mode(self, mode: AltitudeMode):
33        """
34        Setter for Altitudemode
35
36        Args:
37            mode (AltitudeMode): The enum of Altitudemode
38
39        Raises:
40            ValueError: If mode is no valid AltitudeMode
41
42        """
43        self.mode = AltitudeMode(mode)
44
45    def set_value(self, value: float):
46        """
47        Setter for value
48
49        Args:
50            value (float): The height in meters
51
52        Raises:
53            ValueError: If value cannot be float
54
55        """
56        self.value = float(value)
class Altitude: 
 9class Altitude:
10    """
11    Class representing litchi waypoint altitude settings
12
13    Attributes:
14        value (float): The height in meters
15        mode (AltitudeMode): The altitude mode
16
17    """
18
19    def __init__(self, value: float = -1.0, mode: AltitudeMode = AltitudeMode.AGL):
20        """
21        Constructor
22        Args:
23            value (float): The height in meters
24            mode (AltitudeMode): The altitude mode (MSL or AGL)
25
26        Raises:
27            ValueError: If mode is no valid AltitudeMode or value cannot be float
28
29        """
30        self.value = float(value)
31        self.mode = AltitudeMode(mode)
32
33    def set_mode(self, mode: AltitudeMode):
34        """
35        Setter for Altitudemode
36
37        Args:
38            mode (AltitudeMode): The enum of Altitudemode
39
40        Raises:
41            ValueError: If mode is no valid AltitudeMode
42
43        """
44        self.mode = AltitudeMode(mode)
45
46    def set_value(self, value: float):
47        """
48        Setter for value
49
50        Args:
51            value (float): The height in meters
52
53        Raises:
54            ValueError: If value cannot be float
55
56        """
57        self.value = float(value)

Class representing litchi waypoint altitude settings

Attributes:
  • value (float): The height in meters
  • mode (AltitudeMode): The altitude mode
Altitude( value: float = -1.0, mode: litchi_wp.enums.AltitudeMode = <AltitudeMode.AGL: 1>) 
19    def __init__(self, value: float = -1.0, mode: AltitudeMode = AltitudeMode.AGL):
20        """
21        Constructor
22        Args:
23            value (float): The height in meters
24            mode (AltitudeMode): The altitude mode (MSL or AGL)
25
26        Raises:
27            ValueError: If mode is no valid AltitudeMode or value cannot be float
28
29        """
30        self.value = float(value)
31        self.mode = AltitudeMode(mode)

Constructor

Arguments:
  • value (float): The height in meters
  • mode (AltitudeMode): The altitude mode (MSL or AGL)
Raises:
  • ValueError: If mode is no valid AltitudeMode or value cannot be float
def set_mode(self, mode: litchi_wp.enums.AltitudeMode): 
33    def set_mode(self, mode: AltitudeMode):
34        """
35        Setter for Altitudemode
36
37        Args:
38            mode (AltitudeMode): The enum of Altitudemode
39
40        Raises:
41            ValueError: If mode is no valid AltitudeMode
42
43        """
44        self.mode = AltitudeMode(mode)

Setter for Altitudemode

Arguments:
  • mode (AltitudeMode): The enum of Altitudemode
Raises:
  • ValueError: If mode is no valid AltitudeMode
def set_value(self, value: float): 
46    def set_value(self, value: float):
47        """
48        Setter for value
49
50        Args:
51            value (float): The height in meters
52
53        Raises:
54            ValueError: If value cannot be float
55
56        """
57        self.value = float(value)

Setter for value

Arguments:
  • value (float): The height in meters
Raises:
  • ValueError: If value cannot be float