Land detector: Better docs and status feedback

This commit is contained in:
Lorenz Meier
2015-05-24 11:46:25 +02:00
parent 945aa4789b
commit 073f10fe4f
2 changed files with 13 additions and 8 deletions
+12 -7
View File
@@ -52,19 +52,24 @@ public:
virtual ~LandDetector();
/**
* @return true if this task is currently running
**/
* @return true if this task is currently running
**/
inline bool isRunning() const {return _taskIsRunning;}
/**
* @brief Tells the Land Detector task that it should exit
**/
* @return the current landed state
*/
bool isLanded() { return _landDetected.landed; }
/**
* @brief Tells the Land Detector task that it should exit
**/
void shutdown();
/**
* @brief Blocking function that should be called from it's own task thread. This method will
* run the underlying algorithm at the desired update rate and publish if the landing state changes.
**/
* @brief Blocking function that should be called from it's own task thread. This method will
* run the underlying algorithm at the desired update rate and publish if the landing state changes.
**/
void start();
protected: