source: flair-dev/trunk/doc/Flair/classflair_1_1core_1_1_r_t_d_m___i2c_port.html @ 23

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

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