api/builtins/Control: add done method

This can be used to check if a maneuver is done yet
This commit is contained in:
Laurens Valk
2020-02-09 23:39:59 +01:00
parent bdca322cef
commit 4a8912ff99
+3 -6
View File
@@ -114,14 +114,11 @@ class Control():
"""
pass
def active(self):
"""Check whether the controller is currently active.
When active, it continuously adjusts the actuation to reach the control
objective. When it is passive, the control signal is zero or constant.
def done(self):
"""Check whether an ongoing command or maneuver is done.
Returns:
bool: ``True`` if the controller is active,``False`` if not.
bool: ``True`` if the maneuver is done,``False`` if not.
"""
pass