Ignore:
Timestamp:
05/31/17 15:54:26 (7 years ago)
Author:
Sanahuja Guillaume
Message:

doc

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/Flair/classflair_1_1filter_1_1_butterworth_low_pass.html

    r47 r50  
    135135<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
    136136Public Member Functions</h2></td></tr>
    137 <tr class="memitem:ad1417a0766eef7efb2edff2ee414088f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_butterworth_low_pass.html#ad1417a0766eef7efb2edff2ee414088f">ButterworthLowPass</a> (const <a class="el" href="classflair_1_1core_1_1_i_o_device.html#a9693b497752b466891eaafeb34bec4d3">IODevice</a> *parent, const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *position, std::string name, int order)</td></tr>
    138 <tr class="memdesc:ad1417a0766eef7efb2edff2ee414088f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ad1417a0766eef7efb2edff2ee414088f">More...</a><br /></td></tr>
    139 <tr class="separator:ad1417a0766eef7efb2edff2ee414088f"><td class="memSeparator" colspan="2">&#160;</td></tr>
    140 <tr class="memitem:ad7fe750163ad9241b1e0ba2eef88329c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_butterworth_low_pass.html#ad7fe750163ad9241b1e0ba2eef88329c">ButterworthLowPass</a> (const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *position, std::string name, int order)</td></tr>
    141 <tr class="memdesc:ad7fe750163ad9241b1e0ba2eef88329c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ad7fe750163ad9241b1e0ba2eef88329c">More...</a><br /></td></tr>
    142 <tr class="separator:ad7fe750163ad9241b1e0ba2eef88329c"><td class="memSeparator" colspan="2">&#160;</td></tr>
     137<tr class="memitem:aa982dd5cecd600c46345fe63a65e0370"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_butterworth_low_pass.html#aa982dd5cecd600c46345fe63a65e0370">ButterworthLowPass</a> (const <a class="el" href="classflair_1_1core_1_1_i_o_device.html#a9693b497752b466891eaafeb34bec4d3">IODevice</a> *parent, const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *position, std::string name, uint32_t order, uint32_t nbRow=1, uint32_t nbCol=1)</td></tr>
     138<tr class="memdesc:aa982dd5cecd600c46345fe63a65e0370"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#aa982dd5cecd600c46345fe63a65e0370">More...</a><br /></td></tr>
     139<tr class="separator:aa982dd5cecd600c46345fe63a65e0370"><td class="memSeparator" colspan="2">&#160;</td></tr>
     140<tr class="memitem:a95c0459c5ab91626fe61560db664932d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_butterworth_low_pass.html#a95c0459c5ab91626fe61560db664932d">ButterworthLowPass</a> (const <a class="el" href="classflair_1_1gui_1_1_layout_position.html">gui::LayoutPosition</a> *position, std::string name, uint32_t order, uint32_t nbRow, uint32_t nbCol)</td></tr>
     141<tr class="memdesc:a95c0459c5ab91626fe61560db664932d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a95c0459c5ab91626fe61560db664932d">More...</a><br /></td></tr>
     142<tr class="separator:a95c0459c5ab91626fe61560db664932d"><td class="memSeparator" colspan="2">&#160;</td></tr>
    143143<tr class="memitem:a8d46936fb2781bc74297c1fee29f54b7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1filter_1_1_butterworth_low_pass.html#a8d46936fb2781bc74297c1fee29f54b7">~ButterworthLowPass</a> ()</td></tr>
    144144<tr class="memdesc:a8d46936fb2781bc74297c1fee29f54b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a8d46936fb2781bc74297c1fee29f54b7">More...</a><br /></td></tr>
    … …  
    169169<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>
    170170<tr class="separator:a12d811c6926fb86da6b47f889109da66 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
     171<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>
     172<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>
     173<tr class="separator:aee7828ae2eece2bace8e476dacc2bc12 inherit pub_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
    171174<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>
    172175virtual <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>
    … …  
    223226<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>
    224227<tr class="separator:a3df9057ae23eb34f1b1dae8e7a4a9efc inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
     228<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>
     229<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>
     230<tr class="separator:a120fdcc3d50f6f076084cb6943fdf412 inherit pro_methods_classflair_1_1core_1_1_i_o_device"><td class="memSeparator" colspan="2">&#160;</td></tr>
    225231</table>
    226232<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    227233<div class="textblock"><p>Class defining a Butterworth low pass filter. </p>
    228234</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
    229 <a class="anchor" id="ad1417a0766eef7efb2edff2ee414088f"></a>
     235<a class="anchor" id="aa982dd5cecd600c46345fe63a65e0370"></a>
    230236<div class="memitem">
    231237<div class="memproto">
    … …  
    252258          <td class="paramkey"></td>
    253259          <td></td>
    254           <td class="paramtype">int&#160;</td>
    255           <td class="paramname"><em>order</em>&#160;</td>
     260          <td class="paramtype">uint32_t&#160;</td>
     261          <td class="paramname"><em>order</em>, </td>
     262        </tr>
     263        <tr>
     264          <td class="paramkey"></td>
     265          <td></td>
     266          <td class="paramtype">uint32_t&#160;</td>
     267          <td class="paramname"><em>nbRow</em> = <code>1</code>, </td>
     268        </tr>
     269        <tr>
     270          <td class="paramkey"></td>
     271          <td></td>
     272          <td class="paramtype">uint32_t&#160;</td>
     273          <td class="paramname"><em>nbCol</em> = <code>1</code>&#160;</td>
    256274        </tr>
    257275        <tr>
    … …  
    273291    <tr><td class="paramname">name</td><td>name </td></tr>
    274292    <tr><td class="paramname">order</td><td>order of the filter </td></tr>
     293    <tr><td class="paramname">nbRow</td><td>number of rows of input/output </td></tr>
     294    <tr><td class="paramname">nbCol</td><td>number of cols of input/output </td></tr>
    275295  </table>
    276296  </dd>
    … …  
    279299</div>
    280300</div>
    281 <a class="anchor" id="ad7fe750163ad9241b1e0ba2eef88329c"></a>
     301<a class="anchor" id="a95c0459c5ab91626fe61560db664932d"></a>
    282302<div class="memitem">
    283303<div class="memproto">
    … …  
    298318          <td class="paramkey"></td>
    299319          <td></td>
    300           <td class="paramtype">int&#160;</td>
    301           <td class="paramname"><em>order</em>&#160;</td>
     320          <td class="paramtype">uint32_t&#160;</td>
     321          <td class="paramname"><em>order</em>, </td>
     322        </tr>
     323        <tr>
     324          <td class="paramkey"></td>
     325          <td></td>
     326          <td class="paramtype">uint32_t&#160;</td>
     327          <td class="paramname"><em>nbRow</em>, </td>
     328        </tr>
     329        <tr>
     330          <td class="paramkey"></td>
     331          <td></td>
     332          <td class="paramtype">uint32_t&#160;</td>
     333          <td class="paramname"><em>nbCol</em>&#160;</td>
    302334        </tr>
    303335        <tr>
    … …  
    318350    <tr><td class="paramname">name</td><td>name </td></tr>
    319351    <tr><td class="paramname">order</td><td>order of the filter </td></tr>
     352    <tr><td class="paramname">nbRow</td><td>number of rows of input/output </td></tr>
     353    <tr><td class="paramname">nbCol</td><td>number of cols of input/output </td></tr>
    320354  </table>
    321355  </dd>
    … …  
    421455  <ul>
    422456    <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_butterworth_low_pass.html">ButterworthLowPass</a></li>
    423     <li class="footer">Generated on Tue Jan 17 2017 09:52:31 for Flair by
     457    <li class="footer">Generated on Wed May 31 2017 13:50:37 for Flair by
    424458    <a href="http://www.doxygen.org/index.html">
    425459    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
Note: See TracChangeset for help on using the changeset viewer.