structarm__pid__instance__q31.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264
  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>CMSIS-DSP: arm_pid_instance_q31 Struct Reference</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <link href="cmsis.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="navtree.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(initResizable);
  16. </script>
  17. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18. <script type="text/javascript" src="search/search.js"></script>
  19. <script type="text/javascript">
  20. $(document).ready(function() { searchBox.OnSelectItem(0); });
  21. </script>
  22. <link href="stylsheetf" rel="stylesheet" type="text/css" />
  23. </head>
  24. <body>
  25. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  26. <div id="titlearea">
  27. <table cellspacing="0" cellpadding="0">
  28. <tbody>
  29. <tr style="height: 46px;">
  30. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  31. <td style="padding-left: 0.5em;">
  32. <div id="projectname">CMSIS-DSP
  33. &#160;<span id="projectnumber">Version 1.4.4</span>
  34. </div>
  35. <div id="projectbrief">CMSIS DSP Software Library</div>
  36. </td>
  37. </tr>
  38. </tbody>
  39. </table>
  40. </div>
  41. <!-- end header part -->
  42. <div id="CMSISnav" class="tabs1">
  43. <ul class="tablist">
  44. <li><a href="../../General/html/index.html"><span>CMSIS</span></a></li>
  45. <li><a href="../../Core/html/index.html"><span>CORE</span></a></li>
  46. <li><a href="../../Driver/html/index.html"><span>Driver</span></a></li>
  47. <li class="current"><a href="../../DSP/html/index.html"><span>DSP</span></a></li>
  48. <li><a href="../../RTOS/html/index.html"><span>RTOS API</span></a></li>
  49. <li><a href="../../Pack/html/index.html"><span>Pack</span></a></li>
  50. <li><a href="../../SVD/html/index.html"><span>SVD</span></a></li>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.2 -->
  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__q31.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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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_q31 Struct Reference</div> </div>
  118. </div><!--header-->
  119. <div class="contents">
  120. <p>Instance structure for the Q31 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:aa5332635ce9c7078cdb4c1ecf442eadd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q31.html#aa5332635ce9c7078cdb4c1ecf442eadd">A0</a></td></tr>
  126. <tr class="separator:aa5332635ce9c7078cdb4c1ecf442eadd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a2f7492bd6fb92fae5e2de7fbbec39b0e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q31.html#a2f7492bd6fb92fae5e2de7fbbec39b0e">A1</a></td></tr>
  128. <tr class="separator:a2f7492bd6fb92fae5e2de7fbbec39b0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a3e34537c53af4f9ad7bfffa4dff27c82"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q31.html#a3e34537c53af4f9ad7bfffa4dff27c82">A2</a></td></tr>
  130. <tr class="separator:a3e34537c53af4f9ad7bfffa4dff27c82"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a228e4a64da6014844a0a671a1fa391d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q31.html#a228e4a64da6014844a0a671a1fa391d4">state</a> [3]</td></tr>
  132. <tr class="separator:a228e4a64da6014844a0a671a1fa391d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:ac2410bf7f856d58dc1d773d4983cac8e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q31.html#ac2410bf7f856d58dc1d773d4983cac8e">Kp</a></td></tr>
  134. <tr class="separator:ac2410bf7f856d58dc1d773d4983cac8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:aa861d69fd398f29aa0b4b455a823ed72"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q31.html#aa861d69fd398f29aa0b4b455a823ed72">Ki</a></td></tr>
  136. <tr class="separator:aa861d69fd398f29aa0b4b455a823ed72"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:aab4ff371d14441df501f1169f71cbd17"><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structarm__pid__instance__q31.html#aab4ff371d14441df501f1169f71cbd17">Kd</a></td></tr>
  138. <tr class="separator:aab4ff371d14441df501f1169f71cbd17"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. </table>
  140. <h2 class="groupheader">Field Documentation</h2>
  141. <a class="anchor" id="aa5332635ce9c7078cdb4c1ecf442eadd"></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#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> arm_pid_instance_q31::A0</td>
  147. </tr>
  148. </table>
  149. </div><div class="memdoc">
  150. <p>The derived gain, A0 = Kp + Ki + Kd . </p>
  151. <p>Referenced by <a class="el" href="group___p_i_d.html#gad9d88485234fa9460b1ce9e64989ac86">arm_pid_init_q31()</a>, and <a class="el" href="group___p_i_d.html#ga5f6f941e7ae981728dd3a662f8f4ecd7">arm_pid_q31()</a>.</p>
  152. </div>
  153. </div>
  154. <a class="anchor" id="a2f7492bd6fb92fae5e2de7fbbec39b0e"></a>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> arm_pid_instance_q31::A1</td>
  160. </tr>
  161. </table>
  162. </div><div class="memdoc">
  163. <p>The derived gain, A1 = -Kp - 2Kd. </p>
  164. <p>Referenced by <a class="el" href="group___p_i_d.html#gad9d88485234fa9460b1ce9e64989ac86">arm_pid_init_q31()</a>, and <a class="el" href="group___p_i_d.html#ga5f6f941e7ae981728dd3a662f8f4ecd7">arm_pid_q31()</a>.</p>
  165. </div>
  166. </div>
  167. <a class="anchor" id="a3e34537c53af4f9ad7bfffa4dff27c82"></a>
  168. <div class="memitem">
  169. <div class="memproto">
  170. <table class="memname">
  171. <tr>
  172. <td class="memname"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> arm_pid_instance_q31::A2</td>
  173. </tr>
  174. </table>
  175. </div><div class="memdoc">
  176. <p>The derived gain, A2 = Kd . </p>
  177. <p>Referenced by <a class="el" href="group___p_i_d.html#gad9d88485234fa9460b1ce9e64989ac86">arm_pid_init_q31()</a>, and <a class="el" href="group___p_i_d.html#ga5f6f941e7ae981728dd3a662f8f4ecd7">arm_pid_q31()</a>.</p>
  178. </div>
  179. </div>
  180. <a class="anchor" id="aab4ff371d14441df501f1169f71cbd17"></a>
  181. <div class="memitem">
  182. <div class="memproto">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> arm_pid_instance_q31::Kd</td>
  186. </tr>
  187. </table>
  188. </div><div class="memdoc">
  189. <p>The derivative gain. </p>
  190. <p>Referenced by <a class="el" href="group___p_i_d.html#gad9d88485234fa9460b1ce9e64989ac86">arm_pid_init_q31()</a>.</p>
  191. </div>
  192. </div>
  193. <a class="anchor" id="aa861d69fd398f29aa0b4b455a823ed72"></a>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> arm_pid_instance_q31::Ki</td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. <p>The integral gain. </p>
  203. <p>Referenced by <a class="el" href="group___p_i_d.html#gad9d88485234fa9460b1ce9e64989ac86">arm_pid_init_q31()</a>.</p>
  204. </div>
  205. </div>
  206. <a class="anchor" id="ac2410bf7f856d58dc1d773d4983cac8e"></a>
  207. <div class="memitem">
  208. <div class="memproto">
  209. <table class="memname">
  210. <tr>
  211. <td class="memname"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> arm_pid_instance_q31::Kp</td>
  212. </tr>
  213. </table>
  214. </div><div class="memdoc">
  215. <p>The proportional gain. </p>
  216. <p>Referenced by <a class="el" href="group___p_i_d.html#gad9d88485234fa9460b1ce9e64989ac86">arm_pid_init_q31()</a>.</p>
  217. </div>
  218. </div>
  219. <a class="anchor" id="a228e4a64da6014844a0a671a1fa391d4"></a>
  220. <div class="memitem">
  221. <div class="memproto">
  222. <table class="memname">
  223. <tr>
  224. <td class="memname"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> arm_pid_instance_q31::state[3]</td>
  225. </tr>
  226. </table>
  227. </div><div class="memdoc">
  228. <p>The state array of length 3. </p>
  229. <p>Referenced by <a class="el" href="group___p_i_d.html#gad9d88485234fa9460b1ce9e64989ac86">arm_pid_init_q31()</a>, <a class="el" href="group___p_i_d.html#ga5f6f941e7ae981728dd3a662f8f4ecd7">arm_pid_q31()</a>, and <a class="el" href="group___p_i_d.html#gaeecbacd3fb37c608ec25474d3a0dffa9">arm_pid_reset_q31()</a>.</p>
  230. </div>
  231. </div>
  232. </div><!-- contents -->
  233. </div><!-- doc-content -->
  234. <!-- start footer part -->
  235. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  236. <ul>
  237. <li class="navelem"><a class="el" href="structarm__pid__instance__q31.html">arm_pid_instance_q31</a></li>
  238. <li class="footer">Generated on Tue Sep 23 2014 18:52:44 for CMSIS-DSP by ARM Ltd. All rights reserved.
  239. <!--
  240. <a href="http://www.doxygen.org/index.html">
  241. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.2
  242. -->
  243. </li>
  244. </ul>
  245. </div>
  246. </body>
  247. </html>