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_camera.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:a386047097db5bfac75150c28204939df"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_simu_camera.html#a386047097db5bfac75150c28204939df">SimuCamera</a> (const <a class="el" href="classflair_1_1core_1_1_framework_manager.html">core::FrameworkManager</a> *parent, std::string name, uint16_t width, uint16_t height, uint8_t channels, uint32_t dev_id, uint8_t priority)</td></tr>
    143 <tr class="memdesc:a386047097db5bfac75150c28204939df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a386047097db5bfac75150c28204939df">More...</a><br /></td></tr>
    144 <tr class="separator:a386047097db5bfac75150c28204939df"><td class="memSeparator" colspan="2">&#160;</td></tr>
    145 <tr class="memitem:a6be09ed197576ce8c2db3116555cd176"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_simu_camera.html#a6be09ed197576ce8c2db3116555cd176">SimuCamera</a> (const <a class="el" href="classflair_1_1core_1_1_i_o_device.html">core::IODevice</a> *parent, std::string name, uint16_t width, uint16_t height, uint8_t channels, uint32_t dev_id)</td></tr>
    146 <tr class="memdesc:a6be09ed197576ce8c2db3116555cd176"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a6be09ed197576ce8c2db3116555cd176">More...</a><br /></td></tr>
    147 <tr class="separator:a6be09ed197576ce8c2db3116555cd176"><td class="memSeparator" colspan="2">&#160;</td></tr>
     142<tr class="memitem:aa79f6ad054829916ac8404eb25e284e7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_simu_camera.html#aa79f6ad054829916ac8404eb25e284e7">SimuCamera</a> (std::string name, uint16_t width, uint16_t height, uint8_t channels, uint32_t modelId, uint32_t deviceId, uint8_t priority)</td></tr>
     143<tr class="memdesc:aa79f6ad054829916ac8404eb25e284e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#aa79f6ad054829916ac8404eb25e284e7">More...</a><br /></td></tr>
     144<tr class="separator:aa79f6ad054829916ac8404eb25e284e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
     145<tr class="memitem:a6268c6637a325229c73ac49d7af7882e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_simu_camera.html#a6268c6637a325229c73ac49d7af7882e">SimuCamera</a> (const <a class="el" href="classflair_1_1core_1_1_i_o_device.html">core::IODevice</a> *parent, std::string name, uint16_t width, uint16_t height, uint8_t channels, uint32_t modelId, uint32_t deviceId)</td></tr>
     146<tr class="memdesc:a6268c6637a325229c73ac49d7af7882e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a6268c6637a325229c73ac49d7af7882e">More...</a><br /></td></tr>
     147<tr class="separator:a6268c6637a325229c73ac49d7af7882e"><td class="memSeparator" colspan="2">&#160;</td></tr>
    148148<tr class="memitem:aa08b34cc19a3bc1b7f4eb6e0b344a5d0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_simu_camera.html#aa08b34cc19a3bc1b7f4eb6e0b344a5d0">~SimuCamera</a> ()</td></tr>
    149149<tr class="memdesc:aa08b34cc19a3bc1b7f4eb6e0b344a5d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#aa08b34cc19a3bc1b7f4eb6e0b344a5d0">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_camera"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1sensor_1_1_camera')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1sensor_1_1_camera.html">flair::sensor::Camera</a></td></tr>
    247 <tr class="memitem:a0367c89fe729864229dcafe2ff10fb8a inherit pub_methods_classflair_1_1sensor_1_1_camera"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_camera.html#a0367c89fe729864229dcafe2ff10fb8a">Camera</a> (const <a class="el" href="classflair_1_1core_1_1_framework_manager.html">core::FrameworkManager</a> *parent, std::string name, uint16_t width, uint16_t height, <a class="el" href="classflair_1_1core_1_1cvimage_1_1_type.html#abbfd16d91156a75d6ddbe7858aa8692f">core::cvimage::Type::Format</a> format)</td></tr>
    248 <tr class="memdesc:a0367c89fe729864229dcafe2ff10fb8a inherit pub_methods_classflair_1_1sensor_1_1_camera"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a0367c89fe729864229dcafe2ff10fb8a">More...</a><br /></td></tr>
    249 <tr class="separator:a0367c89fe729864229dcafe2ff10fb8a inherit pub_methods_classflair_1_1sensor_1_1_camera"><td class="memSeparator" colspan="2">&#160;</td></tr>
     250<tr class="memitem:ab457977303cb9158d67d65da014aaab4 inherit pub_methods_classflair_1_1sensor_1_1_camera"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_camera.html#ab457977303cb9158d67d65da014aaab4">Camera</a> (std::string name, uint16_t width, uint16_t height, <a class="el" href="classflair_1_1core_1_1cvimage_1_1_type.html#abbfd16d91156a75d6ddbe7858aa8692f">core::cvimage::Type::Format</a> format)</td></tr>
     251<tr class="memdesc:ab457977303cb9158d67d65da014aaab4 inherit pub_methods_classflair_1_1sensor_1_1_camera"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ab457977303cb9158d67d65da014aaab4">More...</a><br /></td></tr>
     252<tr class="separator:ab457977303cb9158d67d65da014aaab4 inherit pub_methods_classflair_1_1sensor_1_1_camera"><td class="memSeparator" colspan="2">&#160;</td></tr>
    250253<tr class="memitem:a2dbddbcfb399c7dae0de7b455a3b9d90 inherit pub_methods_classflair_1_1sensor_1_1_camera"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_camera.html#a2dbddbcfb399c7dae0de7b455a3b9d90">Camera</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:a2dbddbcfb399c7dae0de7b455a3b9d90 inherit pub_methods_classflair_1_1sensor_1_1_camera"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a2dbddbcfb399c7dae0de7b455a3b9d90">More...</a><br /></td></tr>
     
    266269<tr class="memdesc:a2c8759d51a00ada2c069b51c34d17653 inherit pub_methods_classflair_1_1sensor_1_1_camera"><td class="mdescLeft">&#160;</td><td class="mdescRight">Save raw picture to file.  <a href="#a2c8759d51a00ada2c069b51c34d17653">More...</a><br /></td></tr>
    267270<tr class="separator:a2c8759d51a00ada2c069b51c34d17653 inherit pub_methods_classflair_1_1sensor_1_1_camera"><td class="memSeparator" colspan="2">&#160;</td></tr>
    268 <tr class="memitem:adaa0b365fb3d3de0308e0269451db957 inherit pub_methods_classflair_1_1sensor_1_1_camera"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_camera.html#adaa0b365fb3d3de0308e0269451db957">SavePictureToFile</a> (std::string filename) const </td></tr>
    269 <tr class="memdesc:adaa0b365fb3d3de0308e0269451db957 inherit pub_methods_classflair_1_1sensor_1_1_camera"><td class="mdescLeft">&#160;</td><td class="mdescRight">Save picture to file.  <a href="#adaa0b365fb3d3de0308e0269451db957">More...</a><br /></td></tr>
    270 <tr class="separator:adaa0b365fb3d3de0308e0269451db957 inherit pub_methods_classflair_1_1sensor_1_1_camera"><td class="memSeparator" colspan="2">&#160;</td></tr>
     271<tr class="memitem:a4f458342696953d923ee40efbc6a3e0e inherit pub_methods_classflair_1_1sensor_1_1_camera"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_camera.html#a4f458342696953d923ee40efbc6a3e0e">SavePictureToFile</a> (std::string filename=&quot;&quot;) const </td></tr>
     272<tr class="memdesc:a4f458342696953d923ee40efbc6a3e0e inherit pub_methods_classflair_1_1sensor_1_1_camera"><td class="mdescLeft">&#160;</td><td class="mdescRight">Save picture to file.  <a href="#a4f458342696953d923ee40efbc6a3e0e">More...</a><br /></td></tr>
     273<tr class="separator:a4f458342696953d923ee40efbc6a3e0e inherit pub_methods_classflair_1_1sensor_1_1_camera"><td class="memSeparator" colspan="2">&#160;</td></tr>
    271274<tr class="memitem:ac812dd64ee47c9241dd83e37948fbc63 inherit pub_methods_classflair_1_1sensor_1_1_camera"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1sensor_1_1_camera.html#ac812dd64ee47c9241dd83e37948fbc63">Width</a> (void) const </td></tr>
    272275<tr class="memdesc:ac812dd64ee47c9241dd83e37948fbc63 inherit pub_methods_classflair_1_1sensor_1_1_camera"><td class="mdescLeft">&#160;</td><td class="mdescRight">Width.  <a href="#ac812dd64ee47c9241dd83e37948fbc63">More...</a><br /></td></tr>
     
    303306<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>
    304307<tr class="separator:a12d811c6926fb86da6b47f889109da66 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
     308<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>
     309<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>
     310<tr class="separator:aee7828ae2eece2bace8e476dacc2bc12 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
    305311<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>
    306312virtual <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>
     
    345351<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>
    346352<tr class="separator:a3df9057ae23eb34f1b1dae8e7a4a9efc inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
     353<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>
     354<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>
     355<tr class="separator:a120fdcc3d50f6f076084cb6943fdf412 inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
    347356</table>
    348357<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    349358<div class="textblock"><p>Class for a simulation camera. </p>
    350359</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
    351 <a class="anchor" id="a386047097db5bfac75150c28204939df"></a>
     360<a class="anchor" id="aa79f6ad054829916ac8404eb25e284e7"></a>
    352361<div class="memitem">
    353362<div class="memproto">
     
    356365          <td class="memname">flair::sensor::SimuCamera::SimuCamera </td>
    357366          <td>(</td>
    358           <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_framework_manager.html">core::FrameworkManager</a> *&#160;</td>
    359           <td class="paramname"><em>parent</em>, </td>
    360         </tr>
    361         <tr>
    362           <td class="paramkey"></td>
    363           <td></td>
    364367          <td class="paramtype">std::string&#160;</td>
    365368          <td class="paramname"><em>name</em>, </td>
     
    387390          <td></td>
    388391          <td class="paramtype">uint32_t&#160;</td>
    389           <td class="paramname"><em>dev_id</em>, </td>
     392          <td class="paramname"><em>modelId</em>, </td>
     393        </tr>
     394        <tr>
     395          <td class="paramkey"></td>
     396          <td></td>
     397          <td class="paramtype">uint32_t&#160;</td>
     398          <td class="paramname"><em>deviceId</em>, </td>
    390399        </tr>
    391400        <tr>
     
    404413
    405414<p>Constructor. </p>
    406 <p>Construct a <a class="el" href="classflair_1_1sensor_1_1_simu_camera.html" title="Class for a simulation camera. ">SimuCamera</a>. Control part.</p>
     415<p>Construct a <a class="el" href="classflair_1_1sensor_1_1_simu_camera.html" title="Class for a simulation camera. ">SimuCamera</a>. Control part. It will be child of the FrameworkManager.</p>
    407416<dl class="params"><dt>Parameters</dt><dd>
    408417  <table class="params">
    409     <tr><td class="paramname">parent</td><td>parent </td></tr>
    410418    <tr><td class="paramname">name</td><td>name </td></tr>
    411419    <tr><td class="paramname">width</td><td>width </td></tr>
    412420    <tr><td class="paramname">height</td><td>height </td></tr>
    413421    <tr><td class="paramname">channels</td><td>number of channels </td></tr>
    414     <tr><td class="paramname">dev_id</td><td>device id </td></tr>
     422    <tr><td class="paramname">modelId</td><td>Model id </td></tr>
     423    <tr><td class="paramname">deviceId</td><td><a class="el" href="classflair_1_1sensor_1_1_camera.html" title="Base class for Camera. ">Camera</a> id of the Model </td></tr>
    415424    <tr><td class="paramname">priority</td><td>priority of the Thread </td></tr>
    416425  </table>
     
    420429</div>
    421430</div>
    422 <a class="anchor" id="a6be09ed197576ce8c2db3116555cd176"></a>
     431<a class="anchor" id="a6268c6637a325229c73ac49d7af7882e"></a>
    423432<div class="memitem">
    424433<div class="memproto">
     
    458467          <td></td>
    459468          <td class="paramtype">uint32_t&#160;</td>
    460           <td class="paramname"><em>dev_id</em>&#160;</td>
     469          <td class="paramname"><em>modelId</em>, </td>
     470        </tr>
     471        <tr>
     472          <td class="paramkey"></td>
     473          <td></td>
     474          <td class="paramtype">uint32_t&#160;</td>
     475          <td class="paramname"><em>deviceId</em>&#160;</td>
    461476        </tr>
    462477        <tr>
     
    478493    <tr><td class="paramname">height</td><td>height </td></tr>
    479494    <tr><td class="paramname">channels</td><td>number of channels </td></tr>
    480     <tr><td class="paramname">dev_id</td><td>device id </td></tr>
     495    <tr><td class="paramname">modelId</td><td>Model id </td></tr>
     496    <tr><td class="paramname">deviceId</td><td><a class="el" href="classflair_1_1sensor_1_1_camera.html" title="Base class for Camera. ">Camera</a> id of the Model </td></tr>
    481497  </table>
    482498  </dd>
     
    531547  <ul>
    532548    <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_camera.html">SimuCamera</a></li>
    533     <li class="footer">Generated on Tue Jan 17 2017 09:52:31 for Flair by
     549    <li class="footer">Generated on Wed May 31 2017 13:50:38 for Flair by
    534550    <a href="http://www.doxygen.org/index.html">
    535551    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
Note: See TracChangeset for help on using the changeset viewer.