structarm__pid__instance__q15.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248
  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. <title>arm_pid_instance_q15 Struct Reference</title>
  7. <title>CMSIS-DSP: arm_pid_instance_q15 Struct Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <link href="cmsis.css" rel="stylesheet" type="text/css" />
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="printComponentTabs.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="resize.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. $(window).load(resizeHeight);
  19. </script>
  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <script type="text/javascript">
  23. $(document).ready(function() { searchBox.OnSelectItem(0); });
  24. </script>
  25. </head>
  26. <body>
  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28. <div id="titlearea">
  29. <table cellspacing="0" cellpadding="0">
  30. <tbody>
  31. <tr style="height: 46px;">
  32. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33. <td style="padding-left: 0.5em;">
  34. <div id="projectname">CMSIS-DSP
  35. &#160;<span id="projectnumber">Version 1.8.0</span>
  36. </div>
  37. <div id="projectbrief">CMSIS DSP Software Library</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li><a href="modules.html"><span>Reference</span></a></li>
  62. <li>
  63. <div id="MSearchBox" class="MSearchBoxInactive">
  64. <span class="left">
  65. <img id="MSearchSelect" src="search/mag_sel.png"
  66. onmouseover="return searchBox.OnSearchSelectShow()"
  67. onmouseout="return searchBox.OnSearchSelectHide()"
  68. alt=""/>
  69. <input type="text" id="MSearchField" value="Search" accesskey="S"
  70. onfocus="searchBox.OnSearchFieldFocus(true)"
  71. onblur="searchBox.OnSearchFieldFocus(false)"
  72. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73. </span><span class="right">
  74. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75. </span>
  76. </div>
  77. </li>
  78. </ul>
  79. </div>
  80. <div id="navrow2" class="tabs2">
  81. <ul class="tablist">
  82. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  83. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  84. </ul>
  85. </div>
  86. </div><!-- top -->
  87. <div id="side-nav" class="ui-resizable side-nav-resizable">
  88. <div id="nav-tree">
  89. <div id="nav-tree-contents">
  90. <div id="nav-sync" class="sync"></div>
  91. </div>
  92. </div>
  93. <div id="splitbar" style="-moz-user-select:none;"
  94. class="ui-resizable-handle">
  95. </div>
  96. </div>
  97. <script type="text/javascript">
  98. $(document).ready(function(){initNavTree('structarm__pid__instance__q15.html','');});
  99. </script>
  100. <div id="doc-content">
  101. <!-- window showing the filter options -->
  102. <div id="MSearchSelectWindow"
  103. onmouseover="return searchBox.OnSearchSelectShow()"
  104. onmouseout="return searchBox.OnSearchSelectHide()"
  105. onkeydown="return searchBox.OnSearchSelectKey(event)">
  106. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  107. <!-- iframe showing the search results (closed by default) -->
  108. <div id="MSearchResultsWindow">
  109. <iframe src="javascript:void(0)" frameborder="0"
  110. name="MSearchResults" id="MSearchResults">
  111. </iframe>
  112. </div>
  113. <div class="header">
  114. <div class="summary">
  115. <a href="#pub-attribs">Data Fields</a> </div>
  116. <div class="headertitle">
  117. <div class="title">arm_pid_instance_q15 Struct Reference</div> </div>
  118. </div><!--header-->
  119. <div class="contents">
  120. <p>Instance structure for the Q15 PID Control.
  121. </p>
  122. <table class="memberdecls">
  123. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  124. Data Fields</h2></td></tr>
  125. <tr class="memitem:ad77f3a2823c7f96de42c92a3fbf3246b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q15.html#ad77f3a2823c7f96de42c92a3fbf3246b">A0</a></td></tr>
  126. <tr class="separator:ad77f3a2823c7f96de42c92a3fbf3246b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:ad8ac5ff736c0e51180398c31f777f18a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q15.html#ad8ac5ff736c0e51180398c31f777f18a">A1</a></td></tr>
  128. <tr class="separator:ad8ac5ff736c0e51180398c31f777f18a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a33e8b4c2d3e24b8b494f6edca6a89c1b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q15.html#a33e8b4c2d3e24b8b494f6edca6a89c1b">A2</a></td></tr>
  130. <tr class="separator:a33e8b4c2d3e24b8b494f6edca6a89c1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a4a3f0a878b5b6b055e3478a2f244cd30"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q15.html#a4a3f0a878b5b6b055e3478a2f244cd30">state</a> [3]</td></tr>
  132. <tr class="separator:a4a3f0a878b5b6b055e3478a2f244cd30"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:ad228aae24a1b6d855c93a8b9bbc1c4f1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q15.html#ad228aae24a1b6d855c93a8b9bbc1c4f1">Kp</a></td></tr>
  134. <tr class="separator:ad228aae24a1b6d855c93a8b9bbc1c4f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a0dcc19d5c8f7bc401acea9e8318cd777"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q15.html#a0dcc19d5c8f7bc401acea9e8318cd777">Ki</a></td></tr>
  136. <tr class="separator:a0dcc19d5c8f7bc401acea9e8318cd777"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:af5d4b53091f19eff7536636b7cc43111"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q15.html#af5d4b53091f19eff7536636b7cc43111">Kd</a></td></tr>
  138. <tr class="separator:af5d4b53091f19eff7536636b7cc43111"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. </table>
  140. <h2 class="groupheader">Field Documentation</h2>
  141. <a class="anchor" id="ad77f3a2823c7f96de42c92a3fbf3246b"></a>
  142. <div class="memitem">
  143. <div class="memproto">
  144. <table class="memname">
  145. <tr>
  146. <td class="memname"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> arm_pid_instance_q15::A0</td>
  147. </tr>
  148. </table>
  149. </div><div class="memdoc">
  150. <p>The derived gain, A0 = Kp + Ki + Kd . </p>
  151. </div>
  152. </div>
  153. <a class="anchor" id="ad8ac5ff736c0e51180398c31f777f18a"></a>
  154. <div class="memitem">
  155. <div class="memproto">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> arm_pid_instance_q15::A1</td>
  159. </tr>
  160. </table>
  161. </div><div class="memdoc">
  162. </div>
  163. </div>
  164. <a class="anchor" id="a33e8b4c2d3e24b8b494f6edca6a89c1b"></a>
  165. <div class="memitem">
  166. <div class="memproto">
  167. <table class="memname">
  168. <tr>
  169. <td class="memname"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> arm_pid_instance_q15::A2</td>
  170. </tr>
  171. </table>
  172. </div><div class="memdoc">
  173. </div>
  174. </div>
  175. <a class="anchor" id="af5d4b53091f19eff7536636b7cc43111"></a>
  176. <div class="memitem">
  177. <div class="memproto">
  178. <table class="memname">
  179. <tr>
  180. <td class="memname"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> arm_pid_instance_q15::Kd</td>
  181. </tr>
  182. </table>
  183. </div><div class="memdoc">
  184. <p>The derivative gain. </p>
  185. </div>
  186. </div>
  187. <a class="anchor" id="a0dcc19d5c8f7bc401acea9e8318cd777"></a>
  188. <div class="memitem">
  189. <div class="memproto">
  190. <table class="memname">
  191. <tr>
  192. <td class="memname"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> arm_pid_instance_q15::Ki</td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. <p>The integral gain. </p>
  197. </div>
  198. </div>
  199. <a class="anchor" id="ad228aae24a1b6d855c93a8b9bbc1c4f1"></a>
  200. <div class="memitem">
  201. <div class="memproto">
  202. <table class="memname">
  203. <tr>
  204. <td class="memname"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> arm_pid_instance_q15::Kp</td>
  205. </tr>
  206. </table>
  207. </div><div class="memdoc">
  208. <p>The proportional gain. </p>
  209. </div>
  210. </div>
  211. <a class="anchor" id="a4a3f0a878b5b6b055e3478a2f244cd30"></a>
  212. <div class="memitem">
  213. <div class="memproto">
  214. <table class="memname">
  215. <tr>
  216. <td class="memname"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> arm_pid_instance_q15::state[3]</td>
  217. </tr>
  218. </table>
  219. </div><div class="memdoc">
  220. <p>The state array of length 3. </p>
  221. </div>
  222. </div>
  223. </div><!-- contents -->
  224. </div><!-- doc-content -->
  225. <!-- start footer part -->
  226. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  227. <ul>
  228. <li class="navelem"><a class="el" href="structarm__pid__instance__q15.html">arm_pid_instance_q15</a></li>
  229. <li class="footer">Generated on Thu Apr 9 2020 15:49:24 for CMSIS-DSP Version 1.8.0 by Arm Ltd. All rights reserved.
  230. <!--
  231. <a href="http://www.doxygen.org/index.html">
  232. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  233. -->
  234. </li>
  235. </ul>
  236. </div>
  237. </body>
  238. </html>