PX4 Firmware
PX4 Autopilot Software http://px4.io
loiter.h
Go to the documentation of this file.
1 /***************************************************************************
2  *
3  * Copyright (c) 2014 PX4 Development Team. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in
13  * the documentation and/or other materials provided with the
14  * distribution.
15  * 3. Neither the name PX4 nor the names of its contributors may be
16  * used to endorse or promote products derived from this software
17  * without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
26  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  *
32  ****************************************************************************/
33 /**
34  * @file loiter.h
35  *
36  * Helper class to loiter
37  *
38  * @author Julian Oes <julian@oes.ch>
39  */
40 
41 #pragma once
42 
43 #include "navigator_mode.h"
44 #include "mission_block.h"
45 
46 #include <px4_platform_common/module_params.h>
47 
48 class Loiter : public MissionBlock, public ModuleParams
49 {
50 public:
52  ~Loiter() = default;
53 
54  void on_inactive() override;
55  void on_activation() override;
56  void on_active() override;
57 
58 private:
59  /**
60  * Use the stored reposition location of the navigator
61  * to move to a new location.
62  */
63  void reposition();
64 
65  /**
66  * Set the position to hold based on the current local position
67  */
68  void set_loiter_position();
69 
70  bool _loiter_pos_set{false};
71 };
Helper class to use mission items.
void set_loiter_position()
Set the position to hold based on the current local position.
Definition: loiter.cpp:82
void on_activation() override
This function is called one time when mode becomes active, pos_sp_triplet must be initialized here...
Definition: loiter.cpp:58
void on_active() override
This function is called while the mode is active.
Definition: loiter.cpp:69
Definition: loiter.h:48
void on_inactive() override
This function is called while the mode is inactive.
Definition: loiter.cpp:52
bool _loiter_pos_set
Definition: loiter.h:70
void reposition()
Use the stored reposition location of the navigator to move to a new location.
Definition: loiter.cpp:119
~Loiter()=default
Loiter(Navigator *navigator)
Definition: loiter.cpp:45