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

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

m

File size: 35.5 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::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="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_r_t_d_m___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_r_t_d_m___i2c_port-members.html">List of all members</a>  </div>
111  <div class="headertitle">
112<div class="title">flair::core::RTDM_I2cPort Class Reference</div>  </div>
113</div><!--header-->
114<div class="contents">
115
116<p>Class for real time i2c port using RTDM. 
117 <a href="classflair_1_1core_1_1_r_t_d_m___i2c_port.html#details">More...</a></p>
118
119<p><code>#include &lt;<a class="el" href="_r_t_d_m___i2c_port_8h_source.html">RTDM_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::RTDM_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_r_t_d_m___i2c_port.png" usemap="#flair::core::RTDM_I2cPort_map" alt=""/>
127  <map id="flair::core::RTDM_I2cPort_map" name="flair::core::RTDM_I2cPort_map">
128<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"/>
129<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"/>
130<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"/>
131</map>
132 </div></div>
133<table class="memberdecls">
134<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
135Public Member Functions</h2></td></tr>
136<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>
137<tr class="memdesc:ac2b7d633d0dd8f7c05734a3a07faeaab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#ac2b7d633d0dd8f7c05734a3a07faeaab">More...</a><br /></td></tr>
138<tr class="separator:ac2b7d633d0dd8f7c05734a3a07faeaab"><td class="memSeparator" colspan="2">&#160;</td></tr>
139<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>
140<tr class="memdesc:a717595187752b01a836571c9c4babf40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a717595187752b01a836571c9c4babf40">More...</a><br /></td></tr>
141<tr class="separator:a717595187752b01a836571c9c4babf40"><td class="memSeparator" colspan="2">&#160;</td></tr>
142<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>
143<tr class="memdesc:a8751f66fc59d35134094a9ac6b9f599a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set slave's address.  <a href="#a8751f66fc59d35134094a9ac6b9f599a">More...</a><br /></td></tr>
144<tr class="separator:a8751f66fc59d35134094a9ac6b9f599a"><td class="memSeparator" colspan="2">&#160;</td></tr>
145<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>
146<tr class="memdesc:a48eec923878cc0eeecac4f28b0d6db6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write datas.  <a href="#a48eec923878cc0eeecac4f28b0d6db6b">More...</a><br /></td></tr>
147<tr class="separator:a48eec923878cc0eeecac4f28b0d6db6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
148<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>
149<tr class="memdesc:afec0673b369c8c1cec9acdc13ac4a26e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read datas.  <a href="#afec0673b369c8c1cec9acdc13ac4a26e">More...</a><br /></td></tr>
150<tr class="separator:afec0673b369c8c1cec9acdc13ac4a26e"><td class="memSeparator" colspan="2">&#160;</td></tr>
151<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>
152<tr class="memdesc:a179f386950ddc6d0220a18e742943cfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set RX timeout.  <a href="#a179f386950ddc6d0220a18e742943cfa">More...</a><br /></td></tr>
153<tr class="separator:a179f386950ddc6d0220a18e742943cfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
154<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>
155<tr class="memdesc:ac2366749d5566ff2ff4a38d744ecc207"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set TX timeout.  <a href="#ac2366749d5566ff2ff4a38d744ecc207">More...</a><br /></td></tr>
156<tr class="separator:ac2366749d5566ff2ff4a38d744ecc207"><td class="memSeparator" colspan="2">&#160;</td></tr>
157<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>
158<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>
159<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>
160<tr class="separator:ae12b6920d11f939272b08d36409406ce inherit pub_methods_classflair_1_1core_1_1_i2c_port"><td class="memSeparator" colspan="2">&#160;</td></tr>
161<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>
162<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>
163<tr class="separator:ad48445514c3b9e02a1eda6a6595ba686 inherit pub_methods_classflair_1_1core_1_1_i2c_port"><td class="memSeparator" colspan="2">&#160;</td></tr>
164<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>
165<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>
166<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>
167<tr class="separator:a1f85044411d838898a794ceaeb78d8f0 inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="memSeparator" colspan="2">&#160;</td></tr>
168<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>
169<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>
170<tr class="separator:ac8256454205d5146d1fe95b7538b25eb inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="memSeparator" colspan="2">&#160;</td></tr>
171<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>
172<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>
173<tr class="separator:a225fbd364b794d698b1c7d8c6962492b inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="memSeparator" colspan="2">&#160;</td></tr>
174<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>
175<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>
176<tr class="separator:a1fd1e2cbcacd6a51e21da35cd26800f6 inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="memSeparator" colspan="2">&#160;</td></tr>
177<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>
178<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>
179<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>
180<tr class="separator:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
181<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>
182<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>
183<tr class="separator:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
184<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>
185<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>
186<tr class="separator:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
187<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>
188<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>
189<tr class="separator:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
190<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>
191<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>
192<tr class="separator:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
193<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>
194<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>
195<tr class="separator:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
196<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>
197<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>
198<tr class="separator:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
199<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>
200<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>
201<tr class="separator:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
202<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>
203<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>
204<tr class="separator:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
205<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>
206<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>
207<tr class="separator:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
208<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>
209<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>
210<tr class="separator:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
211</table><table class="memberdecls">
212<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
213Additional Inherited Members</h2></td></tr>
214<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>
215<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,
216<b>Red</b> = 31,
217<b>Green</b> = 32,
218<b>Orange</b> = 33
219 }</td></tr>
220<tr class="separator:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
221</table>
222<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
223<div class="textblock"><p>Class for real time i2c port using RTDM. </p>
224<p>Class for unix serial port.</p>
225<p>This class can only be used with the real time version of Framework library. </p>
226</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
227<a class="anchor" id="ac2b7d633d0dd8f7c05734a3a07faeaab"></a>
228<div class="memitem">
229<div class="memproto">
230      <table class="memname">
231        <tr>
232          <td class="memname">flair::core::RTDM_I2cPort::RTDM_I2cPort </td>
233          <td>(</td>
234          <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *&#160;</td>
235          <td class="paramname"><em>parent</em>, </td>
236        </tr>
237        <tr>
238          <td class="paramkey"></td>
239          <td></td>
240          <td class="paramtype">std::string&#160;</td>
241          <td class="paramname"><em>name</em>, </td>
242        </tr>
243        <tr>
244          <td class="paramkey"></td>
245          <td></td>
246          <td class="paramtype">std::string&#160;</td>
247          <td class="paramname"><em>device</em>&#160;</td>
248        </tr>
249        <tr>
250          <td></td>
251          <td>)</td>
252          <td></td><td></td>
253        </tr>
254      </table>
255</div><div class="memdoc">
256
257<p>Constructor. </p>
258<p>Construct an RTDM i2c port, with the following default values: <br />
259</p><ul>
260<li>400kbits baudrate <br />
261</li>
262<li>500000ns RX timeout <br />
263</li>
264<li>1000000ns TX timeout</li>
265</ul>
266<dl class="params"><dt>Parameters</dt><dd>
267  <table class="params">
268    <tr><td class="paramname">parent</td><td>parent </td></tr>
269    <tr><td class="paramname">name</td><td>name </td></tr>
270    <tr><td class="paramname">device</td><td>i2c device (ex rti2c1) </td></tr>
271  </table>
272  </dd>
273</dl>
274
275</div>
276</div>
277<a class="anchor" id="a717595187752b01a836571c9c4babf40"></a>
278<div class="memitem">
279<div class="memproto">
280      <table class="memname">
281        <tr>
282          <td class="memname">flair::core::RTDM_I2cPort::~RTDM_I2cPort </td>
283          <td>(</td>
284          <td class="paramname"></td><td>)</td>
285          <td></td>
286        </tr>
287      </table>
288</div><div class="memdoc">
289
290<p>Destructor. </p>
291
292</div>
293</div>
294<h2 class="groupheader">Member Function Documentation</h2>
295<a class="anchor" id="a8751f66fc59d35134094a9ac6b9f599a"></a>
296<div class="memitem">
297<div class="memproto">
298<table class="mlabels">
299  <tr>
300  <td class="mlabels-left">
301      <table class="memname">
302        <tr>
303          <td class="memname">int flair::core::RTDM_I2cPort::SetSlave </td>
304          <td>(</td>
305          <td class="paramtype">uint16_t&#160;</td>
306          <td class="paramname"><em>address</em></td><td>)</td>
307          <td></td>
308        </tr>
309      </table>
310  </td>
311  <td class="mlabels-right">
312<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
313  </tr>
314</table>
315</div><div class="memdoc">
316
317<p>Set slave's address. </p>
318<p>This method need to be called before any communication.</p>
319<dl class="params"><dt>Parameters</dt><dd>
320  <table class="params">
321    <tr><td class="paramname">address</td><td>slave's address </td></tr>
322  </table>
323  </dd>
324</dl>
325
326<p>Implements <a class="el" href="classflair_1_1core_1_1_i2c_port.html#aed344676d32a7876b4514e8079fcfb39">flair::core::I2cPort</a>.</p>
327
328</div>
329</div>
330<a class="anchor" id="a48eec923878cc0eeecac4f28b0d6db6b"></a>
331<div class="memitem">
332<div class="memproto">
333<table class="mlabels">
334  <tr>
335  <td class="mlabels-left">
336      <table class="memname">
337        <tr>
338          <td class="memname">ssize_t flair::core::RTDM_I2cPort::Write </td>
339          <td>(</td>
340          <td class="paramtype">const void *&#160;</td>
341          <td class="paramname"><em>buf</em>, </td>
342        </tr>
343        <tr>
344          <td class="paramkey"></td>
345          <td></td>
346          <td class="paramtype">size_t&#160;</td>
347          <td class="paramname"><em>nbyte</em>&#160;</td>
348        </tr>
349        <tr>
350          <td></td>
351          <td>)</td>
352          <td></td><td></td>
353        </tr>
354      </table>
355  </td>
356  <td class="mlabels-right">
357<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
358  </tr>
359</table>
360</div><div class="memdoc">
361
362<p>Write datas. </p>
363<dl class="params"><dt>Parameters</dt><dd>
364  <table class="params">
365    <tr><td class="paramname">buf</td><td>pointer to datas </td></tr>
366    <tr><td class="paramname">nbyte</td><td>length of datas</td></tr>
367  </table>
368  </dd>
369</dl>
370<dl class="section return"><dt>Returns</dt><dd>amount of written datas </dd></dl>
371
372<p>Implements <a class="el" href="classflair_1_1core_1_1_i2c_port.html#a851fc14390e08ba50d312a8f5395d28f">flair::core::I2cPort</a>.</p>
373
374</div>
375</div>
376<a class="anchor" id="afec0673b369c8c1cec9acdc13ac4a26e"></a>
377<div class="memitem">
378<div class="memproto">
379<table class="mlabels">
380  <tr>
381  <td class="mlabels-left">
382      <table class="memname">
383        <tr>
384          <td class="memname">ssize_t flair::core::RTDM_I2cPort::Read </td>
385          <td>(</td>
386          <td class="paramtype">void *&#160;</td>
387          <td class="paramname"><em>buf</em>, </td>
388        </tr>
389        <tr>
390          <td class="paramkey"></td>
391          <td></td>
392          <td class="paramtype">size_t&#160;</td>
393          <td class="paramname"><em>nbyte</em>&#160;</td>
394        </tr>
395        <tr>
396          <td></td>
397          <td>)</td>
398          <td></td><td></td>
399        </tr>
400      </table>
401  </td>
402  <td class="mlabels-right">
403<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
404  </tr>
405</table>
406</div><div class="memdoc">
407
408<p>Read datas. </p>
409<dl class="params"><dt>Parameters</dt><dd>
410  <table class="params">
411    <tr><td class="paramname">buf</td><td>pointer to datas </td></tr>
412    <tr><td class="paramname">nbyte</td><td>length of datas</td></tr>
413  </table>
414  </dd>
415</dl>
416<dl class="section return"><dt>Returns</dt><dd>amount of read datas </dd></dl>
417
418<p>Implements <a class="el" href="classflair_1_1core_1_1_i2c_port.html#a1d817db571abf2eb5de697fc476ae143">flair::core::I2cPort</a>.</p>
419
420</div>
421</div>
422<a class="anchor" id="a179f386950ddc6d0220a18e742943cfa"></a>
423<div class="memitem">
424<div class="memproto">
425<table class="mlabels">
426  <tr>
427  <td class="mlabels-left">
428      <table class="memname">
429        <tr>
430          <td class="memname">void flair::core::RTDM_I2cPort::SetRxTimeout </td>
431          <td>(</td>
432          <td class="paramtype"><a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a>&#160;</td>
433          <td class="paramname"><em>timeout_ns</em></td><td>)</td>
434          <td></td>
435        </tr>
436      </table>
437  </td>
438  <td class="mlabels-right">
439<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
440  </tr>
441</table>
442</div><div class="memdoc">
443
444<p>Set RX timeout. </p>
445<p>Timeout for waiting an ACK from the slave.</p>
446<dl class="params"><dt>Parameters</dt><dd>
447  <table class="params">
448    <tr><td class="paramname">timeout_ns</td><td>timeout in nano second </td></tr>
449  </table>
450  </dd>
451</dl>
452
453<p>Implements <a class="el" href="classflair_1_1core_1_1_i2c_port.html#a70a00b4119f76bbd3525a5e7a800e774">flair::core::I2cPort</a>.</p>
454
455</div>
456</div>
457<a class="anchor" id="ac2366749d5566ff2ff4a38d744ecc207"></a>
458<div class="memitem">
459<div class="memproto">
460<table class="mlabels">
461  <tr>
462  <td class="mlabels-left">
463      <table class="memname">
464        <tr>
465          <td class="memname">void flair::core::RTDM_I2cPort::SetTxTimeout </td>
466          <td>(</td>
467          <td class="paramtype"><a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a>&#160;</td>
468          <td class="paramname"><em>timeout_ns</em></td><td>)</td>
469          <td></td>
470        </tr>
471      </table>
472  </td>
473  <td class="mlabels-right">
474<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
475  </tr>
476</table>
477</div><div class="memdoc">
478
479<p>Set TX timeout. </p>
480<p>Timeout for waiting an ACK from the slave.</p>
481<dl class="params"><dt>Parameters</dt><dd>
482  <table class="params">
483    <tr><td class="paramname">timeout_ns</td><td>timeout in nano second </td></tr>
484  </table>
485  </dd>
486</dl>
487
488<p>Implements <a class="el" href="classflair_1_1core_1_1_i2c_port.html#ab6fd9827c2301602e5aab8b141800da1">flair::core::I2cPort</a>.</p>
489
490</div>
491</div>
492</div><!-- contents -->
493</div><!-- doc-content -->
494<!-- start footer part -->
495<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
496  <ul>
497    <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>
498    <li class="footer">Generated on Wed Apr 20 2016 16:16:00 for Flair by
499    <a href="http://www.doxygen.org/index.html">
500    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
501  </ul>
502</div>
503</body>
504</html>
Note: See TracBrowser for help on using the repository browser.