| 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: Pid.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_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">Pid.h</div> </div>
|
|---|
| 109 | </div><!--header-->
|
|---|
| 110 | <div class="contents">
|
|---|
| 111 | <a href="_pid_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 PID_H</span></div>
|
|---|
| 116 | <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define PID_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>Pid_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="l00032"></a><span class="lineno"><a class="line" href="classflair_1_1filter_1_1_pid.html"> 32</a></span> <span class="keyword">class </span><a class="code" href="classflair_1_1filter_1_1_pid.html">Pid</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="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">friend</span> class ::Pid_impl;</div>
|
|---|
| 132 | <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
|
|---|
| 133 | <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">public</span>:</div>
|
|---|
| 134 | <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="classflair_1_1filter_1_1_pid.html#a6505c295f5e719f1d85620b44c62d619">Pid</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="l00048"></a><span class="lineno"> 48</span> </div>
|
|---|
| 136 | <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classflair_1_1filter_1_1_pid.html#ab8e08d20453ac21096363f591ac365df">~Pid</a>();</div>
|
|---|
| 137 | <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
|
|---|
| 138 | <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1filter_1_1_pid.html#a41573a79913af95cbb94d30225e913b6">Reset</a>(<span class="keywordtype">void</span>);</div>
|
|---|
| 139 | <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
|
|---|
| 140 | <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1filter_1_1_pid.html#a27c025ae6b9a9a192a234ab74e2e6f8b">SetValues</a>(<span class="keywordtype">float</span> p, <span class="keywordtype">float</span> d);</div>
|
|---|
| 141 | <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div>
|
|---|
| 142 | <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1filter_1_1_pid.html#a8128ecc530ff19abae93027d72d4b5ec">UseDefaultPlot</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *position);</div>
|
|---|
| 143 | <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
|
|---|
| 144 | <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="keyword">private</span>:</div>
|
|---|
| 145 | <div class="line"><a name="l00091"></a><span class="lineno"> 91</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>
|
|---|
| 146 | <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
|
|---|
| 147 | <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  Pid_impl *pimpl_;</div>
|
|---|
| 148 | <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> };</div>
|
|---|
| 149 | <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> } <span class="comment">// end namespace filter</span></div>
|
|---|
| 150 | <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> } <span class="comment">// end namespace flair</span></div>
|
|---|
| 151 | <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="preprocessor">#endif // PID_H</span></div>
|
|---|
| 152 | <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>
|
|---|
| 153 | <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>
|
|---|
| 154 | <div class="ttc" id="classflair_1_1filter_1_1_pid_html_a6505c295f5e719f1d85620b44c62d619"><div class="ttname"><a href="classflair_1_1filter_1_1_pid.html#a6505c295f5e719f1d85620b44c62d619">flair::filter::Pid::Pid</a></div><div class="ttdeci">Pid(const gui::LayoutPosition *position, std::string name)</div><div class="ttdoc">Constructor. </div></div>
|
|---|
| 155 | <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>
|
|---|
| 156 | <div class="ttc" id="classflair_1_1filter_1_1_pid_html_a41573a79913af95cbb94d30225e913b6"><div class="ttname"><a href="classflair_1_1filter_1_1_pid.html#a41573a79913af95cbb94d30225e913b6">flair::filter::Pid::Reset</a></div><div class="ttdeci">void Reset(void)</div><div class="ttdoc">Reset integral. </div></div>
|
|---|
| 157 | <div class="ttc" id="classflair_1_1filter_1_1_pid_html_ab8e08d20453ac21096363f591ac365df"><div class="ttname"><a href="classflair_1_1filter_1_1_pid.html#ab8e08d20453ac21096363f591ac365df">flair::filter::Pid::~Pid</a></div><div class="ttdeci">~Pid()</div><div class="ttdoc">Destructor. </div></div>
|
|---|
| 158 | <div class="ttc" id="classflair_1_1filter_1_1_pid_html_a8128ecc530ff19abae93027d72d4b5ec"><div class="ttname"><a href="classflair_1_1filter_1_1_pid.html#a8128ecc530ff19abae93027d72d4b5ec">flair::filter::Pid::UseDefaultPlot</a></div><div class="ttdeci">void UseDefaultPlot(const gui::LayoutPosition *position)</div><div class="ttdoc">Use default plot. </div></div>
|
|---|
| 159 | <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>
|
|---|
| 160 | <div class="ttc" id="classflair_1_1filter_1_1_pid_html"><div class="ttname"><a href="classflair_1_1filter_1_1_pid.html">flair::filter::Pid</a></div><div class="ttdoc">Class defining a PID. </div><div class="ttdef"><b>Definition:</b> Pid.h:32</div></div>
|
|---|
| 161 | <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>
|
|---|
| 162 | <div class="ttc" id="classflair_1_1filter_1_1_pid_html_a27c025ae6b9a9a192a234ab74e2e6f8b"><div class="ttname"><a href="classflair_1_1filter_1_1_pid.html#a27c025ae6b9a9a192a234ab74e2e6f8b">flair::filter::Pid::SetValues</a></div><div class="ttdeci">void SetValues(float p, float d)</div><div class="ttdoc">Set input values. </div></div>
|
|---|
| 163 | </div><!-- fragment --></div><!-- contents -->
|
|---|
| 164 | </div><!-- doc-content -->
|
|---|
| 165 | <!-- start footer part -->
|
|---|
| 166 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|---|
| 167 | <ul>
|
|---|
| 168 | <li class="navelem"><a class="el" href="dir_33c2ee9b1665499374b4225c427cf176.html">igep</a></li><li class="navelem"><a class="el" href="dir_f1fe274389177bd7e17de7949c4ffada.html">flair-src</a></li><li class="navelem"><a class="el" href="dir_3ef62148cf94871b4b6ee5d6e3a989c1.html">lib</a></li><li class="navelem"><a class="el" href="dir_c640b400eb634d478af9606dd6c9f1e6.html">FlairFilter</a></li><li class="navelem"><a class="el" href="dir_9f4b49da50e680b0f2ceec11232e4cfd.html">src</a></li><li class="navelem"><a class="el" href="_pid_8h.html">Pid.h</a></li>
|
|---|
| 169 | <li class="footer">Generated on Thu Jul 21 2016 13:33:02 for Flair by
|
|---|
| 170 | <a href="http://www.doxygen.org/index.html">
|
|---|
| 171 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
|
|---|
| 172 | </ul>
|
|---|
| 173 | </div>
|
|---|
| 174 | </body>
|
|---|
| 175 | </html>
|
|---|
