[14] | 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"/> |
---|
[23] | 6 | <meta name="generator" content="Doxygen 1.8.9.1"/> |
---|
[14] | 7 | <title>Flair: ControlLaw.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> |
---|
[23] | 13 | <script type="text/javascript" src="navtreedata.js"></script> |
---|
[14] | 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"/> |
---|
[23] | 20 | <script type="text/javascript" src="search/searchdata.js"></script> |
---|
[14] | 21 | <script type="text/javascript" src="search/search.js"></script> |
---|
| 22 | <script type="text/javascript"> |
---|
[23] | 23 | $(document).ready(function() { init_search(); }); |
---|
[14] | 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 --> |
---|
[23] | 44 | <!-- Generated by Doxygen 1.8.9.1 --> |
---|
[14] | 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('_control_law_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)"> |
---|
[23] | 97 | </div> |
---|
[14] | 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">ControlLaw.h</div> </div> |
---|
| 109 | </div><!--header--> |
---|
| 110 | <div class="contents"> |
---|
| 111 | <a href="_control_law_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 CONTROLLAW_H</span></div> |
---|
| 116 | <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define CONTROLLAW_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="_i_o_device_8h.html">IODevice.h</a>></span></div> |
---|
| 119 | <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div> |
---|
[23] | 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> |
---|
[14] | 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> <span class="keyword">namespace </span>core {</div> |
---|
| 125 | <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">class </span>cvmatrix;</div> |
---|
| 126 | <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> }</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> </div> |
---|
[23] | 129 | <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span><a class="code" href="namespaceflair.html">flair</a> {</div> |
---|
[14] | 130 | <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span>filter {</div> |
---|
| 131 | <div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classflair_1_1filter_1_1_control_law.html"> 36</a></span> <span class="keyword">class </span><a class="code" href="classflair_1_1filter_1_1_control_law.html">ControlLaw</a> : <span class="keyword">public</span> <a class="code" href="classflair_1_1core_1_1_i_o_device.html">core::IODevice</a> {</div> |
---|
| 132 | <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">public</span>:</div> |
---|
| 133 | <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="classflair_1_1filter_1_1_control_law.html#abd6d4ee32a9e01a2d1b0513a0aadafcb">ControlLaw</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1_object.html">core::Object</a> *parent, std::string name, uint32_t nb_out = 1);</div> |
---|
| 134 | <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div> |
---|
| 135 | <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classflair_1_1filter_1_1_control_law.html#a62210ace4d3338cbc528ed712e72ac27">~ControlLaw</a>();</div> |
---|
| 136 | <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> |
---|
| 137 | <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">float</span> <a class="code" href="classflair_1_1filter_1_1_control_law.html#ace241d108bd0213135dbd6a5a561d0cf">Output</a>(uint32_t index = 0) <span class="keyword">const</span>;</div> |
---|
| 138 | <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div> |
---|
| 139 | <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classflair_1_1filter_1_1_control_law.html#a3c42c9c7ae276e10d2ebad3a6701210d">UseDefaultPlot</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *position);</div> |
---|
| 140 | <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div> |
---|
| 141 | <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1filter_1_1_control_law.html#a228f8bf6857d96fa015bec9e016d2132">Update</a>(<a class="code" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">core::Time</a> time);</div> |
---|
| 142 | <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div> |
---|
| 143 | <div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="classflair_1_1filter_1_1_control_law.html#a0892ecd37930c5d92a41449ab6fa1f10"> 93</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classflair_1_1filter_1_1_control_law.html#a0892ecd37930c5d92a41449ab6fa1f10">Reset</a>(){};</div> |
---|
| 144 | <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div> |
---|
| 145 | <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="keyword">protected</span>:</div> |
---|
| 146 | <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <a class="code" href="classflair_1_1core_1_1cvmatrix.html">core::cvmatrix</a> *<a class="code" href="classflair_1_1filter_1_1_control_law.html#a9877d488ad17a52affd8c68beca426d1">input</a>;</div> |
---|
| 147 | <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div> |
---|
| 148 | <div class="line"><a name="l00111"></a><span class="lineno"><a class="line" href="classflair_1_1filter_1_1_control_law.html#aad8a67d158a1eda16ed53615e2511f97"> 111</a></span>  <a class="code" href="classflair_1_1core_1_1cvmatrix.html">core::cvmatrix</a> *<a class="code" href="classflair_1_1filter_1_1_control_law.html#aad8a67d158a1eda16ed53615e2511f97">output</a>;</div> |
---|
| 149 | <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div> |
---|
| 150 | <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="keyword">private</span>:</div> |
---|
| 151 | <div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">virtual</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) = 0;</div> |
---|
| 152 | <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> };</div> |
---|
| 153 | <div class="line"><a name="l00123"></a><span class="lineno"> 123</span> } <span class="comment">// end namespace filter</span></div> |
---|
| 154 | <div class="line"><a name="l00124"></a><span class="lineno"> 124</span> } <span class="comment">// end namespace flair</span></div> |
---|
| 155 | <div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="preprocessor">#endif // CONTROLLAW_H</span></div> |
---|
[32] | 156 | <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:94</div></div> |
---|
[14] | 157 | <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> |
---|
| 158 | <div class="ttc" id="classflair_1_1filter_1_1_control_law_html_a228f8bf6857d96fa015bec9e016d2132"><div class="ttname"><a href="classflair_1_1filter_1_1_control_law.html#a228f8bf6857d96fa015bec9e016d2132">flair::filter::ControlLaw::Update</a></div><div class="ttdeci">void Update(core::Time time)</div><div class="ttdoc">Update using provided datas. </div></div> |
---|
| 159 | <div class="ttc" id="classflair_1_1core_1_1_object_html"><div class="ttname"><a href="classflair_1_1core_1_1_object.html">flair::core::Object</a></div><div class="ttdoc">Base class for all Framework's classes. </div><div class="ttdef"><b>Definition:</b> Object.h:77</div></div> |
---|
| 160 | <div class="ttc" id="classflair_1_1core_1_1_i_o_device_html"><div class="ttname"><a href="classflair_1_1core_1_1_i_o_device.html">flair::core::IODevice</a></div><div class="ttdoc">Abstract class for input/ouput system. </div><div class="ttdef"><b>Definition:</b> IODevice.h:44</div></div> |
---|
[23] | 161 | <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> |
---|
[14] | 162 | <div class="ttc" id="classflair_1_1core_1_1cvmatrix_html"><div class="ttname"><a href="classflair_1_1core_1_1cvmatrix.html">flair::core::cvmatrix</a></div><div class="ttdoc">Class defining a matrix of kind CvMat. </div><div class="ttdef"><b>Definition:</b> cvmatrix.h:33</div></div> |
---|
| 163 | <div class="ttc" id="classflair_1_1filter_1_1_control_law_html_a62210ace4d3338cbc528ed712e72ac27"><div class="ttname"><a href="classflair_1_1filter_1_1_control_law.html#a62210ace4d3338cbc528ed712e72ac27">flair::filter::ControlLaw::~ControlLaw</a></div><div class="ttdeci">~ControlLaw()</div><div class="ttdoc">Destructor. </div></div> |
---|
| 164 | <div class="ttc" id="namespaceflair_1_1core_html_acc0fa041e08ecf73b2d1d723c339a736"><div class="ttname"><a href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">flair::core::Time</a></div><div class="ttdeci">unsigned long long Time</div><div class="ttdoc">Time definition, in ns. </div><div class="ttdef"><b>Definition:</b> Object.h:49</div></div> |
---|
| 165 | <div class="ttc" id="classflair_1_1filter_1_1_control_law_html_a9877d488ad17a52affd8c68beca426d1"><div class="ttname"><a href="classflair_1_1filter_1_1_control_law.html#a9877d488ad17a52affd8c68beca426d1">flair::filter::ControlLaw::input</a></div><div class="ttdeci">core::cvmatrix * input</div><div class="ttdoc">input matrix </div><div class="ttdef"><b>Definition:</b> ControlLaw.h:93</div></div> |
---|
| 166 | <div class="ttc" id="classflair_1_1filter_1_1_control_law_html_aad8a67d158a1eda16ed53615e2511f97"><div class="ttname"><a href="classflair_1_1filter_1_1_control_law.html#aad8a67d158a1eda16ed53615e2511f97">flair::filter::ControlLaw::output</a></div><div class="ttdeci">core::cvmatrix * output</div><div class="ttdoc">output matrix </div><div class="ttdef"><b>Definition:</b> ControlLaw.h:111</div></div> |
---|
| 167 | <div class="ttc" id="_i_o_device_8h_html"><div class="ttname"><a href="_i_o_device_8h.html">IODevice.h</a></div><div class="ttdoc">Abstract class for input/ouput system. </div></div> |
---|
| 168 | <div class="ttc" id="classflair_1_1filter_1_1_control_law_html_abd6d4ee32a9e01a2d1b0513a0aadafcb"><div class="ttname"><a href="classflair_1_1filter_1_1_control_law.html#abd6d4ee32a9e01a2d1b0513a0aadafcb">flair::filter::ControlLaw::ControlLaw</a></div><div class="ttdeci">ControlLaw(const core::Object *parent, std::string name, uint32_t nb_out=1)</div><div class="ttdoc">Constructor. </div></div> |
---|
| 169 | <div class="ttc" id="classflair_1_1filter_1_1_control_law_html_ace241d108bd0213135dbd6a5a561d0cf"><div class="ttname"><a href="classflair_1_1filter_1_1_control_law.html#ace241d108bd0213135dbd6a5a561d0cf">flair::filter::ControlLaw::Output</a></div><div class="ttdeci">float Output(uint32_t index=0) const </div><div class="ttdoc">Output value. </div></div> |
---|
| 170 | <div class="ttc" id="classflair_1_1filter_1_1_control_law_html_a3c42c9c7ae276e10d2ebad3a6701210d"><div class="ttname"><a href="classflair_1_1filter_1_1_control_law.html#a3c42c9c7ae276e10d2ebad3a6701210d">flair::filter::ControlLaw::UseDefaultPlot</a></div><div class="ttdeci">virtual void UseDefaultPlot(const gui::LayoutPosition *position)</div><div class="ttdoc">Use default plot. </div></div> |
---|
| 171 | <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> |
---|
| 172 | <div class="ttc" id="classflair_1_1filter_1_1_control_law_html_a0892ecd37930c5d92a41449ab6fa1f10"><div class="ttname"><a href="classflair_1_1filter_1_1_control_law.html#a0892ecd37930c5d92a41449ab6fa1f10">flair::filter::ControlLaw::Reset</a></div><div class="ttdeci">virtual void Reset()</div><div class="ttdoc">Reset the internal state of the control law. </div><div class="ttdef"><b>Definition:</b> ControlLaw.h:93</div></div> |
---|
| 173 | </div><!-- fragment --></div><!-- contents --> |
---|
| 174 | </div><!-- doc-content --> |
---|
| 175 | <!-- start footer part --> |
---|
| 176 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
---|
| 177 | <ul> |
---|
[26] | 178 | <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="_control_law_8h.html">ControlLaw.h</a></li> |
---|
[32] | 179 | <li class="footer">Generated on Wed Jul 27 2016 06:38:45 for Flair by |
---|
[14] | 180 | <a href="http://www.doxygen.org/index.html"> |
---|
[23] | 181 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li> |
---|
[14] | 182 | </ul> |
---|
| 183 | </div> |
---|
| 184 | </body> |
---|
| 185 | </html> |
---|