Changeset 50 in flair-dev for trunk/doc/Flair/_srf08_8h_source.html


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

doc

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/Flair/_srf08_8h_source.html

    r47 r50  
    121121<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceflair.html">flair</a> {</div>
    122122<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="keyword">namespace </span>core {</div>
    123 <div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="keyword">class </span>FrameworkManager;</div>
    124 <div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="keyword">class </span>I2cPort;</div>
    125 <div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;}</div>
    126 <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="keyword">namespace </span>gui {</div>
    127 <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="keyword">class </span>SpinBox;</div>
    128 <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;;</div>
    129 <div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;}</div>
    130 <div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;}</div>
    131 <div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div>
    132 <div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceflair.html">flair</a> {</div>
    133 <div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="keyword">namespace </span>sensor {</div>
    134 <div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classflair_1_1sensor_1_1_srf08.html">   36</a></span>&#160;<span class="keyword">class </span><a class="code" href="classflair_1_1sensor_1_1_srf08.html">Srf08</a> : <span class="keyword">public</span> <a class="code" href="classflair_1_1core_1_1_thread.html">core::Thread</a>, <span class="keyword">public</span> <a class="code" href="classflair_1_1sensor_1_1_us_range_finder.html">UsRangeFinder</a> {</div>
    135 <div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div>
    136 <div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="keyword">public</span>:</div>
    137 <div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;  <a class="code" href="classflair_1_1sensor_1_1_srf08.html#ad4a67e82a8c599941b38d1e3e9861c62">Srf08</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1_framework_manager.html">core::FrameworkManager</a> *parent, std::string name,</div>
    138 <div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;        <a class="code" href="classflair_1_1core_1_1_i2c_port.html">core::I2cPort</a> *i2cport, uint16_t address, uint8_t priority);</div>
    139 <div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;</div>
    140 <div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;  <a class="code" href="classflair_1_1sensor_1_1_srf08.html#a98bf852157fdae881576d0b7f25da6b0">~Srf08</a>();</div>
    141 <div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div>
    142 <div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1sensor_1_1_srf08.html#ae760771d1ec4ede8ec0a901c5e178b32">SetRange</a>(<span class="keywordtype">void</span>);</div>
    143 <div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;</div>
    144 <div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1sensor_1_1_srf08.html#a29851770b97852246643187224054a14">SetMaxGain</a>(<span class="keywordtype">void</span>);</div>
    145 <div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;</div>
    146 <div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="keyword">private</span>:</div>
    147 <div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;  <span class="keywordtype">void</span> UpdateFrom(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1io__data.html">core::io_data</a> *data){};</div>
    148 <div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;</div>
    149 <div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;  <span class="keywordtype">void</span> Run(<span class="keywordtype">void</span>);</div>
    150 <div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;</div>
    151 <div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;  <span class="keywordtype">void</span> SendEcho(<span class="keywordtype">void</span>);</div>
    152 <div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;  <span class="keywordtype">void</span> GetEcho(<span class="keywordtype">void</span>);</div>
    153 <div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;</div>
    154 <div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;  <span class="keywordtype">bool</span> is_init;</div>
    155 <div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;  <a class="code" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">core::Time</a> echo_time;</div>
    156 <div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;  <span class="keywordtype">float</span> z_1, z_2;</div>
    157 <div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;  <a class="code" href="classflair_1_1gui_1_1_spin_box.html">gui::SpinBox</a> *gain, *range;</div>
    158 <div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;  uint16_t address;</div>
    159 <div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;  <a class="code" href="classflair_1_1core_1_1_i2c_port.html">core::I2cPort</a> *i2cport;</div>
    160 <div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;};</div>
    161 <div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;} <span class="comment">// end namespace sensor</span></div>
    162 <div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;} <span class="comment">// end namespace flair</span></div>
    163 <div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="preprocessor">#endif // SRF08_H</span></div>
     123<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="keyword">class </span>I2cPort;</div>
     124<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;}</div>
     125<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keyword">namespace </span>gui {</div>
     126<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="keyword">class </span>SpinBox;</div>
     127<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;}</div>
     128<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;}</div>
     129<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div>
     130<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceflair.html">flair</a> {</div>
     131<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="keyword">namespace </span>sensor {</div>
     132<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classflair_1_1sensor_1_1_srf08.html">   34</a></span>&#160;<span class="keyword">class </span><a class="code" href="classflair_1_1sensor_1_1_srf08.html">Srf08</a> : <span class="keyword">public</span> <a class="code" href="classflair_1_1core_1_1_thread.html">core::Thread</a>, <span class="keyword">public</span> <a class="code" href="classflair_1_1sensor_1_1_us_range_finder.html">UsRangeFinder</a> {</div>
     133<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;</div>
     134<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="keyword">public</span>:</div>
     135<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;  <a class="code" href="classflair_1_1sensor_1_1_srf08.html#a6b4c56ab2d67af7bf65dd632d9b26746">Srf08</a>(std::string name,</div>
     136<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;        <a class="code" href="classflair_1_1core_1_1_i2c_port.html">core::I2cPort</a> *i2cport, uint16_t address, uint8_t priority);</div>
     137<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;</div>
     138<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;  <a class="code" href="classflair_1_1sensor_1_1_srf08.html#a98bf852157fdae881576d0b7f25da6b0">~Srf08</a>();</div>
     139<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;</div>
     140<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1sensor_1_1_srf08.html#ae760771d1ec4ede8ec0a901c5e178b32">SetRange</a>(<span class="keywordtype">void</span>);</div>
     141<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;</div>
     142<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1sensor_1_1_srf08.html#a29851770b97852246643187224054a14">SetMaxGain</a>(<span class="keywordtype">void</span>);</div>
     143<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div>
     144<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="keyword">private</span>:</div>
     145<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;  <span class="keywordtype">void</span> UpdateFrom(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1io__data.html">core::io_data</a> *data){};</div>
     146<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;</div>
     147<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;  <span class="keywordtype">void</span> Run(<span class="keywordtype">void</span>);</div>
     148<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;</div>
     149<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;  <span class="keywordtype">void</span> SendEcho(<span class="keywordtype">void</span>);</div>
     150<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;  <span class="keywordtype">void</span> GetEcho(<span class="keywordtype">void</span>);</div>
     151<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;</div>
     152<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;  <span class="keywordtype">bool</span> is_init;</div>
     153<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;  <a class="code" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">core::Time</a> echo_time;</div>
     154<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;  <span class="keywordtype">float</span> z_1, z_2;</div>
     155<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;  <a class="code" href="classflair_1_1gui_1_1_spin_box.html">gui::SpinBox</a> *gain, *range;</div>
     156<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;  uint16_t address;</div>
     157<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;  <a class="code" href="classflair_1_1core_1_1_i2c_port.html">core::I2cPort</a> *i2cport;</div>
     158<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;};</div>
     159<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;} <span class="comment">// end namespace sensor</span></div>
     160<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;} <span class="comment">// end namespace flair</span></div>
     161<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="preprocessor">#endif // SRF08_H</span></div>
    164162<div class="ttc" id="classflair_1_1core_1_1io__data_html"><div class="ttname"><a href="classflair_1_1core_1_1io__data.html">flair::core::io_data</a></div><div class="ttdoc">Abstract class for data types. </div><div class="ttdef"><b>Definition:</b> io_data.h:94</div></div>
    165 <div class="ttc" id="classflair_1_1sensor_1_1_srf08_html"><div class="ttname"><a href="classflair_1_1sensor_1_1_srf08.html">flair::sensor::Srf08</a></div><div class="ttdoc">Class for ultra sonic SRF08. </div><div class="ttdef"><b>Definition:</b> Srf08.h:36</div></div>
     163<div class="ttc" id="classflair_1_1sensor_1_1_srf08_html"><div class="ttname"><a href="classflair_1_1sensor_1_1_srf08.html">flair::sensor::Srf08</a></div><div class="ttdoc">Class for ultra sonic SRF08. </div><div class="ttdef"><b>Definition:</b> Srf08.h:34</div></div>
    166164<div class="ttc" id="namespaceflair_html"><div class="ttname"><a href="namespaceflair.html">flair</a></div><div class="ttdoc">namespace of the flair Framework </div><div class="ttdef"><b>Definition:</b> Ahrs.h:19</div></div>
    167165<div class="ttc" id="classflair_1_1sensor_1_1_srf08_html_ae760771d1ec4ede8ec0a901c5e178b32"><div class="ttname"><a href="classflair_1_1sensor_1_1_srf08.html#ae760771d1ec4ede8ec0a901c5e178b32">flair::sensor::Srf08::SetRange</a></div><div class="ttdeci">void SetRange(void)</div><div class="ttdoc">Set Range. </div></div>
    … …  
    171169<div class="ttc" id="classflair_1_1sensor_1_1_srf08_html_a29851770b97852246643187224054a14"><div class="ttname"><a href="classflair_1_1sensor_1_1_srf08.html#a29851770b97852246643187224054a14">flair::sensor::Srf08::SetMaxGain</a></div><div class="ttdeci">void SetMaxGain(void)</div><div class="ttdoc">Set Max Gain. </div></div>
    172170<div class="ttc" id="_us_range_finder_8h_html"><div class="ttname"><a href="_us_range_finder_8h.html">UsRangeFinder.h</a></div><div class="ttdoc">Base class for UsRangeFinder. </div></div>
    173 <div class="ttc" id="classflair_1_1core_1_1_framework_manager_html"><div class="ttname"><a href="classflair_1_1core_1_1_framework_manager.html">flair::core::FrameworkManager</a></div><div class="ttdoc">Main class of the Framework library. </div><div class="ttdef"><b>Definition:</b> FrameworkManager.h:45</div></div>
     171<div class="ttc" id="classflair_1_1sensor_1_1_srf08_html_a6b4c56ab2d67af7bf65dd632d9b26746"><div class="ttname"><a href="classflair_1_1sensor_1_1_srf08.html#a6b4c56ab2d67af7bf65dd632d9b26746">flair::sensor::Srf08::Srf08</a></div><div class="ttdeci">Srf08(std::string name, core::I2cPort *i2cport, uint16_t address, uint8_t priority)</div><div class="ttdoc">Constructor. </div></div>
    174172<div class="ttc" id="_thread_8h_html"><div class="ttname"><a href="_thread_8h.html">Thread.h</a></div><div class="ttdoc">Abstract class for a thread. </div></div>
    175173<div class="ttc" id="classflair_1_1core_1_1_thread_html"><div class="ttname"><a href="classflair_1_1core_1_1_thread.html">flair::core::Thread</a></div><div class="ttdoc">Abstract class for a thread. </div><div class="ttdef"><b>Definition:</b> Thread.h:38</div></div>
    176 <div class="ttc" id="classflair_1_1sensor_1_1_srf08_html_ad4a67e82a8c599941b38d1e3e9861c62"><div class="ttname"><a href="classflair_1_1sensor_1_1_srf08.html#ad4a67e82a8c599941b38d1e3e9861c62">flair::sensor::Srf08::Srf08</a></div><div class="ttdeci">Srf08(const core::FrameworkManager *parent, std::string name, core::I2cPort *i2cport, uint16_t address, uint8_t priority)</div><div class="ttdoc">Constructor. </div></div>
    177174<div class="ttc" id="classflair_1_1core_1_1_i2c_port_html"><div class="ttname"><a href="classflair_1_1core_1_1_i2c_port.html">flair::core::I2cPort</a></div><div class="ttdoc">Base class for i2c port. </div><div class="ttdef"><b>Definition:</b> I2cPort.h:31</div></div>
    178175<div class="ttc" id="classflair_1_1sensor_1_1_srf08_html_a98bf852157fdae881576d0b7f25da6b0"><div class="ttname"><a href="classflair_1_1sensor_1_1_srf08.html#a98bf852157fdae881576d0b7f25da6b0">flair::sensor::Srf08::~Srf08</a></div><div class="ttdeci">~Srf08()</div><div class="ttdoc">Destructor. </div></div>
    … …  
    183180  <ul>
    184181    <li class="navelem"><a class="el" href="dir_33c2ee9b1665499374b4225c427cf176.html">igep</a></li><li class="navelem"><a class="el" href="dir_f1fe274389177bd7e17de7949c4ffada.html">flair-src</a></li><li class="navelem"><a class="el" href="dir_3ef62148cf94871b4b6ee5d6e3a989c1.html">lib</a></li><li class="navelem"><a class="el" href="dir_6e0f9c50eed172896c55a6e61952176b.html">FlairSensorActuator</a></li><li class="navelem"><a class="el" href="dir_c5d95abdcafe7d1171548eb561d7ce37.html">src</a></li><li class="navelem"><a class="el" href="_srf08_8h.html">Srf08.h</a></li>
    185     <li class="footer">Generated on Tue Jan 17 2017 09:52:30 for Flair by
     182    <li class="footer">Generated on Wed May 31 2017 13:50:37 for Flair by
    186183    <a href="http://www.doxygen.org/index.html">
    187184    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
Note: See TracChangeset for help on using the changeset viewer.