source: flair-dev/trunk/doc/Flair/classflair_1_1core_1_1_i2c_port.html @ 16

Last change on this file since 16 was 16, checked in by Sanahuja Guillaume, 5 years ago

complementary filter

File size: 34.8 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.7"/>
7<title>Flair: flair::core::I2cPort Class Reference</title>
8<link href="tabs.css" rel="stylesheet" type="text/css"/>
9<script type="text/javascript" src="jquery.js"></script>
10<script type="text/javascript" src="dynsections.js"></script>
11<link href="navtree.css" rel="stylesheet" type="text/css"/>
12<script type="text/javascript" src="resize.js"></script>
13<script type="text/javascript" src="navtree.js"></script>
14<script type="text/javascript">
15  $(document).ready(initResizable);
16  $(window).load(resizeHeight);
17</script>
18<link href="search/search.css" rel="stylesheet" type="text/css"/>
19<script type="text/javascript" src="search/search.js"></script>
20<script type="text/javascript">
21  $(document).ready(function() { searchBox.OnSelectItem(0); });
22</script>
23<link href="doxygen.css" rel="stylesheet" type="text/css" />
24</head>
25<body>
26<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
27<div id="titlearea">
28<table cellspacing="0" cellpadding="0">
29 <tbody>
30 <tr style="height: 56px;">
31  <td id="projectlogo"><img alt="Logo" src="logo_hds.png"/></td>
32  <td style="padding-left: 0.5em;">
33   <div id="projectname">Flair
34   </div>
35   <div id="projectbrief">Framework Libre Air</div>
36  </td>
37 </tr>
38 </tbody>
39</table>
40</div>
41<!-- end header part -->
42<!-- Generated by Doxygen 1.8.7 -->
43<script type="text/javascript">
44var searchBox = new SearchBox("searchBox", "search",false,'Search');
45</script>
46  <div id="navrow1" class="tabs">
47    <ul class="tablist">
48      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
49      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
50      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
51      <li><a href="files.html"><span>Files</span></a></li>
52      <li>
53        <div id="MSearchBox" class="MSearchBoxInactive">
54        <span class="left">
55          <img id="MSearchSelect" src="search/mag_sel.png"
56               onmouseover="return searchBox.OnSearchSelectShow()"
57               onmouseout="return searchBox.OnSearchSelectHide()"
58               alt=""/>
59          <input type="text" id="MSearchField" value="Search" accesskey="S"
60               onfocus="searchBox.OnSearchFieldFocus(true)" 
61               onblur="searchBox.OnSearchFieldFocus(false)" 
62               onkeyup="searchBox.OnSearchFieldChange(event)"/>
63          </span><span class="right">
64            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
65          </span>
66        </div>
67      </li>
68    </ul>
69  </div>
70  <div id="navrow2" class="tabs2">
71    <ul class="tablist">
72      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
73      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
74      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
75      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
76    </ul>
77  </div>
78</div><!-- top -->
79<div id="side-nav" class="ui-resizable side-nav-resizable">
80  <div id="nav-tree">
81    <div id="nav-tree-contents">
82      <div id="nav-sync" class="sync"></div>
83    </div>
84  </div>
85  <div id="splitbar" style="-moz-user-select:none;" 
86       class="ui-resizable-handle">
87  </div>
88</div>
89<script type="text/javascript">
90$(document).ready(function(){initNavTree('classflair_1_1core_1_1_i2c_port.html','');});
91</script>
92<div id="doc-content">
93<!-- window showing the filter options -->
94<div id="MSearchSelectWindow"
95     onmouseover="return searchBox.OnSearchSelectShow()"
96     onmouseout="return searchBox.OnSearchSelectHide()"
97     onkeydown="return searchBox.OnSearchSelectKey(event)">
98<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Properties</a></div>
99
100<!-- iframe showing the search results (closed by default) -->
101<div id="MSearchResultsWindow">
102<iframe src="javascript:void(0)" frameborder="0" 
103        name="MSearchResults" id="MSearchResults">
104</iframe>
105</div>
106
107<div class="header">
108  <div class="summary">
109<a href="#pub-methods">Public Member Functions</a> &#124;
110<a href="classflair_1_1core_1_1_i2c_port-members.html">List of all members</a>  </div>
111  <div class="headertitle">
112<div class="title">flair::core::I2cPort Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
113</div><!--header-->
114<div class="contents">
115
116<p>Base class for i2c port. 
117 <a href="classflair_1_1core_1_1_i2c_port.html#details">More...</a></p>
118
119<p><code>#include &lt;<a class="el" href="_i2c_port_8h_source.html">I2cPort.h</a>&gt;</code></p>
120<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
121  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for flair::core::I2cPort:</div>
122<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
123</div>
124<div id="dynsection-0-content" class="dyncontent" style="display:none;">
125 <div class="center">
126  <img src="classflair_1_1core_1_1_i2c_port.png" usemap="#flair::core::I2cPort_map" alt=""/>
127  <map id="flair::core::I2cPort_map" name="flair::core::I2cPort_map">
128<area href="classflair_1_1core_1_1_mutex.html" title="Class defining a mutex. " alt="flair::core::Mutex" shape="rect" coords="82,56,236,80"/>
129<area href="classflair_1_1core_1_1_object.html" title="Base class for all Framework&#39;s classes. " alt="flair::core::Object" shape="rect" coords="82,0,236,24"/>
130<area href="classflair_1_1core_1_1_r_t_d_m___i2c_port.html" title="Class for real time i2c port using RTDM. " alt="flair::core::RTDM_I2cPort" shape="rect" coords="0,168,154,192"/>
131<area href="classflair_1_1core_1_1_unix___i2c_port.html" title="Class for unix serial port. " alt="flair::core::Unix_I2cPort" shape="rect" coords="164,168,318,192"/>
132</map>
133 </div></div>
134<table class="memberdecls">
135<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
136Public Member Functions</h2></td></tr>
137<tr class="memitem:ae12b6920d11f939272b08d36409406ce"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i2c_port.html#ae12b6920d11f939272b08d36409406ce">I2cPort</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string name)</td></tr>
138<tr class="memdesc:ae12b6920d11f939272b08d36409406ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ae12b6920d11f939272b08d36409406ce">More...</a><br /></td></tr>
139<tr class="separator:ae12b6920d11f939272b08d36409406ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
140<tr class="memitem:ad48445514c3b9e02a1eda6a6595ba686"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i2c_port.html#ad48445514c3b9e02a1eda6a6595ba686">~I2cPort</a> ()</td></tr>
141<tr class="memdesc:ad48445514c3b9e02a1eda6a6595ba686"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#ad48445514c3b9e02a1eda6a6595ba686">More...</a><br /></td></tr>
142<tr class="separator:ad48445514c3b9e02a1eda6a6595ba686"><td class="memSeparator" colspan="2">&#160;</td></tr>
143<tr class="memitem:aed344676d32a7876b4514e8079fcfb39"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i2c_port.html#aed344676d32a7876b4514e8079fcfb39">SetSlave</a> (uint16_t address)=0</td></tr>
144<tr class="memdesc:aed344676d32a7876b4514e8079fcfb39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set slave's address.  <a href="#aed344676d32a7876b4514e8079fcfb39">More...</a><br /></td></tr>
145<tr class="separator:aed344676d32a7876b4514e8079fcfb39"><td class="memSeparator" colspan="2">&#160;</td></tr>
146<tr class="memitem:a851fc14390e08ba50d312a8f5395d28f"><td class="memItemLeft" align="right" valign="top">virtual ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i2c_port.html#a851fc14390e08ba50d312a8f5395d28f">Write</a> (const void *buf, size_t nbyte)=0</td></tr>
147<tr class="memdesc:a851fc14390e08ba50d312a8f5395d28f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write datas.  <a href="#a851fc14390e08ba50d312a8f5395d28f">More...</a><br /></td></tr>
148<tr class="separator:a851fc14390e08ba50d312a8f5395d28f"><td class="memSeparator" colspan="2">&#160;</td></tr>
149<tr class="memitem:a1d817db571abf2eb5de697fc476ae143"><td class="memItemLeft" align="right" valign="top">virtual ssize_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i2c_port.html#a1d817db571abf2eb5de697fc476ae143">Read</a> (void *buf, size_t nbyte)=0</td></tr>
150<tr class="memdesc:a1d817db571abf2eb5de697fc476ae143"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read datas.  <a href="#a1d817db571abf2eb5de697fc476ae143">More...</a><br /></td></tr>
151<tr class="separator:a1d817db571abf2eb5de697fc476ae143"><td class="memSeparator" colspan="2">&#160;</td></tr>
152<tr class="memitem:a70a00b4119f76bbd3525a5e7a800e774"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i2c_port.html#a70a00b4119f76bbd3525a5e7a800e774">SetRxTimeout</a> (<a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> timeout_ns)=0</td></tr>
153<tr class="memdesc:a70a00b4119f76bbd3525a5e7a800e774"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set RX timeout.  <a href="#a70a00b4119f76bbd3525a5e7a800e774">More...</a><br /></td></tr>
154<tr class="separator:a70a00b4119f76bbd3525a5e7a800e774"><td class="memSeparator" colspan="2">&#160;</td></tr>
155<tr class="memitem:ab6fd9827c2301602e5aab8b141800da1"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_i2c_port.html#ab6fd9827c2301602e5aab8b141800da1">SetTxTimeout</a> (<a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> timeout_ns)=0</td></tr>
156<tr class="memdesc:ab6fd9827c2301602e5aab8b141800da1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set TX timeout.  <a href="#ab6fd9827c2301602e5aab8b141800da1">More...</a><br /></td></tr>
157<tr class="separator:ab6fd9827c2301602e5aab8b141800da1"><td class="memSeparator" colspan="2">&#160;</td></tr>
158<tr class="inherit_header pub_methods_classflair_1_1core_1_1_mutex"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1core_1_1_mutex')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1core_1_1_mutex.html">flair::core::Mutex</a></td></tr>
159<tr class="memitem:a1f85044411d838898a794ceaeb78d8f0 inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_mutex.html#a1f85044411d838898a794ceaeb78d8f0">Mutex</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string name=&quot;&quot;)</td></tr>
160<tr class="memdesc:a1f85044411d838898a794ceaeb78d8f0 inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a1f85044411d838898a794ceaeb78d8f0">More...</a><br /></td></tr>
161<tr class="separator:a1f85044411d838898a794ceaeb78d8f0 inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="memSeparator" colspan="2">&#160;</td></tr>
162<tr class="memitem:ac8256454205d5146d1fe95b7538b25eb inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_mutex.html#ac8256454205d5146d1fe95b7538b25eb">~Mutex</a> ()</td></tr>
163<tr class="memdesc:ac8256454205d5146d1fe95b7538b25eb inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#ac8256454205d5146d1fe95b7538b25eb">More...</a><br /></td></tr>
164<tr class="separator:ac8256454205d5146d1fe95b7538b25eb inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="memSeparator" colspan="2">&#160;</td></tr>
165<tr class="memitem:a225fbd364b794d698b1c7d8c6962492b inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_mutex.html#a225fbd364b794d698b1c7d8c6962492b">GetMutex</a> (void) const </td></tr>
166<tr class="memdesc:a225fbd364b794d698b1c7d8c6962492b inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="mdescLeft">&#160;</td><td class="mdescRight">GetMutex.  <a href="#a225fbd364b794d698b1c7d8c6962492b">More...</a><br /></td></tr>
167<tr class="separator:a225fbd364b794d698b1c7d8c6962492b inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="memSeparator" colspan="2">&#160;</td></tr>
168<tr class="memitem:a1fd1e2cbcacd6a51e21da35cd26800f6 inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_mutex.html#a1fd1e2cbcacd6a51e21da35cd26800f6">ReleaseMutex</a> (void) const </td></tr>
169<tr class="memdesc:a1fd1e2cbcacd6a51e21da35cd26800f6 inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="mdescLeft">&#160;</td><td class="mdescRight">ReleaseMutex.  <a href="#a1fd1e2cbcacd6a51e21da35cd26800f6">More...</a><br /></td></tr>
170<tr class="separator:a1fd1e2cbcacd6a51e21da35cd26800f6 inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="memSeparator" colspan="2">&#160;</td></tr>
171<tr class="inherit_header pub_methods_classflair_1_1core_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1core_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
172<tr class="memitem:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#aec92383fd5bf68d9df10414862b7e95c">Object</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent=NULL, std::string name=&quot;&quot;, std::string type=&quot;&quot;)</td></tr>
173<tr class="memdesc:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#aec92383fd5bf68d9df10414862b7e95c">More...</a><br /></td></tr>
174<tr class="separator:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
175<tr class="memitem:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#aa2bde0e6677bbef705c96c93cb06ad09">~Object</a> ()</td></tr>
176<tr class="memdesc:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#aa2bde0e6677bbef705c96c93cb06ad09">More...</a><br /></td></tr>
177<tr class="separator:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
178<tr class="memitem:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a9b0344dff7e1c05424d9152c8274523a">ObjectName</a> (void) const </td></tr>
179<tr class="memdesc:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name.  <a href="#a9b0344dff7e1c05424d9152c8274523a">More...</a><br /></td></tr>
180<tr class="separator:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
181<tr class="memitem:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a609a250ec037fbcaf8957c8f1dcbfc53">ObjectType</a> (void) const </td></tr>
182<tr class="memdesc:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type.  <a href="#a609a250ec037fbcaf8957c8f1dcbfc53">More...</a><br /></td></tr>
183<tr class="separator:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
184<tr class="memitem:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a360c112cc3017a5152ebf6e84d2efa70">Parent</a> (void) const </td></tr>
185<tr class="memdesc:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parent.  <a href="#a360c112cc3017a5152ebf6e84d2efa70">More...</a><br /></td></tr>
186<tr class="separator:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
187<tr class="memitem:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::vector&lt; const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#ae22db4d723ec2d50b3ba48f26a6a770c">TypeChilds</a> (void) const </td></tr>
188<tr class="memdesc:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Childs of the same type.  <a href="#ae22db4d723ec2d50b3ba48f26a6a770c">More...</a><br /></td></tr>
189<tr class="separator:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
190<tr class="memitem:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::vector&lt; const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * &gt; *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a344f81cd35805a9501098bf727ac1a10">Childs</a> (void) const </td></tr>
191<tr class="memdesc:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Childs.  <a href="#a344f81cd35805a9501098bf727ac1a10">More...</a><br /></td></tr>
192<tr class="separator:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
193<tr class="memitem:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#af001feba14fc053aa778e61080a0b4cf">Information</a> (const char *function, int line, const char *format,...) const </td></tr>
194<tr class="memdesc:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted information.  <a href="#af001feba14fc053aa778e61080a0b4cf">More...</a><br /></td></tr>
195<tr class="separator:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
196<tr class="memitem:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a168b18451b2ee6126e1e81d452005ff6">Warning</a> (const char *function, const char *format,...) const </td></tr>
197<tr class="memdesc:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted warning.  <a href="#a168b18451b2ee6126e1e81d452005ff6">More...</a><br /></td></tr>
198<tr class="separator:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
199<tr class="memitem:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a3ca9694d29ec2b0491739879685df5ca">Error</a> (const char *function, const char *format,...) const </td></tr>
200<tr class="memdesc:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formatted error.  <a href="#a3ca9694d29ec2b0491739879685df5ca">More...</a><br /></td></tr>
201<tr class="separator:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
202<tr class="memitem:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a36cdd7f556e78b1bddd1d1fe4264bb85">ErrorOccured</a> (bool recursive=true) const </td></tr>
203<tr class="memdesc:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Has an errror occured?  <a href="#a36cdd7f556e78b1bddd1d1fe4264bb85">More...</a><br /></td></tr>
204<tr class="separator:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
205</table><table class="memberdecls">
206<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
207Additional Inherited Members</h2></td></tr>
208<tr class="inherit_header pub_types_classflair_1_1core_1_1_object"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classflair_1_1core_1_1_object')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
209<tr class="memitem:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed5fccda511f97487040fed29f4efc97"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>color_t</b> { <b>Auto</b> = 0,
210<b>Red</b> = 31,
211<b>Green</b> = 32,
212<b>Orange</b> = 33
213 }</td></tr>
214<tr class="separator:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
215</table>
216<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
217<div class="textblock"><p>Base class for i2c port. </p>
218<p>This class has a <a class="el" href="classflair_1_1core_1_1_mutex.html" title="Class defining a mutex. ">Mutex</a> which must be used to protect access to the port in case that more than one <a class="el" href="classflair_1_1core_1_1_thread.html" title="Abstract class for a thread. ">Thread</a> is using it. Lock the <a class="el" href="classflair_1_1core_1_1_mutex.html" title="Class defining a mutex. ">Mutex</a> before any communication (including SetSlave) and release it after communication. </p>
219</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
220<a class="anchor" id="ae12b6920d11f939272b08d36409406ce"></a>
221<div class="memitem">
222<div class="memproto">
223<table class="mlabels">
224  <tr>
225  <td class="mlabels-left">
226      <table class="memname">
227        <tr>
228          <td class="memname">flair::core::I2cPort::I2cPort </td>
229          <td>(</td>
230          <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *&#160;</td>
231          <td class="paramname"><em>parent</em>, </td>
232        </tr>
233        <tr>
234          <td class="paramkey"></td>
235          <td></td>
236          <td class="paramtype">std::string&#160;</td>
237          <td class="paramname"><em>name</em>&#160;</td>
238        </tr>
239        <tr>
240          <td></td>
241          <td>)</td>
242          <td></td><td></td>
243        </tr>
244      </table>
245  </td>
246  <td class="mlabels-right">
247<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
248  </tr>
249</table>
250</div><div class="memdoc">
251
252<p>Constructor. </p>
253<p>Construct an i2c port.</p>
254<dl class="params"><dt>Parameters</dt><dd>
255  <table class="params">
256    <tr><td class="paramname">parent</td><td>parent </td></tr>
257    <tr><td class="paramname">name</td><td>name </td></tr>
258  </table>
259  </dd>
260</dl>
261
262</div>
263</div>
264<a class="anchor" id="ad48445514c3b9e02a1eda6a6595ba686"></a>
265<div class="memitem">
266<div class="memproto">
267<table class="mlabels">
268  <tr>
269  <td class="mlabels-left">
270      <table class="memname">
271        <tr>
272          <td class="memname">flair::core::I2cPort::~I2cPort </td>
273          <td>(</td>
274          <td class="paramname"></td><td>)</td>
275          <td></td>
276        </tr>
277      </table>
278  </td>
279  <td class="mlabels-right">
280<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
281  </tr>
282</table>
283</div><div class="memdoc">
284
285<p>Destructor. </p>
286
287</div>
288</div>
289<h2 class="groupheader">Member Function Documentation</h2>
290<a class="anchor" id="aed344676d32a7876b4514e8079fcfb39"></a>
291<div class="memitem">
292<div class="memproto">
293<table class="mlabels">
294  <tr>
295  <td class="mlabels-left">
296      <table class="memname">
297        <tr>
298          <td class="memname">virtual int flair::core::I2cPort::SetSlave </td>
299          <td>(</td>
300          <td class="paramtype">uint16_t&#160;</td>
301          <td class="paramname"><em>address</em></td><td>)</td>
302          <td></td>
303        </tr>
304      </table>
305  </td>
306  <td class="mlabels-right">
307<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
308  </tr>
309</table>
310</div><div class="memdoc">
311
312<p>Set slave's address. </p>
313<p>This function need to be called before any communication.</p>
314<dl class="params"><dt>Parameters</dt><dd>
315  <table class="params">
316    <tr><td class="paramname">address</td><td>slave's address </td></tr>
317  </table>
318  </dd>
319</dl>
320
321<p>Implemented in <a class="el" href="classflair_1_1core_1_1_r_t_d_m___i2c_port.html#a8751f66fc59d35134094a9ac6b9f599a">flair::core::RTDM_I2cPort</a>, and <a class="el" href="classflair_1_1core_1_1_unix___i2c_port.html#a226fe4821954a937986dd55dc13ea3d8">flair::core::Unix_I2cPort</a>.</p>
322
323</div>
324</div>
325<a class="anchor" id="a851fc14390e08ba50d312a8f5395d28f"></a>
326<div class="memitem">
327<div class="memproto">
328<table class="mlabels">
329  <tr>
330  <td class="mlabels-left">
331      <table class="memname">
332        <tr>
333          <td class="memname">virtual ssize_t flair::core::I2cPort::Write </td>
334          <td>(</td>
335          <td class="paramtype">const void *&#160;</td>
336          <td class="paramname"><em>buf</em>, </td>
337        </tr>
338        <tr>
339          <td class="paramkey"></td>
340          <td></td>
341          <td class="paramtype">size_t&#160;</td>
342          <td class="paramname"><em>nbyte</em>&#160;</td>
343        </tr>
344        <tr>
345          <td></td>
346          <td>)</td>
347          <td></td><td></td>
348        </tr>
349      </table>
350  </td>
351  <td class="mlabels-right">
352<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
353  </tr>
354</table>
355</div><div class="memdoc">
356
357<p>Write datas. </p>
358<dl class="params"><dt>Parameters</dt><dd>
359  <table class="params">
360    <tr><td class="paramname">buf</td><td>pointer to datas </td></tr>
361    <tr><td class="paramname">nbyte</td><td>length of datas</td></tr>
362  </table>
363  </dd>
364</dl>
365<dl class="section return"><dt>Returns</dt><dd>amount of written datas </dd></dl>
366
367<p>Implemented in <a class="el" href="classflair_1_1core_1_1_unix___i2c_port.html#ae46ea721f4ed1283e52884dd932c42e4">flair::core::Unix_I2cPort</a>, and <a class="el" href="classflair_1_1core_1_1_r_t_d_m___i2c_port.html#a48eec923878cc0eeecac4f28b0d6db6b">flair::core::RTDM_I2cPort</a>.</p>
368
369</div>
370</div>
371<a class="anchor" id="a1d817db571abf2eb5de697fc476ae143"></a>
372<div class="memitem">
373<div class="memproto">
374<table class="mlabels">
375  <tr>
376  <td class="mlabels-left">
377      <table class="memname">
378        <tr>
379          <td class="memname">virtual ssize_t flair::core::I2cPort::Read </td>
380          <td>(</td>
381          <td class="paramtype">void *&#160;</td>
382          <td class="paramname"><em>buf</em>, </td>
383        </tr>
384        <tr>
385          <td class="paramkey"></td>
386          <td></td>
387          <td class="paramtype">size_t&#160;</td>
388          <td class="paramname"><em>nbyte</em>&#160;</td>
389        </tr>
390        <tr>
391          <td></td>
392          <td>)</td>
393          <td></td><td></td>
394        </tr>
395      </table>
396  </td>
397  <td class="mlabels-right">
398<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
399  </tr>
400</table>
401</div><div class="memdoc">
402
403<p>Read datas. </p>
404<dl class="params"><dt>Parameters</dt><dd>
405  <table class="params">
406    <tr><td class="paramname">buf</td><td>pointer to datas </td></tr>
407    <tr><td class="paramname">nbyte</td><td>length of datas</td></tr>
408  </table>
409  </dd>
410</dl>
411<dl class="section return"><dt>Returns</dt><dd>amount of read datas </dd></dl>
412
413<p>Implemented in <a class="el" href="classflair_1_1core_1_1_unix___i2c_port.html#a68edd3f3770e836a29e4c4a126310e48">flair::core::Unix_I2cPort</a>, and <a class="el" href="classflair_1_1core_1_1_r_t_d_m___i2c_port.html#afec0673b369c8c1cec9acdc13ac4a26e">flair::core::RTDM_I2cPort</a>.</p>
414
415</div>
416</div>
417<a class="anchor" id="a70a00b4119f76bbd3525a5e7a800e774"></a>
418<div class="memitem">
419<div class="memproto">
420<table class="mlabels">
421  <tr>
422  <td class="mlabels-left">
423      <table class="memname">
424        <tr>
425          <td class="memname">virtual void flair::core::I2cPort::SetRxTimeout </td>
426          <td>(</td>
427          <td class="paramtype"><a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a>&#160;</td>
428          <td class="paramname"><em>timeout_ns</em></td><td>)</td>
429          <td></td>
430        </tr>
431      </table>
432  </td>
433  <td class="mlabels-right">
434<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
435  </tr>
436</table>
437</div><div class="memdoc">
438
439<p>Set RX timeout. </p>
440<p>Timeout for waiting an ACK from the slave.</p>
441<dl class="params"><dt>Parameters</dt><dd>
442  <table class="params">
443    <tr><td class="paramname">timeout_ns</td><td>timeout in nano second </td></tr>
444  </table>
445  </dd>
446</dl>
447
448<p>Implemented in <a class="el" href="classflair_1_1core_1_1_r_t_d_m___i2c_port.html#a179f386950ddc6d0220a18e742943cfa">flair::core::RTDM_I2cPort</a>, and <a class="el" href="classflair_1_1core_1_1_unix___i2c_port.html#a7eb6ae7b58b055663cd548da7fd77b36">flair::core::Unix_I2cPort</a>.</p>
449
450</div>
451</div>
452<a class="anchor" id="ab6fd9827c2301602e5aab8b141800da1"></a>
453<div class="memitem">
454<div class="memproto">
455<table class="mlabels">
456  <tr>
457  <td class="mlabels-left">
458      <table class="memname">
459        <tr>
460          <td class="memname">virtual void flair::core::I2cPort::SetTxTimeout </td>
461          <td>(</td>
462          <td class="paramtype"><a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a>&#160;</td>
463          <td class="paramname"><em>timeout_ns</em></td><td>)</td>
464          <td></td>
465        </tr>
466      </table>
467  </td>
468  <td class="mlabels-right">
469<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
470  </tr>
471</table>
472</div><div class="memdoc">
473
474<p>Set TX timeout. </p>
475<p>Timeout for waiting an ACK from the slave.</p>
476<dl class="params"><dt>Parameters</dt><dd>
477  <table class="params">
478    <tr><td class="paramname">timeout_ns</td><td>timeout in nano second </td></tr>
479  </table>
480  </dd>
481</dl>
482
483<p>Implemented in <a class="el" href="classflair_1_1core_1_1_r_t_d_m___i2c_port.html#ac2366749d5566ff2ff4a38d744ecc207">flair::core::RTDM_I2cPort</a>, and <a class="el" href="classflair_1_1core_1_1_unix___i2c_port.html#a5bafddf9907a657fecbba03cee6854af">flair::core::Unix_I2cPort</a>.</p>
484
485</div>
486</div>
487</div><!-- contents -->
488</div><!-- doc-content -->
489<!-- start footer part -->
490<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
491  <ul>
492    <li class="navelem"><a class="el" href="namespaceflair.html">flair</a></li><li class="navelem"><a class="el" href="namespaceflair_1_1core.html">core</a></li><li class="navelem"><a class="el" href="classflair_1_1core_1_1_i2c_port.html">I2cPort</a></li>
493    <li class="footer">Generated on Thu Apr 21 2016 11:41:04 for Flair by
494    <a href="http://www.doxygen.org/index.html">
495    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
496  </ul>
497</div>
498</body>
499</html>
Note: See TracBrowser for help on using the repository browser.