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_simu_us.html

    r47 r50  
    140140<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
    141141Public Member Functions</h2></td></tr>
    142 <tr class="memitem:a99d29a5be11149d02be1548e401f483c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_simu_us.html#a99d29a5be11149d02be1548e401f483c">SimuUs</a> (const <a class="el" href="classflair_1_1core_1_1_framework_manager.html">core::FrameworkManager</a> *parent, std::string name, uint32_t dev_id, uint8_t priority)</td></tr>
    143 <tr class="memdesc:a99d29a5be11149d02be1548e401f483c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a99d29a5be11149d02be1548e401f483c">More...</a><br /></td></tr>
    144 <tr class="separator:a99d29a5be11149d02be1548e401f483c"><td class="memSeparator" colspan="2">&#160;</td></tr>
    145 <tr class="memitem:ac9d4c834d90e8695e6881900dd860477"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_simu_us.html#ac9d4c834d90e8695e6881900dd860477">SimuUs</a> (const <a class="el" href="classflair_1_1core_1_1_i_o_device.html">core::IODevice</a> *parent, std::string name, uint32_t dev_id)</td></tr>
    146 <tr class="memdesc:ac9d4c834d90e8695e6881900dd860477"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ac9d4c834d90e8695e6881900dd860477">More...</a><br /></td></tr>
    147 <tr class="separator:ac9d4c834d90e8695e6881900dd860477"><td class="memSeparator" colspan="2">&#160;</td></tr>
     142<tr class="memitem:a58061ed933ca6d95f563886a8b9ff4d9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_simu_us.html#a58061ed933ca6d95f563886a8b9ff4d9">SimuUs</a> (std::string name, uint32_t modelId, uint32_t deviceId, uint8_t priority)</td></tr>
     143<tr class="memdesc:a58061ed933ca6d95f563886a8b9ff4d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a58061ed933ca6d95f563886a8b9ff4d9">More...</a><br /></td></tr>
     144<tr class="separator:a58061ed933ca6d95f563886a8b9ff4d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
     145<tr class="memitem:a6809a978e76619c5bfff3aca092e49ed"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_simu_us.html#a6809a978e76619c5bfff3aca092e49ed">SimuUs</a> (const <a class="el" href="classflair_1_1core_1_1_i_o_device.html">core::IODevice</a> *parent, std::string name, uint32_t modelId, uint32_t deviceId)</td></tr>
     146<tr class="memdesc:a6809a978e76619c5bfff3aca092e49ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a6809a978e76619c5bfff3aca092e49ed">More...</a><br /></td></tr>
     147<tr class="separator:a6809a978e76619c5bfff3aca092e49ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
    148148<tr class="memitem:a52c1587525fe53be58f7d1681d8f3de4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_simu_us.html#a52c1587525fe53be58f7d1681d8f3de4">~SimuUs</a> ()</td></tr>
    149149<tr class="memdesc:a52c1587525fe53be58f7d1681d8f3de4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a52c1587525fe53be58f7d1681d8f3de4">More...</a><br /></td></tr>
     
    201201<tr class="memdesc:adac9a6d336bdb50bcfa24c66943a355a inherit pub_methods_classflair_1_1core_1_1_thread"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the thread suspended?  <a href="#adac9a6d336bdb50bcfa24c66943a355a">More...</a><br /></td></tr>
    202202<tr class="separator:adac9a6d336bdb50bcfa24c66943a355a inherit pub_methods_classflair_1_1core_1_1_thread"><td class="memSeparator" colspan="2">&#160;</td></tr>
     203<tr class="memitem:a2a82d0ade1418111c2a4e7d0e133696c inherit pub_methods_classflair_1_1core_1_1_thread"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#a2a82d0ade1418111c2a4e7d0e133696c">IsRunning</a> (void) const </td></tr>
     204<tr class="memdesc:a2a82d0ade1418111c2a4e7d0e133696c inherit pub_methods_classflair_1_1core_1_1_thread"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the thread running?  <a href="#a2a82d0ade1418111c2a4e7d0e133696c">More...</a><br /></td></tr>
     205<tr class="separator:a2a82d0ade1418111c2a4e7d0e133696c inherit pub_methods_classflair_1_1core_1_1_thread"><td class="memSeparator" colspan="2">&#160;</td></tr>
    203206<tr class="memitem:ac09a2d745af3dbb42371949d4c622011 inherit pub_methods_classflair_1_1core_1_1_thread"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#ac09a2d745af3dbb42371949d4c622011">SleepUntil</a> (<a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> time) const </td></tr>
    204207<tr class="memdesc:ac09a2d745af3dbb42371949d4c622011 inherit pub_methods_classflair_1_1core_1_1_thread"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sleep until absolute time.  <a href="#ac09a2d745af3dbb42371949d4c622011">More...</a><br /></td></tr>
     
    245248<tr class="separator:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
    246249<tr class="inherit_header pub_methods_classflair_1_1sensor_1_1_us_range_finder"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1sensor_1_1_us_range_finder')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1sensor_1_1_us_range_finder.html">flair::sensor::UsRangeFinder</a></td></tr>
    247 <tr class="memitem:a92739675dbf2aa7337b23420afb731dd inherit pub_methods_classflair_1_1sensor_1_1_us_range_finder"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_us_range_finder.html#a92739675dbf2aa7337b23420afb731dd">UsRangeFinder</a> (const <a class="el" href="classflair_1_1core_1_1_framework_manager.html">core::FrameworkManager</a> *parent, std::string name)</td></tr>
    248 <tr class="memdesc:a92739675dbf2aa7337b23420afb731dd inherit pub_methods_classflair_1_1sensor_1_1_us_range_finder"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a92739675dbf2aa7337b23420afb731dd">More...</a><br /></td></tr>
    249 <tr class="separator:a92739675dbf2aa7337b23420afb731dd inherit pub_methods_classflair_1_1sensor_1_1_us_range_finder"><td class="memSeparator" colspan="2">&#160;</td></tr>
     250<tr class="memitem:abbf91741851723e0d2d56116500a1363 inherit pub_methods_classflair_1_1sensor_1_1_us_range_finder"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_us_range_finder.html#abbf91741851723e0d2d56116500a1363">UsRangeFinder</a> (std::string name)</td></tr>
     251<tr class="memdesc:abbf91741851723e0d2d56116500a1363 inherit pub_methods_classflair_1_1sensor_1_1_us_range_finder"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#abbf91741851723e0d2d56116500a1363">More...</a><br /></td></tr>
     252<tr class="separator:abbf91741851723e0d2d56116500a1363 inherit pub_methods_classflair_1_1sensor_1_1_us_range_finder"><td class="memSeparator" colspan="2">&#160;</td></tr>
    250253<tr class="memitem:ab8b56ed2839e584a1e88a00cedf81051 inherit pub_methods_classflair_1_1sensor_1_1_us_range_finder"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_us_range_finder.html#ab8b56ed2839e584a1e88a00cedf81051">UsRangeFinder</a> (const <a class="el" href="classflair_1_1core_1_1_i_o_device.html">core::IODevice</a> *parent, std::string name)</td></tr>
    251254<tr class="memdesc:ab8b56ed2839e584a1e88a00cedf81051 inherit pub_methods_classflair_1_1sensor_1_1_us_range_finder"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ab8b56ed2839e584a1e88a00cedf81051">More...</a><br /></td></tr>
     
    291294<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>
    292295<tr class="separator:a12d811c6926fb86da6b47f889109da66 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
     296<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>
     297<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>
     298<tr class="separator:aee7828ae2eece2bace8e476dacc2bc12 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
    293299<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>
    294300virtual <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>
     
    329335<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>
    330336<tr class="separator:a3df9057ae23eb34f1b1dae8e7a4a9efc inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
     337<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>
     338<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>
     339<tr class="separator:a120fdcc3d50f6f076084cb6943fdf412 inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
    331340</table>
    332341<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    333342<div class="textblock"><p>Class for a simulation <a class="el" href="classflair_1_1sensor_1_1_us_range_finder.html" title="Base class for UsRangeFinder. ">UsRangeFinder</a>. </p>
    334343</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
    335 <a class="anchor" id="a99d29a5be11149d02be1548e401f483c"></a>
     344<a class="anchor" id="a58061ed933ca6d95f563886a8b9ff4d9"></a>
    336345<div class="memitem">
    337346<div class="memproto">
     
    340349          <td class="memname">flair::sensor::SimuUs::SimuUs </td>
    341350          <td>(</td>
    342           <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_framework_manager.html">core::FrameworkManager</a> *&#160;</td>
    343           <td class="paramname"><em>parent</em>, </td>
    344         </tr>
    345         <tr>
    346           <td class="paramkey"></td>
    347           <td></td>
    348351          <td class="paramtype">std::string&#160;</td>
    349352          <td class="paramname"><em>name</em>, </td>
     
    353356          <td></td>
    354357          <td class="paramtype">uint32_t&#160;</td>
    355           <td class="paramname"><em>dev_id</em>, </td>
     358          <td class="paramname"><em>modelId</em>, </td>
     359        </tr>
     360        <tr>
     361          <td class="paramkey"></td>
     362          <td></td>
     363          <td class="paramtype">uint32_t&#160;</td>
     364          <td class="paramname"><em>deviceId</em>, </td>
    356365        </tr>
    357366        <tr>
     
    370379
    371380<p>Constructor. </p>
    372 <p>Construct a <a class="el" href="classflair_1_1sensor_1_1_simu_us.html" title="Class for a simulation UsRangeFinder. ">SimuUs</a>. Control part.</p>
     381<p>Construct a <a class="el" href="classflair_1_1sensor_1_1_simu_us.html" title="Class for a simulation UsRangeFinder. ">SimuUs</a>. Control part. It will be child of the FrameworkManager.</p>
    373382<dl class="params"><dt>Parameters</dt><dd>
    374383  <table class="params">
    375     <tr><td class="paramname">parent</td><td>parent </td></tr>
    376384    <tr><td class="paramname">name</td><td>name </td></tr>
    377     <tr><td class="paramname">dev_id</td><td>device id </td></tr>
     385    <tr><td class="paramname">modelId</td><td>Model id </td></tr>
     386    <tr><td class="paramname">deviceId</td><td><a class="el" href="classflair_1_1sensor_1_1_us_range_finder.html" title="Base class for UsRangeFinder. ">UsRangeFinder</a> id of the Model </td></tr>
    378387    <tr><td class="paramname">priority</td><td>priority of the Thread </td></tr>
    379388  </table>
     
    383392</div>
    384393</div>
    385 <a class="anchor" id="ac9d4c834d90e8695e6881900dd860477"></a>
     394<a class="anchor" id="a6809a978e76619c5bfff3aca092e49ed"></a>
    386395<div class="memitem">
    387396<div class="memproto">
     
    403412          <td></td>
    404413          <td class="paramtype">uint32_t&#160;</td>
    405           <td class="paramname"><em>dev_id</em>&#160;</td>
     414          <td class="paramname"><em>modelId</em>, </td>
     415        </tr>
     416        <tr>
     417          <td class="paramkey"></td>
     418          <td></td>
     419          <td class="paramtype">uint32_t&#160;</td>
     420          <td class="paramname"><em>deviceId</em>&#160;</td>
    406421        </tr>
    407422        <tr>
     
    420435    <tr><td class="paramname">parent</td><td>parent </td></tr>
    421436    <tr><td class="paramname">name</td><td>name </td></tr>
    422     <tr><td class="paramname">dev_id</td><td>device id </td></tr>
     437    <tr><td class="paramname">modelId</td><td>Model id </td></tr>
     438    <tr><td class="paramname">deviceId</td><td><a class="el" href="classflair_1_1sensor_1_1_us_range_finder.html" title="Base class for UsRangeFinder. ">UsRangeFinder</a> id of the Model </td></tr>
    423439  </table>
    424440  </dd>
     
    473489  <ul>
    474490    <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_simu_us.html">SimuUs</a></li>
    475     <li class="footer">Generated on Tue Jan 17 2017 09:52:31 for Flair by
     491    <li class="footer">Generated on Wed May 31 2017 13:50:38 for Flair by
    476492    <a href="http://www.doxygen.org/index.html">
    477493    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
Note: See TracChangeset for help on using the changeset viewer.