Changeset 50 in flair-dev for trunk/doc/Flair/classflair_1_1filter_1_1_trajectory_generator1_d.html
- Timestamp:
- 05/31/17 15:54:26 (7 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/Flair/classflair_1_1filter_1_1_trajectory_generator1_d.html
r47 r50 141 141 <tr class="memdesc:a90da7cbae745b5a2a8e52641f4b1d481"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a90da7cbae745b5a2a8e52641f4b1d481">More...</a><br /></td></tr> 142 142 <tr class="separator:a90da7cbae745b5a2a8e52641f4b1d481"><td class="memSeparator" colspan="2"> </td></tr> 143 <tr class="memitem:a b682c3574b7a050bd65475ce00d03a16"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_trajectory_generator1_d.html#ab682c3574b7a050bd65475ce00d03a16">StartTraj</a> (float start_pos, float end_pos)</td></tr>144 <tr class="memdesc:a b682c3574b7a050bd65475ce00d03a16"><td class="mdescLeft"> </td><td class="mdescRight">Start trajectory. <a href="#ab682c3574b7a050bd65475ce00d03a16">More...</a><br /></td></tr>145 <tr class="separator:a b682c3574b7a050bd65475ce00d03a16"><td class="memSeparator" colspan="2"> </td></tr>143 <tr class="memitem:a94f61b22433b9ad621d22a9f12517a26"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_trajectory_generator1_d.html#a94f61b22433b9ad621d22a9f12517a26">StartTraj</a> (float startPosition, float endPosition, float startVelocity=0)</td></tr> 144 <tr class="memdesc:a94f61b22433b9ad621d22a9f12517a26"><td class="mdescLeft"> </td><td class="mdescRight">Start trajectory. <a href="#a94f61b22433b9ad621d22a9f12517a26">More...</a><br /></td></tr> 145 <tr class="separator:a94f61b22433b9ad621d22a9f12517a26"><td class="memSeparator" colspan="2"> </td></tr> 146 146 <tr class="memitem:a28cc21dac02612396c4be5af97c87b2b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_trajectory_generator1_d.html#a28cc21dac02612396c4be5af97c87b2b">StopTraj</a> (void)</td></tr> 147 147 <tr class="memdesc:a28cc21dac02612396c4be5af97c87b2b"><td class="mdescLeft"> </td><td class="mdescRight">Stop trajectory. <a href="#a28cc21dac02612396c4be5af97c87b2b">More...</a><br /></td></tr> … … 187 187 <tr class="memdesc:a12d811c6926fb86da6b47f889109da66 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft"> </td><td class="mdescRight">Send the output to a shared memory. <a href="#a12d811c6926fb86da6b47f889109da66">More...</a><br /></td></tr> 188 188 <tr class="separator:a12d811c6926fb86da6b47f889109da66 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2"> </td></tr> 189 <tr class="memitem:aee7828ae2eece2bace8e476dacc2bc12 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i_o_device.html#aee7828ae2eece2bace8e476dacc2bc12">IsReady</a> (void) const </td></tr> 190 <tr class="memdesc:aee7828ae2eece2bace8e476dacc2bc12 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft"> </td><td class="mdescRight">is device ready <a href="#aee7828ae2eece2bace8e476dacc2bc12">More...</a><br /></td></tr> 191 <tr class="separator:aee7828ae2eece2bace8e476dacc2bc12 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2"> </td></tr> 189 192 <tr class="memitem:a75e82ca2ae2fb7c39d973dd3d16bc698 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75e82ca2ae2fb7c39d973dd3d16bc698"></a> 190 193 virtual <a class="el" href="classflair_1_1core_1_1_data_type.html">DataType</a> const & </td><td class="memItemRight" valign="bottom"><b>GetInputDataType</b> () const </td></tr> … … 241 244 <tr class="memdesc:a3df9057ae23eb34f1b1dae8e7a4a9efc inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft"> </td><td class="mdescRight">Process the childs of type <a class="el" href="classflair_1_1core_1_1_i_o_device.html" title="Abstract class for input/ouput system. ">IODevice</a>, and log if needed. <a href="#a3df9057ae23eb34f1b1dae8e7a4a9efc">More...</a><br /></td></tr> 242 245 <tr class="separator:a3df9057ae23eb34f1b1dae8e7a4a9efc inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2"> </td></tr> 246 <tr class="memitem:a120fdcc3d50f6f076084cb6943fdf412 inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i_o_device.html#a120fdcc3d50f6f076084cb6943fdf412">SetIsReady</a> (bool status)</td></tr> 247 <tr class="memdesc:a120fdcc3d50f6f076084cb6943fdf412 inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft"> </td><td class="mdescRight">set is ready <a href="#a120fdcc3d50f6f076084cb6943fdf412">More...</a><br /></td></tr> 248 <tr class="separator:a120fdcc3d50f6f076084cb6943fdf412 inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2"> </td></tr> 243 249 </table> 244 250 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 245 251 <div class="textblock"><p>Class generating a trajectory in 1D. </p> 246 252 <p>This class generates position and velocity references, given an absolute maximum velocity and an absolute acceleration. <br /> 247 When trajectory is started (see <a class="el" href="classflair_1_1filter_1_1_trajectory_generator1_d.html#a b682c3574b7a050bd65475ce00d03a16" title="Start trajectory. ">StartTraj()</a>), position and velocity will increase at the given acceleration. If the maximum velocity is reached, velocity will not increase anymore. Then, velocity will decrease according to the given acceleration until velocity is null and final position is reached. <br />253 When trajectory is started (see <a class="el" href="classflair_1_1filter_1_1_trajectory_generator1_d.html#a94f61b22433b9ad621d22a9f12517a26" title="Start trajectory. ">StartTraj()</a>), position and velocity will increase at the given acceleration. If the maximum velocity is reached, velocity will not increase anymore. Then, velocity will decrease according to the given acceleration until velocity is null and final position is reached. <br /> 248 254 Manual inputs can be introduced using <a class="el" href="classflair_1_1filter_1_1_trajectory_generator1_d.html#a81d60661d67c3c01a357e14489b3e59e" title="Set position offset. ">SetPositionOffset()</a> and <a class="el" href="classflair_1_1filter_1_1_trajectory_generator1_d.html#a58f86c717fed6e84b22684e881837d2b" title="Set speed offset. ">SetSpeedOffset()</a>. </p> 249 255 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> … … 310 316 </div> 311 317 <h2 class="groupheader">Member Function Documentation</h2> 312 <a class="anchor" id="a b682c3574b7a050bd65475ce00d03a16"></a>318 <a class="anchor" id="a94f61b22433b9ad621d22a9f12517a26"></a> 313 319 <div class="memitem"> 314 320 <div class="memproto"> … … 318 324 <td>(</td> 319 325 <td class="paramtype">float </td> 320 <td class="paramname"><em>start _pos</em>, </td>326 <td class="paramname"><em>startPosition</em>, </td> 321 327 </tr> 322 328 <tr> … … 324 330 <td></td> 325 331 <td class="paramtype">float </td> 326 <td class="paramname"><em>end_pos</em> </td> 332 <td class="paramname"><em>endPosition</em>, </td> 333 </tr> 334 <tr> 335 <td class="paramkey"></td> 336 <td></td> 337 <td class="paramtype">float </td> 338 <td class="paramname"><em>startVelocity</em> = <code>0</code> </td> 327 339 </tr> 328 340 <tr> … … 337 349 <dl class="params"><dt>Parameters</dt><dd> 338 350 <table class="params"> 339 <tr><td class="paramname">start_pos</td><td>start position </td></tr> 340 <tr><td class="paramname">end_pos</td><td>end position </td></tr> 351 <tr><td class="paramname">startPosition</td><td>start position </td></tr> 352 <tr><td class="paramname">endPosition</td><td>end position </td></tr> 353 <tr><td class="paramname">startVelocity</td><td>start velocity, should be actual velocity. This value will be saturated max velocity defined in GCS. </td></tr> 341 354 </table> 342 355 </dd> … … 464 477 465 478 <p>Update using provided datas. </p> 466 <p>Uses values specified by <a class="el" href="classflair_1_1filter_1_1_trajectory_generator1_d.html#a b682c3574b7a050bd65475ce00d03a16" title="Start trajectory. ">StartTraj()</a>, <a class="el" href="classflair_1_1filter_1_1_trajectory_generator1_d.html#a81d60661d67c3c01a357e14489b3e59e" title="Set position offset. ">SetPositionOffset()</a> and <a class="el" href="classflair_1_1filter_1_1_trajectory_generator1_d.html#a58f86c717fed6e84b22684e881837d2b" title="Set speed offset. ">SetSpeedOffset()</a>.</p>479 <p>Uses values specified by <a class="el" href="classflair_1_1filter_1_1_trajectory_generator1_d.html#a94f61b22433b9ad621d22a9f12517a26" title="Start trajectory. ">StartTraj()</a>, <a class="el" href="classflair_1_1filter_1_1_trajectory_generator1_d.html#a81d60661d67c3c01a357e14489b3e59e" title="Set position offset. ">SetPositionOffset()</a> and <a class="el" href="classflair_1_1filter_1_1_trajectory_generator1_d.html#a58f86c717fed6e84b22684e881837d2b" title="Set speed offset. ">SetSpeedOffset()</a>.</p> 467 480 <dl class="params"><dt>Parameters</dt><dd> 468 481 <table class="params"> … … 535 548 <ul> 536 549 <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_trajectory_generator1_d.html">TrajectoryGenerator1D</a></li> 537 <li class="footer">Generated on Tue Jan 17 2017 09:52:31for Flair by550 <li class="footer">Generated on Wed May 31 2017 13:50:37 for Flair by 538 551 <a href="http://www.doxygen.org/index.html"> 539 552 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
Note:
See TracChangeset
for help on using the changeset viewer.