1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
---|
2 | <html xmlns="http://www.w3.org/1999/xhtml">
|
---|
3 | <head>
|
---|
4 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
---|
5 | <meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
---|
6 | <meta name="generator" content="Doxygen 1.8.9.1"/>
|
---|
7 | <title>Flair: PidThrust.h Source File</title>
|
---|
8 | <link href="tabs.css" rel="stylesheet" type="text/css"/>
|
---|
9 | <script type="text/javascript" src="jquery.js"></script>
|
---|
10 | <script type="text/javascript" src="dynsections.js"></script>
|
---|
11 | <link href="navtree.css" rel="stylesheet" type="text/css"/>
|
---|
12 | <script type="text/javascript" src="resize.js"></script>
|
---|
13 | <script type="text/javascript" src="navtreedata.js"></script>
|
---|
14 | <script type="text/javascript" src="navtree.js"></script>
|
---|
15 | <script type="text/javascript">
|
---|
16 | $(document).ready(initResizable);
|
---|
17 | $(window).load(resizeHeight);
|
---|
18 | </script>
|
---|
19 | <link href="search/search.css" rel="stylesheet" type="text/css"/>
|
---|
20 | <script type="text/javascript" src="search/searchdata.js"></script>
|
---|
21 | <script type="text/javascript" src="search/search.js"></script>
|
---|
22 | <script type="text/javascript">
|
---|
23 | $(document).ready(function() { init_search(); });
|
---|
24 | </script>
|
---|
25 | <link href="doxygen.css" rel="stylesheet" type="text/css" />
|
---|
26 | </head>
|
---|
27 | <body>
|
---|
28 | <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
---|
29 | <div id="titlearea">
|
---|
30 | <table cellspacing="0" cellpadding="0">
|
---|
31 | <tbody>
|
---|
32 | <tr style="height: 56px;">
|
---|
33 | <td id="projectlogo"><img alt="Logo" src="logo_hds.png"/></td>
|
---|
34 | <td style="padding-left: 0.5em;">
|
---|
35 | <div id="projectname">Flair
|
---|
36 | </div>
|
---|
37 | <div id="projectbrief">Framework Libre Air</div>
|
---|
38 | </td>
|
---|
39 | </tr>
|
---|
40 | </tbody>
|
---|
41 | </table>
|
---|
42 | </div>
|
---|
43 | <!-- end header part -->
|
---|
44 | <!-- Generated by Doxygen 1.8.9.1 -->
|
---|
45 | <script type="text/javascript">
|
---|
46 | var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
---|
47 | </script>
|
---|
48 | <div id="navrow1" class="tabs">
|
---|
49 | <ul class="tablist">
|
---|
50 | <li><a href="index.html"><span>Main Page</span></a></li>
|
---|
51 | <li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
---|
52 | <li><a href="annotated.html"><span>Classes</span></a></li>
|
---|
53 | <li class="current"><a href="files.html"><span>Files</span></a></li>
|
---|
54 | <li>
|
---|
55 | <div id="MSearchBox" class="MSearchBoxInactive">
|
---|
56 | <span class="left">
|
---|
57 | <img id="MSearchSelect" src="search/mag_sel.png"
|
---|
58 | onmouseover="return searchBox.OnSearchSelectShow()"
|
---|
59 | onmouseout="return searchBox.OnSearchSelectHide()"
|
---|
60 | alt=""/>
|
---|
61 | <input type="text" id="MSearchField" value="Search" accesskey="S"
|
---|
62 | onfocus="searchBox.OnSearchFieldFocus(true)"
|
---|
63 | onblur="searchBox.OnSearchFieldFocus(false)"
|
---|
64 | onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
---|
65 | </span><span class="right">
|
---|
66 | <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
---|
67 | </span>
|
---|
68 | </div>
|
---|
69 | </li>
|
---|
70 | </ul>
|
---|
71 | </div>
|
---|
72 | <div id="navrow2" class="tabs2">
|
---|
73 | <ul class="tablist">
|
---|
74 | <li><a href="files.html"><span>File List</span></a></li>
|
---|
75 | </ul>
|
---|
76 | </div>
|
---|
77 | </div><!-- top -->
|
---|
78 | <div id="side-nav" class="ui-resizable side-nav-resizable">
|
---|
79 | <div id="nav-tree">
|
---|
80 | <div id="nav-tree-contents">
|
---|
81 | <div id="nav-sync" class="sync"></div>
|
---|
82 | </div>
|
---|
83 | </div>
|
---|
84 | <div id="splitbar" style="-moz-user-select:none;"
|
---|
85 | class="ui-resizable-handle">
|
---|
86 | </div>
|
---|
87 | </div>
|
---|
88 | <script type="text/javascript">
|
---|
89 | $(document).ready(function(){initNavTree('_pid_thrust_8h_source.html','');});
|
---|
90 | </script>
|
---|
91 | <div id="doc-content">
|
---|
92 | <!-- window showing the filter options -->
|
---|
93 | <div id="MSearchSelectWindow"
|
---|
94 | onmouseover="return searchBox.OnSearchSelectShow()"
|
---|
95 | onmouseout="return searchBox.OnSearchSelectHide()"
|
---|
96 | onkeydown="return searchBox.OnSearchSelectKey(event)">
|
---|
97 | </div>
|
---|
98 |
|
---|
99 | <!-- iframe showing the search results (closed by default) -->
|
---|
100 | <div id="MSearchResultsWindow">
|
---|
101 | <iframe src="javascript:void(0)" frameborder="0"
|
---|
102 | name="MSearchResults" id="MSearchResults">
|
---|
103 | </iframe>
|
---|
104 | </div>
|
---|
105 |
|
---|
106 | <div class="header">
|
---|
107 | <div class="headertitle">
|
---|
108 | <div class="title">PidThrust.h</div> </div>
|
---|
109 | </div><!--header-->
|
---|
110 | <div class="contents">
|
---|
111 | <a href="_pid_thrust_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// %flair:license{</span></div>
|
---|
112 | <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// This file is part of the Flair framework distributed under the</span></div>
|
---|
113 | <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// CECILL-C License, Version 1.0.</span></div>
|
---|
114 | <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// %flair:license}</span></div>
|
---|
115 | <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span><span class="preprocessor">#ifndef PIDTHRUST_H</span></div>
|
---|
116 | <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define PIDTHRUST_H</span></div>
|
---|
117 | <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
|
---|
118 | <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <<a class="code" href="_control_law_8h.html">ControlLaw.h</a>></span></div>
|
---|
119 | <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
|
---|
120 | <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">namespace </span><a class="code" href="namespaceflair.html">flair</a> {</div>
|
---|
121 | <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">namespace </span>gui {</div>
|
---|
122 | <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">class </span>LayoutPosition;</div>
|
---|
123 | <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> }</div>
|
---|
124 | <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> }</div>
|
---|
125 | <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div>
|
---|
126 | <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">class </span>PidThrust_impl;</div>
|
---|
127 | <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
|
---|
128 | <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span><a class="code" href="namespaceflair.html">flair</a> {</div>
|
---|
129 | <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span>filter {</div>
|
---|
130 | <div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classflair_1_1filter_1_1_pid_thrust.html"> 33</a></span> <span class="keyword">class </span><a class="code" href="classflair_1_1filter_1_1_pid_thrust.html">PidThrust</a> : <span class="keyword">public</span> <a class="code" href="classflair_1_1filter_1_1_control_law.html">ControlLaw</a> {</div>
|
---|
131 | <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">friend</span> class ::PidThrust_impl;</div>
|
---|
132 | <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div>
|
---|
133 | <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">public</span>:</div>
|
---|
134 | <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="classflair_1_1filter_1_1_pid_thrust.html#ab46191511449bc44699102a239eb82f6">PidThrust</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *position, std::string name);</div>
|
---|
135 | <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
|
---|
136 | <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="classflair_1_1filter_1_1_pid_thrust.html#a0332ced449a5257a484e484379921445">~PidThrust</a>();</div>
|
---|
137 | <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
|
---|
138 | <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1filter_1_1_pid_thrust.html#a4987d6892e567cce5af9b22dcf065542">Reset</a>(<span class="keywordtype">void</span>);</div>
|
---|
139 | <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
|
---|
140 | <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1filter_1_1_pid_thrust.html#ad82440a1c4d9b0409c8549f900991223">ResetI</a>(<span class="keywordtype">void</span>);</div>
|
---|
141 | <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
|
---|
142 | <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1filter_1_1_pid_thrust.html#a3ec37a57185a1f3164e081e89b08e378">ResetOffset</a>(<span class="keywordtype">void</span>);</div>
|
---|
143 | <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
|
---|
144 | <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1filter_1_1_pid_thrust.html#a9109d86fb350919a673af114c5d66f0f">SetOffset</a>(<span class="keywordtype">void</span>);</div>
|
---|
145 | <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div>
|
---|
146 | <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">float</span> <a class="code" href="classflair_1_1filter_1_1_pid_thrust.html#a3658197f9d580bc810fc65451399f307">GetOffset</a>(<span class="keywordtype">void</span>);</div>
|
---|
147 | <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
|
---|
148 | <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordtype">bool</span> <a class="code" href="classflair_1_1filter_1_1_pid_thrust.html#ac556b3702ad3352fdfad1bde19f16af0">OffsetStepUp</a>(<span class="keywordtype">void</span>);</div>
|
---|
149 | <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div>
|
---|
150 | <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordtype">bool</span> <a class="code" href="classflair_1_1filter_1_1_pid_thrust.html#ac3810b92073bc3e5062a387e089b2295">OffsetStepDown</a>(<span class="keywordtype">void</span>);</div>
|
---|
151 | <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div>
|
---|
152 | <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1filter_1_1_pid_thrust.html#afdbec017ebadc52cef7e901ecd92d959">SetValues</a>(<span class="keywordtype">float</span> p, <span class="keywordtype">float</span> d);</div>
|
---|
153 | <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div>
|
---|
154 | <div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1filter_1_1_pid_thrust.html#a8b77f7720b1406f48baa3c43cf87765a">UseDefaultPlot</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *position);</div>
|
---|
155 | <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div>
|
---|
156 | <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="keyword">private</span>:</div>
|
---|
157 | <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordtype">void</span> UpdateFrom(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1io__data.html">core::io_data</a> *data);</div>
|
---|
158 | <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div>
|
---|
159 | <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  PidThrust_impl *pimpl_;</div>
|
---|
160 | <div class="line"><a name="l00135"></a><span class="lineno"> 135</span> };</div>
|
---|
161 | <div class="line"><a name="l00136"></a><span class="lineno"> 136</span> } <span class="comment">// end namespace filter</span></div>
|
---|
162 | <div class="line"><a name="l00137"></a><span class="lineno"> 137</span> } <span class="comment">// end namespace flair</span></div>
|
---|
163 | <div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="preprocessor">#endif // PIDTHRUST_H</span></div>
|
---|
164 | <div class="ttc" id="classflair_1_1core_1_1io__data_html"><div class="ttname"><a href="classflair_1_1core_1_1io__data.html">flair::core::io_data</a></div><div class="ttdoc">Abstract class for data types. </div><div class="ttdef"><b>Definition:</b> io_data.h:77</div></div>
|
---|
165 | <div class="ttc" id="classflair_1_1filter_1_1_pid_thrust_html_a9109d86fb350919a673af114c5d66f0f"><div class="ttname"><a href="classflair_1_1filter_1_1_pid_thrust.html#a9109d86fb350919a673af114c5d66f0f">flair::filter::PidThrust::SetOffset</a></div><div class="ttdeci">void SetOffset(void)</div><div class="ttdoc">Set offset to specified value in ground station. </div></div>
|
---|
166 | <div class="ttc" id="classflair_1_1filter_1_1_control_law_html"><div class="ttname"><a href="classflair_1_1filter_1_1_control_law.html">flair::filter::ControlLaw</a></div><div class="ttdoc">Base class for control law input must be created by reimplemented class. output is created by this cl...</div><div class="ttdef"><b>Definition:</b> ControlLaw.h:36</div></div>
|
---|
167 | <div class="ttc" id="namespaceflair_html"><div class="ttname"><a href="namespaceflair.html">flair</a></div><div class="ttdoc">namespace of the flair Framework </div><div class="ttdef"><b>Definition:</b> Ahrs.h:19</div></div>
|
---|
168 | <div class="ttc" id="classflair_1_1filter_1_1_pid_thrust_html"><div class="ttname"><a href="classflair_1_1filter_1_1_pid_thrust.html">flair::filter::PidThrust</a></div><div class="ttdoc">Class defining a Pid for Thrust. This Pid as an extra offset for compensating gravity. </div><div class="ttdef"><b>Definition:</b> PidThrust.h:33</div></div>
|
---|
169 | <div class="ttc" id="classflair_1_1filter_1_1_pid_thrust_html_ac556b3702ad3352fdfad1bde19f16af0"><div class="ttname"><a href="classflair_1_1filter_1_1_pid_thrust.html#ac556b3702ad3352fdfad1bde19f16af0">flair::filter::PidThrust::OffsetStepUp</a></div><div class="ttdeci">bool OffsetStepUp(void)</div><div class="ttdoc">Step up the offset according to specified value in ground station. </div></div>
|
---|
170 | <div class="ttc" id="classflair_1_1filter_1_1_pid_thrust_html_a0332ced449a5257a484e484379921445"><div class="ttname"><a href="classflair_1_1filter_1_1_pid_thrust.html#a0332ced449a5257a484e484379921445">flair::filter::PidThrust::~PidThrust</a></div><div class="ttdeci">~PidThrust()</div><div class="ttdoc">Destructor. </div></div>
|
---|
171 | <div class="ttc" id="_control_law_8h_html"><div class="ttname"><a href="_control_law_8h.html">ControlLaw.h</a></div><div class="ttdoc">Base class for control law. </div></div>
|
---|
172 | <div class="ttc" id="classflair_1_1filter_1_1_pid_thrust_html_afdbec017ebadc52cef7e901ecd92d959"><div class="ttname"><a href="classflair_1_1filter_1_1_pid_thrust.html#afdbec017ebadc52cef7e901ecd92d959">flair::filter::PidThrust::SetValues</a></div><div class="ttdeci">void SetValues(float p, float d)</div><div class="ttdoc">Set input values. </div></div>
|
---|
173 | <div class="ttc" id="classflair_1_1filter_1_1_pid_thrust_html_ad82440a1c4d9b0409c8549f900991223"><div class="ttname"><a href="classflair_1_1filter_1_1_pid_thrust.html#ad82440a1c4d9b0409c8549f900991223">flair::filter::PidThrust::ResetI</a></div><div class="ttdeci">void ResetI(void)</div><div class="ttdoc">Reset integral to 0. </div></div>
|
---|
174 | <div class="ttc" id="classflair_1_1filter_1_1_pid_thrust_html_ac3810b92073bc3e5062a387e089b2295"><div class="ttname"><a href="classflair_1_1filter_1_1_pid_thrust.html#ac3810b92073bc3e5062a387e089b2295">flair::filter::PidThrust::OffsetStepDown</a></div><div class="ttdeci">bool OffsetStepDown(void)</div><div class="ttdoc">Step down the offset according to specified value in ground station. </div></div>
|
---|
175 | <div class="ttc" id="classflair_1_1filter_1_1_pid_thrust_html_a3658197f9d580bc810fc65451399f307"><div class="ttname"><a href="classflair_1_1filter_1_1_pid_thrust.html#a3658197f9d580bc810fc65451399f307">flair::filter::PidThrust::GetOffset</a></div><div class="ttdeci">float GetOffset(void)</div><div class="ttdoc">Get offset. </div></div>
|
---|
176 | <div class="ttc" id="classflair_1_1filter_1_1_pid_thrust_html_ab46191511449bc44699102a239eb82f6"><div class="ttname"><a href="classflair_1_1filter_1_1_pid_thrust.html#ab46191511449bc44699102a239eb82f6">flair::filter::PidThrust::PidThrust</a></div><div class="ttdeci">PidThrust(const gui::LayoutPosition *position, std::string name)</div><div class="ttdoc">Constructor. </div></div>
|
---|
177 | <div class="ttc" id="classflair_1_1filter_1_1_pid_thrust_html_a4987d6892e567cce5af9b22dcf065542"><div class="ttname"><a href="classflair_1_1filter_1_1_pid_thrust.html#a4987d6892e567cce5af9b22dcf065542">flair::filter::PidThrust::Reset</a></div><div class="ttdeci">void Reset(void)</div><div class="ttdoc">Reset integral and offset to 0. </div></div>
|
---|
178 | <div class="ttc" id="classflair_1_1gui_1_1_layout_position_html"><div class="ttname"><a href="classflair_1_1gui_1_1_layout_position.html">flair::gui::LayoutPosition</a></div><div class="ttdoc">Class to define a position in a layout on the ground station. </div><div class="ttdef"><b>Definition:</b> LayoutPosition.h:28</div></div>
|
---|
179 | <div class="ttc" id="classflair_1_1filter_1_1_pid_thrust_html_a3ec37a57185a1f3164e081e89b08e378"><div class="ttname"><a href="classflair_1_1filter_1_1_pid_thrust.html#a3ec37a57185a1f3164e081e89b08e378">flair::filter::PidThrust::ResetOffset</a></div><div class="ttdeci">void ResetOffset(void)</div><div class="ttdoc">Reset offset to 0. </div></div>
|
---|
180 | <div class="ttc" id="classflair_1_1filter_1_1_pid_thrust_html_a8b77f7720b1406f48baa3c43cf87765a"><div class="ttname"><a href="classflair_1_1filter_1_1_pid_thrust.html#a8b77f7720b1406f48baa3c43cf87765a">flair::filter::PidThrust::UseDefaultPlot</a></div><div class="ttdeci">void UseDefaultPlot(const gui::LayoutPosition *position)</div><div class="ttdoc">Use default plot. </div></div>
|
---|
181 | </div><!-- fragment --></div><!-- contents -->
|
---|
182 | </div><!-- doc-content -->
|
---|
183 | <!-- start footer part -->
|
---|
184 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
---|
185 | <ul>
|
---|
186 | <li class="navelem"><a class="el" href="dir_795fcb729bac4b07de678d11c3b7bf3b.html">gsanahuj</a></li><li class="navelem"><a class="el" href="dir_d9f696bd07998dbcfc5b49e19dc5f66d.html">igep</a></li><li class="navelem"><a class="el" href="dir_cecb9d1b9ff0c5bb6bd9d3ae75a47986.html">flair-src</a></li><li class="navelem"><a class="el" href="dir_9733168e1eafb017f79f3cf37481363a.html">lib</a></li><li class="navelem"><a class="el" href="dir_d0f69da3e8bf0da2542eec725609ceb6.html">FlairFilter</a></li><li class="navelem"><a class="el" href="dir_b96dac0bc3e1d69d70a80e3f31524a0d.html">src</a></li><li class="navelem"><a class="el" href="_pid_thrust_8h.html">PidThrust.h</a></li>
|
---|
187 | <li class="footer">Generated on Wed Jun 22 2016 08:08:41 for Flair by
|
---|
188 | <a href="http://www.doxygen.org/index.html">
|
---|
189 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
|
---|
190 | </ul>
|
---|
191 | </div>
|
---|
192 | </body>
|
---|
193 | </html>
|
---|