Changeset 68 in flair-dev for trunk/doc/Flair/classflair_1_1filter_1_1_pid_thrust.html
- Timestamp:
- Mar 6, 2018, 12:14:17 PM (7 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/Flair/classflair_1_1filter_1_1_pid_thrust.html
r62 r68 144 144 <tr class="separator:a0332ced449a5257a484e484379921445"><td class="memSeparator" colspan="2"> </td></tr> 145 145 <tr class="memitem:a4987d6892e567cce5af9b22dcf065542"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_pid_thrust.html#a4987d6892e567cce5af9b22dcf065542">Reset</a> (void)</td></tr> 146 <tr class="memdesc:a4987d6892e567cce5af9b22dcf065542"><td class="mdescLeft"> </td><td class="mdescRight">Reset integral and offset to 0. <a href="#a4987d6892e567cce5af9b22dcf065542">More...</a><br /></td></tr>146 <tr class="memdesc:a4987d6892e567cce5af9b22dcf065542"><td class="mdescLeft"> </td><td class="mdescRight">Reset the control law equivalent to: <a class="el" href="classflair_1_1filter_1_1_pid_thrust.html#ad82440a1c4d9b0409c8549f900991223" title="Reset integral to 0. ">ResetI()</a>; <a class="el" href="classflair_1_1filter_1_1_pid_thrust.html#a5e856db9c472b9ca3b6b69eb54ffa18e" title="Set offset to specified value in ground station. ">SetDefaultOffset()</a>; SetValues(0,0);. <a href="#a4987d6892e567cce5af9b22dcf065542">More...</a><br /></td></tr> 147 147 <tr class="separator:a4987d6892e567cce5af9b22dcf065542"><td class="memSeparator" colspan="2"> </td></tr> 148 148 <tr class="memitem:ad82440a1c4d9b0409c8549f900991223"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_pid_thrust.html#ad82440a1c4d9b0409c8549f900991223">ResetI</a> (void)</td></tr> 149 149 <tr class="memdesc:ad82440a1c4d9b0409c8549f900991223"><td class="mdescLeft"> </td><td class="mdescRight">Reset integral to 0. <a href="#ad82440a1c4d9b0409c8549f900991223">More...</a><br /></td></tr> 150 150 <tr class="separator:ad82440a1c4d9b0409c8549f900991223"><td class="memSeparator" colspan="2"> </td></tr> 151 <tr class="memitem:a3ec37a57185a1f3164e081e89b08e378"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_pid_thrust.html#a3ec37a57185a1f3164e081e89b08e378">ResetOffset</a> (void)</td></tr> 152 <tr class="memdesc:a3ec37a57185a1f3164e081e89b08e378"><td class="mdescLeft"> </td><td class="mdescRight">Reset offset to 0. <a href="#a3ec37a57185a1f3164e081e89b08e378">More...</a><br /></td></tr> 153 <tr class="separator:a3ec37a57185a1f3164e081e89b08e378"><td class="memSeparator" colspan="2"> </td></tr> 154 <tr class="memitem:a9109d86fb350919a673af114c5d66f0f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_pid_thrust.html#a9109d86fb350919a673af114c5d66f0f">SetOffset</a> (void)</td></tr> 155 <tr class="memdesc:a9109d86fb350919a673af114c5d66f0f"><td class="mdescLeft"> </td><td class="mdescRight">Set offset to specified value in ground station. <a href="#a9109d86fb350919a673af114c5d66f0f">More...</a><br /></td></tr> 156 <tr class="separator:a9109d86fb350919a673af114c5d66f0f"><td class="memSeparator" colspan="2"> </td></tr> 157 <tr class="memitem:a3658197f9d580bc810fc65451399f307"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_pid_thrust.html#a3658197f9d580bc810fc65451399f307">GetOffset</a> (void)</td></tr> 158 <tr class="memdesc:a3658197f9d580bc810fc65451399f307"><td class="mdescLeft"> </td><td class="mdescRight">Get offset. <a href="#a3658197f9d580bc810fc65451399f307">More...</a><br /></td></tr> 159 <tr class="separator:a3658197f9d580bc810fc65451399f307"><td class="memSeparator" colspan="2"> </td></tr> 151 <tr class="memitem:a240df5714f7ffe4fd2cb7765a21389ee"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_pid_thrust.html#a240df5714f7ffe4fd2cb7765a21389ee">SetOffset</a> (float value)</td></tr> 152 <tr class="memdesc:a240df5714f7ffe4fd2cb7765a21389ee"><td class="mdescLeft"> </td><td class="mdescRight">Set offset to a specified value. <a href="#a240df5714f7ffe4fd2cb7765a21389ee">More...</a><br /></td></tr> 153 <tr class="separator:a240df5714f7ffe4fd2cb7765a21389ee"><td class="memSeparator" colspan="2"> </td></tr> 154 <tr class="memitem:a5e856db9c472b9ca3b6b69eb54ffa18e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_pid_thrust.html#a5e856db9c472b9ca3b6b69eb54ffa18e">SetDefaultOffset</a> (void)</td></tr> 155 <tr class="memdesc:a5e856db9c472b9ca3b6b69eb54ffa18e"><td class="mdescLeft"> </td><td class="mdescRight">Set offset to specified value in ground station. <a href="#a5e856db9c472b9ca3b6b69eb54ffa18e">More...</a><br /></td></tr> 156 <tr class="separator:a5e856db9c472b9ca3b6b69eb54ffa18e"><td class="memSeparator" colspan="2"> </td></tr> 157 <tr class="memitem:a746b8f8afd363524b6b84a1fc8d11da2"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_pid_thrust.html#a746b8f8afd363524b6b84a1fc8d11da2">GetOffset</a> (void) const </td></tr> 158 <tr class="memdesc:a746b8f8afd363524b6b84a1fc8d11da2"><td class="mdescLeft"> </td><td class="mdescRight">Get offset. <a href="#a746b8f8afd363524b6b84a1fc8d11da2">More...</a><br /></td></tr> 159 <tr class="separator:a746b8f8afd363524b6b84a1fc8d11da2"><td class="memSeparator" colspan="2"> </td></tr> 160 <tr class="memitem:a35d8c2f7a19faaae43b3a6d2d3cc211a"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_pid_thrust.html#a35d8c2f7a19faaae43b3a6d2d3cc211a">GetIntegral</a> (void) const </td></tr> 161 <tr class="memdesc:a35d8c2f7a19faaae43b3a6d2d3cc211a"><td class="mdescLeft"> </td><td class="mdescRight">Get intergral part. <a href="#a35d8c2f7a19faaae43b3a6d2d3cc211a">More...</a><br /></td></tr> 162 <tr class="separator:a35d8c2f7a19faaae43b3a6d2d3cc211a"><td class="memSeparator" colspan="2"> </td></tr> 160 163 <tr class="memitem:ac556b3702ad3352fdfad1bde19f16af0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_pid_thrust.html#ac556b3702ad3352fdfad1bde19f16af0">OffsetStepUp</a> (void)</td></tr> 161 164 <tr class="memdesc:ac556b3702ad3352fdfad1bde19f16af0"><td class="mdescLeft"> </td><td class="mdescRight">Step up the offset according to specified value in ground station. <a href="#ac556b3702ad3352fdfad1bde19f16af0">More...</a><br /></td></tr> … … 260 263 <tr class="separator:a120fdcc3d50f6f076084cb6943fdf412 inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2"> </td></tr> 261 264 <tr class="inherit_header pro_attribs_classflair_1_1filter_1_1_control_law"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classflair_1_1filter_1_1_control_law')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classflair_1_1filter_1_1_control_law.html">flair::filter::ControlLaw</a></td></tr> 262 <tr class="memitem:a 9877d488ad17a52affd8c68beca426d1 inherit pro_attribs_classflair_1_1filter_1_1_control_law"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classflair_1_1core_1_1cvmatrix.html">core::cvmatrix</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_control_law.html#a9877d488ad17a52affd8c68beca426d1">input</a></td></tr>263 <tr class="memdesc:a 9877d488ad17a52affd8c68beca426d1 inherit pro_attribs_classflair_1_1filter_1_1_control_law"><td class="mdescLeft"> </td><td class="mdescRight">input matrix <a href="#a9877d488ad17a52affd8c68beca426d1">More...</a><br /></td></tr>264 <tr class="separator:a 9877d488ad17a52affd8c68beca426d1inherit pro_attribs_classflair_1_1filter_1_1_control_law"><td class="memSeparator" colspan="2"> </td></tr>265 <tr class="memitem:a ad8a67d158a1eda16ed53615e2511f97 inherit pro_attribs_classflair_1_1filter_1_1_control_law"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classflair_1_1core_1_1cvmatrix.html">core::cvmatrix</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_control_law.html#aad8a67d158a1eda16ed53615e2511f97">output</a></td></tr>266 <tr class="memdesc:a ad8a67d158a1eda16ed53615e2511f97 inherit pro_attribs_classflair_1_1filter_1_1_control_law"><td class="mdescLeft"> </td><td class="mdescRight">output matrix <a href="#aad8a67d158a1eda16ed53615e2511f97">More...</a><br /></td></tr>267 <tr class="separator:a ad8a67d158a1eda16ed53615e2511f97inherit pro_attribs_classflair_1_1filter_1_1_control_law"><td class="memSeparator" colspan="2"> </td></tr>265 <tr class="memitem:ab88bfe866cc8f9794bda115d57139ab8 inherit pro_attribs_classflair_1_1filter_1_1_control_law"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classflair_1_1core_1_1_matrix.html">core::Matrix</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_control_law.html#ab88bfe866cc8f9794bda115d57139ab8">input</a></td></tr> 266 <tr class="memdesc:ab88bfe866cc8f9794bda115d57139ab8 inherit pro_attribs_classflair_1_1filter_1_1_control_law"><td class="mdescLeft"> </td><td class="mdescRight">input matrix <a href="#ab88bfe866cc8f9794bda115d57139ab8">More...</a><br /></td></tr> 267 <tr class="separator:ab88bfe866cc8f9794bda115d57139ab8 inherit pro_attribs_classflair_1_1filter_1_1_control_law"><td class="memSeparator" colspan="2"> </td></tr> 268 <tr class="memitem:ad0ec9102c1f3d5cea5e337ba02754f4b inherit pro_attribs_classflair_1_1filter_1_1_control_law"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classflair_1_1core_1_1_matrix.html">core::Matrix</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_control_law.html#ad0ec9102c1f3d5cea5e337ba02754f4b">output</a></td></tr> 269 <tr class="memdesc:ad0ec9102c1f3d5cea5e337ba02754f4b inherit pro_attribs_classflair_1_1filter_1_1_control_law"><td class="mdescLeft"> </td><td class="mdescRight">output matrix <a href="#ad0ec9102c1f3d5cea5e337ba02754f4b">More...</a><br /></td></tr> 270 <tr class="separator:ad0ec9102c1f3d5cea5e337ba02754f4b inherit pro_attribs_classflair_1_1filter_1_1_control_law"><td class="memSeparator" colspan="2"> </td></tr> 268 271 </table> 269 272 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> … … 347 350 </div><div class="memdoc"> 348 351 349 <p>Reset integral and offset to 0. </p>352 <p>Reset the control law equivalent to: <a class="el" href="classflair_1_1filter_1_1_pid_thrust.html#ad82440a1c4d9b0409c8549f900991223" title="Reset integral to 0. ">ResetI()</a>; <a class="el" href="classflair_1_1filter_1_1_pid_thrust.html#a5e856db9c472b9ca3b6b69eb54ffa18e" title="Set offset to specified value in ground station. ">SetDefaultOffset()</a>; SetValues(0,0);. </p> 350 353 351 354 <p>Reimplemented from <a class="el" href="classflair_1_1filter_1_1_control_law.html#a0892ecd37930c5d92a41449ab6fa1f10">flair::filter::ControlLaw</a>.</p> … … 371 374 </div> 372 375 </div> 373 <a class="anchor" id="a3ec37a57185a1f3164e081e89b08e378"></a> 374 <div class="memitem"> 375 <div class="memproto"> 376 <table class="memname"> 377 <tr> 378 <td class="memname">void flair::filter::PidThrust::ResetOffset </td> 379 <td>(</td> 380 <td class="paramtype">void </td> 381 <td class="paramname"></td><td>)</td> 382 <td></td> 383 </tr> 384 </table> 385 </div><div class="memdoc"> 386 387 <p>Reset offset to 0. </p> 388 389 </div> 390 </div> 391 <a class="anchor" id="a9109d86fb350919a673af114c5d66f0f"></a> 376 <a class="anchor" id="a240df5714f7ffe4fd2cb7765a21389ee"></a> 392 377 <div class="memitem"> 393 378 <div class="memproto"> … … 396 381 <td class="memname">void flair::filter::PidThrust::SetOffset </td> 397 382 <td>(</td> 383 <td class="paramtype">float </td> 384 <td class="paramname"><em>value</em></td><td>)</td> 385 <td></td> 386 </tr> 387 </table> 388 </div><div class="memdoc"> 389 390 <p>Set offset to a specified value. </p> 391 <dl class="params"><dt>Parameters</dt><dd> 392 <table class="params"> 393 <tr><td class="paramname">value</td><td>desired value </td></tr> 394 </table> 395 </dd> 396 </dl> 397 398 </div> 399 </div> 400 <a class="anchor" id="a5e856db9c472b9ca3b6b69eb54ffa18e"></a> 401 <div class="memitem"> 402 <div class="memproto"> 403 <table class="memname"> 404 <tr> 405 <td class="memname">void flair::filter::PidThrust::SetDefaultOffset </td> 406 <td>(</td> 398 407 <td class="paramtype">void </td> 399 408 <td class="paramname"></td><td>)</td> … … 407 416 </div> 408 417 </div> 409 <a class="anchor" id="a 3658197f9d580bc810fc65451399f307"></a>418 <a class="anchor" id="a746b8f8afd363524b6b84a1fc8d11da2"></a> 410 419 <div class="memitem"> 411 420 <div class="memproto"> … … 416 425 <td class="paramtype">void </td> 417 426 <td class="paramname"></td><td>)</td> 418 <td> </td>427 <td> const</td> 419 428 </tr> 420 429 </table> … … 423 432 <p>Get offset. </p> 424 433 <dl class="section return"><dt>Returns</dt><dd>current offset </dd></dl> 434 435 </div> 436 </div> 437 <a class="anchor" id="a35d8c2f7a19faaae43b3a6d2d3cc211a"></a> 438 <div class="memitem"> 439 <div class="memproto"> 440 <table class="memname"> 441 <tr> 442 <td class="memname">float flair::filter::PidThrust::GetIntegral </td> 443 <td>(</td> 444 <td class="paramtype">void </td> 445 <td class="paramname"></td><td>)</td> 446 <td> const</td> 447 </tr> 448 </table> 449 </div><div class="memdoc"> 450 451 <p>Get intergral part. </p> 452 <dl class="section return"><dt>Returns</dt><dd>current integral part </dd></dl> 425 453 426 454 </div> … … 542 570 <ul> 543 571 <li class="navelem"><a class="el" href="namespaceflair.html">flair</a></li><li class="navelem"><a class="el" href="namespaceflair_1_1filter.html">filter</a></li><li class="navelem"><a class="el" href="classflair_1_1filter_1_1_pid_thrust.html">PidThrust</a></li> 544 <li class="footer">Generated on Mon Dec 4 2017 11:13:44for Flair by572 <li class="footer">Generated on Fri Feb 23 2018 11:15:46 for Flair by 545 573 <a href="http://www.doxygen.org/index.html"> 546 574 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
Note:
See TracChangeset
for help on using the changeset viewer.