Ignore:
Timestamp:
May 31, 2017, 3:54:26 PM (4 years ago)
Author:
Sanahuja Guillaume
Message:

doc

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/Flair/classflair_1_1sensor_1_1_imu.html

    r47 r50  
    138138<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
    139139Public Member Functions</h2></td></tr>
    140 <tr class="memitem:a2ee0420d6e69be3a51c9ad1ac1c6b386"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_imu.html#a2ee0420d6e69be3a51c9ad1ac1c6b386">Imu</a> (const <a class="el" href="classflair_1_1core_1_1_framework_manager.html">core::FrameworkManager</a> *parent, std::string name)</td></tr>
    141 <tr class="memdesc:a2ee0420d6e69be3a51c9ad1ac1c6b386"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a2ee0420d6e69be3a51c9ad1ac1c6b386">More...</a><br /></td></tr>
    142 <tr class="separator:a2ee0420d6e69be3a51c9ad1ac1c6b386"><td class="memSeparator" colspan="2">&#160;</td></tr>
     140<tr class="memitem:ab8c2e7ec4d6d6d4efd175d2ce0811159"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_imu.html#ab8c2e7ec4d6d6d4efd175d2ce0811159">Imu</a> (std::string name)</td></tr>
     141<tr class="memdesc:ab8c2e7ec4d6d6d4efd175d2ce0811159"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ab8c2e7ec4d6d6d4efd175d2ce0811159">More...</a><br /></td></tr>
     142<tr class="separator:ab8c2e7ec4d6d6d4efd175d2ce0811159"><td class="memSeparator" colspan="2">&#160;</td></tr>
    143143<tr class="memitem:a5dc17ecf8caf9aaa41ec0a6ec43adf6a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_imu.html#a5dc17ecf8caf9aaa41ec0a6ec43adf6a">Imu</a> (const <a class="el" href="classflair_1_1core_1_1_i_o_device.html">core::IODevice</a> *parent, std::string name)</td></tr>
    144144<tr class="memdesc:a5dc17ecf8caf9aaa41ec0a6ec43adf6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a5dc17ecf8caf9aaa41ec0a6ec43adf6a">More...</a><br /></td></tr>
     
    147147<tr class="memdesc:ab01ce2e6b89698b001da63ae8df1722a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#ab01ce2e6b89698b001da63ae8df1722a">More...</a><br /></td></tr>
    148148<tr class="separator:ab01ce2e6b89698b001da63ae8df1722a"><td class="memSeparator" colspan="2">&#160;</td></tr>
     149<tr class="memitem:adb1105fe7b1c21234b6edde4d64da428"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classflair_1_1core_1_1_imu_data.html">core::ImuData</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_imu.html#adb1105fe7b1c21234b6edde4d64da428">GetDatas</a> (void) const </td></tr>
     150<tr class="memdesc:adb1105fe7b1c21234b6edde4d64da428"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get IMU datas.  <a href="#adb1105fe7b1c21234b6edde4d64da428">More...</a><br /></td></tr>
     151<tr class="separator:adb1105fe7b1c21234b6edde4d64da428"><td class="memSeparator" colspan="2">&#160;</td></tr>
    149152<tr class="memitem:a1d74dd0b750c287b112489786ff5b7eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classflair_1_1gui_1_1_layout.html">gui::Layout</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_imu.html#a1d74dd0b750c287b112489786ff5b7eb">GetLayout</a> (void) const </td></tr>
    150153<tr class="memdesc:a1d74dd0b750c287b112489786ff5b7eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setup Layout.  <a href="#a1d74dd0b750c287b112489786ff5b7eb">More...</a><br /></td></tr>
     
    181184<tr class="memdesc:a12d811c6926fb86da6b47f889109da66 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send the output to a shared memory.  <a href="#a12d811c6926fb86da6b47f889109da66">More...</a><br /></td></tr>
    182185<tr class="separator:a12d811c6926fb86da6b47f889109da66 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
     186<tr class="memitem:aee7828ae2eece2bace8e476dacc2bc12 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top">bool&#160;</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>
     187<tr class="memdesc:aee7828ae2eece2bace8e476dacc2bc12 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft">&#160;</td><td class="mdescRight">is device ready  <a href="#aee7828ae2eece2bace8e476dacc2bc12">More...</a><br /></td></tr>
     188<tr class="separator:aee7828ae2eece2bace8e476dacc2bc12 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
    183189<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>
    184190virtual <a class="el" href="classflair_1_1core_1_1_data_type.html">DataType</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>GetInputDataType</b> () const </td></tr>
     
    227233<tr class="memdesc:aa67100f97133a4d1eb4f3a225970eb85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Setup GroupBox.  <a href="#aa67100f97133a4d1eb4f3a225970eb85">More...</a><br /></td></tr>
    228234<tr class="separator:aa67100f97133a4d1eb4f3a225970eb85"><td class="memSeparator" colspan="2">&#160;</td></tr>
    229 <tr class="memitem:a32a260c66ae679869d7628c561c35346"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_imu.html#a32a260c66ae679869d7628c561c35346">UpdateImu</a> ()</td></tr>
    230 <tr class="memdesc:a32a260c66ae679869d7628c561c35346"><td class="mdescLeft">&#160;</td><td class="mdescRight">UpdateImu.  <a href="#a32a260c66ae679869d7628c561c35346">More...</a><br /></td></tr>
    231 <tr class="separator:a32a260c66ae679869d7628c561c35346"><td class="memSeparator" colspan="2">&#160;</td></tr>
     235<tr class="memitem:ad19d0939034366aafe24aceaf41a936f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_imu.html#ad19d0939034366aafe24aceaf41a936f">ApplyRotation</a> (<a class="el" href="classflair_1_1core_1_1_vector3_d.html">core::Vector3Df</a> &amp;vector)</td></tr>
     236<tr class="memdesc:ad19d0939034366aafe24aceaf41a936f"><td class="mdescLeft">&#160;</td><td class="mdescRight">ApplyRotation.  <a href="#ad19d0939034366aafe24aceaf41a936f">More...</a><br /></td></tr>
     237<tr class="separator:ad19d0939034366aafe24aceaf41a936f"><td class="memSeparator" colspan="2">&#160;</td></tr>
     238<tr class="memitem:aaf735d7535414d32e023d5eef8d525fc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_imu.html#aaf735d7535414d32e023d5eef8d525fc">ApplyRotation</a> (<a class="el" href="classflair_1_1core_1_1_quaternion.html">core::Quaternion</a> &amp;quaternion)</td></tr>
     239<tr class="memdesc:aaf735d7535414d32e023d5eef8d525fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">ApplyRotation.  <a href="#aaf735d7535414d32e023d5eef8d525fc">More...</a><br /></td></tr>
     240<tr class="separator:aaf735d7535414d32e023d5eef8d525fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
    232241<tr class="memitem:aa020369da0c3f8c80eef6abf9cad0cd9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_imu.html#aa020369da0c3f8c80eef6abf9cad0cd9">GetDatas</a> (<a class="el" href="classflair_1_1core_1_1_imu_data.html">core::ImuData</a> **imuData) const </td></tr>
    233242<tr class="memdesc:aa020369da0c3f8c80eef6abf9cad0cd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get imu datas.  <a href="#aa020369da0c3f8c80eef6abf9cad0cd9">More...</a><br /></td></tr>
     
    237246<tr class="memdesc:a3df9057ae23eb34f1b1dae8e7a4a9efc inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft">&#160;</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>
    238247<tr class="separator:a3df9057ae23eb34f1b1dae8e7a4a9efc inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
     248<tr class="memitem:a120fdcc3d50f6f076084cb6943fdf412 inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memItemLeft" align="right" valign="top">void&#160;</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>
     249<tr class="memdesc:a120fdcc3d50f6f076084cb6943fdf412 inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="mdescLeft">&#160;</td><td class="mdescRight">set is ready  <a href="#a120fdcc3d50f6f076084cb6943fdf412">More...</a><br /></td></tr>
     250<tr class="separator:a120fdcc3d50f6f076084cb6943fdf412 inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
    239251</table><table class="memberdecls">
    240252<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
     
    252264<p>Use this class to define a custom <a class="el" href="classflair_1_1sensor_1_1_imu.html" title="Base class for Imu. ">Imu</a>. </p>
    253265</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
    254 <a class="anchor" id="a2ee0420d6e69be3a51c9ad1ac1c6b386"></a>
     266<a class="anchor" id="ab8c2e7ec4d6d6d4efd175d2ce0811159"></a>
    255267<div class="memitem">
    256268<div class="memproto">
     
    259271          <td class="memname">flair::sensor::Imu::Imu </td>
    260272          <td>(</td>
    261           <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_framework_manager.html">core::FrameworkManager</a> *&#160;</td>
    262           <td class="paramname"><em>parent</em>, </td>
    263         </tr>
    264         <tr>
    265           <td class="paramkey"></td>
     273          <td class="paramtype">std::string&#160;</td>
     274          <td class="paramname"><em>name</em></td><td>)</td>
    266275          <td></td>
    267           <td class="paramtype">std::string&#160;</td>
    268           <td class="paramname"><em>name</em>&#160;</td>
    269         </tr>
    270         <tr>
    271           <td></td>
    272           <td>)</td>
    273           <td></td><td></td>
    274276        </tr>
    275277      </table>
     
    277279
    278280<p>Constructor. </p>
    279 <p>Construct an <a class="el" href="classflair_1_1sensor_1_1_imu.html" title="Base class for Imu. ">Imu</a>.</p>
     281<p>Construct an <a class="el" href="classflair_1_1sensor_1_1_imu.html" title="Base class for Imu. ">Imu</a>. It will be child of the FrameworkManager.</p>
    280282<dl class="params"><dt>Parameters</dt><dd>
    281283  <table class="params">
    282     <tr><td class="paramname">parent</td><td>parent </td></tr>
    283284    <tr><td class="paramname">name</td><td>name </td></tr>
    284285  </table>
     
    343344</div>
    344345<h2 class="groupheader">Member Function Documentation</h2>
     346<a class="anchor" id="adb1105fe7b1c21234b6edde4d64da428"></a>
     347<div class="memitem">
     348<div class="memproto">
     349      <table class="memname">
     350        <tr>
     351          <td class="memname">const <a class="el" href="classflair_1_1core_1_1_imu_data.html">core::ImuData</a>* flair::sensor::Imu::GetDatas </td>
     352          <td>(</td>
     353          <td class="paramtype">void&#160;</td>
     354          <td class="paramname"></td><td>)</td>
     355          <td> const</td>
     356        </tr>
     357      </table>
     358</div><div class="memdoc">
     359
     360<p>Get IMU datas. </p>
     361<dl class="section return"><dt>Returns</dt><dd>ImuData </dd></dl>
     362
     363</div>
     364</div>
    345365<a class="anchor" id="a1d74dd0b750c287b112489786ff5b7eb"></a>
    346366<div class="memitem">
     
    481501</div>
    482502</div>
    483 <a class="anchor" id="a32a260c66ae679869d7628c561c35346"></a>
     503<a class="anchor" id="ad19d0939034366aafe24aceaf41a936f"></a>
    484504<div class="memitem">
    485505<div class="memproto">
     
    489509      <table class="memname">
    490510        <tr>
    491           <td class="memname">void flair::sensor::Imu::UpdateImu </td>
    492           <td>(</td>
    493           <td class="paramname"></td><td>)</td>
     511          <td class="memname">void flair::sensor::Imu::ApplyRotation </td>
     512          <td>(</td>
     513          <td class="paramtype"><a class="el" href="classflair_1_1core_1_1_vector3_d.html">core::Vector3Df</a> &amp;&#160;</td>
     514          <td class="paramname"><em>vector</em></td><td>)</td>
    494515          <td></td>
    495516        </tr>
     
    502523</div><div class="memdoc">
    503524
    504 <p>UpdateImu. </p>
    505 <p>The reimplemented class must call this function as soon as IMU datas are available. <br />
    506  It handles the data rotation if it was defined. </p>
    507 
    508 </div>
    509 </div>
    510 <a class="anchor" id="aa020369da0c3f8c80eef6abf9cad0cd9"></a>
     525<p>ApplyRotation. </p>
     526<p>The reimplemented class must call this function to rotate IMU datas, before filling the ImuData. <br />
     527It handles the data rotation if it was defined.</p>
     528<dl class="params"><dt>Parameters</dt><dd>
     529  <table class="params">
     530    <tr><td class="paramname">vector</td><td>vector to apply rotation to </td></tr>
     531  </table>
     532  </dd>
     533</dl>
     534
     535</div>
     536</div>
     537<a class="anchor" id="aaf735d7535414d32e023d5eef8d525fc"></a>
    511538<div class="memitem">
    512539<div class="memproto">
     
    516543      <table class="memname">
    517544        <tr>
    518           <td class="memname">void flair::sensor::Imu::GetDatas </td>
    519           <td>(</td>
    520           <td class="paramtype"><a class="el" href="classflair_1_1core_1_1_imu_data.html">core::ImuData</a> **&#160;</td>
    521           <td class="paramname"><em>imuData</em></td><td>)</td>
    522           <td> const</td>
     545          <td class="memname">void flair::sensor::Imu::ApplyRotation </td>
     546          <td>(</td>
     547          <td class="paramtype"><a class="el" href="classflair_1_1core_1_1_quaternion.html">core::Quaternion</a> &amp;&#160;</td>
     548          <td class="paramname"><em>quaternion</em></td><td>)</td>
     549          <td></td>
    523550        </tr>
    524551      </table>
     
    530557</div><div class="memdoc">
    531558
     559<p>ApplyRotation. </p>
     560<p>The reimplemented class must call this function to rotate IMU datas, before filling the ImuData. <br />
     561It handles the data rotation if it was defined.</p>
     562<dl class="params"><dt>Parameters</dt><dd>
     563  <table class="params">
     564    <tr><td class="paramname">quaternion</td><td>quaternion to apply rotation to </td></tr>
     565  </table>
     566  </dd>
     567</dl>
     568
     569</div>
     570</div>
     571<a class="anchor" id="aa020369da0c3f8c80eef6abf9cad0cd9"></a>
     572<div class="memitem">
     573<div class="memproto">
     574<table class="mlabels">
     575  <tr>
     576  <td class="mlabels-left">
     577      <table class="memname">
     578        <tr>
     579          <td class="memname">void flair::sensor::Imu::GetDatas </td>
     580          <td>(</td>
     581          <td class="paramtype"><a class="el" href="classflair_1_1core_1_1_imu_data.html">core::ImuData</a> **&#160;</td>
     582          <td class="paramname"><em>imuData</em></td><td>)</td>
     583          <td> const</td>
     584        </tr>
     585      </table>
     586  </td>
     587  <td class="mlabels-right">
     588<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
     589  </tr>
     590</table>
     591</div><div class="memdoc">
     592
    532593<p>Get imu datas. </p>
     594<p>Can be used by dervied class to fill <a class="el" href="classflair_1_1core_1_1_imu_data.html" title="Class defining IMU datas. ">core::ImuData</a></p>
    533595<dl class="params"><dt>Parameters</dt><dd>
    534596  <table class="params">
     
    546608  <ul>
    547609    <li class="navelem"><a class="el" href="namespaceflair.html">flair</a></li><li class="navelem"><a class="el" href="namespaceflair_1_1sensor.html">sensor</a></li><li class="navelem"><a class="el" href="classflair_1_1sensor_1_1_imu.html">Imu</a></li>
    548     <li class="footer">Generated on Tue Jan 17 2017 09:52:31 for Flair by
     610    <li class="footer">Generated on Wed May 31 2017 13:50:37 for Flair by
    549611    <a href="http://www.doxygen.org/index.html">
    550612    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
Note: See TracChangeset for help on using the changeset viewer.