source: flair-dev/tags/0.1.2/doc/Flair/classflair_1_1core_1_1_unix___i2c_port.html

Last change on this file was 62, checked in by Sanahuja Guillaume, 6 years ago

m

File size: 34.0 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::Unix_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_unix___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_unix___i2c_port-members.html">List of all members</a> </div>
113 <div class="headertitle">
114<div class="title">flair::core::Unix_I2cPort Class Reference</div> </div>
115</div><!--header-->
116<div class="contents">
117
118<p>Class for unix serial port.
119 <a href="classflair_1_1core_1_1_unix___i2c_port.html#details">More...</a></p>
120
121<p><code>#include &lt;<a class="el" href="_unix___i2c_port_8h_source.html">Unix_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::Unix_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_unix___i2c_port.png" usemap="#flair::core::Unix_I2cPort_map" alt=""/>
129 <map id="flair::core::Unix_I2cPort_map" name="flair::core::Unix_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,143,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,143,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,143,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:aa70ae8845327e8b5570c5bf45ba8b345"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_unix___i2c_port.html#aa70ae8845327e8b5570c5bf45ba8b345">Unix_I2cPort</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string port_name, std::string device)</td></tr>
139<tr class="memdesc:aa70ae8845327e8b5570c5bf45ba8b345"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#aa70ae8845327e8b5570c5bf45ba8b345">More...</a><br /></td></tr>
140<tr class="separator:aa70ae8845327e8b5570c5bf45ba8b345"><td class="memSeparator" colspan="2">&#160;</td></tr>
141<tr class="memitem:adfddddb16245bbf4860495035bf8acac"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_unix___i2c_port.html#adfddddb16245bbf4860495035bf8acac">~Unix_I2cPort</a> ()</td></tr>
142<tr class="memdesc:adfddddb16245bbf4860495035bf8acac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#adfddddb16245bbf4860495035bf8acac">More...</a><br /></td></tr>
143<tr class="separator:adfddddb16245bbf4860495035bf8acac"><td class="memSeparator" colspan="2">&#160;</td></tr>
144<tr class="memitem:a226fe4821954a937986dd55dc13ea3d8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_unix___i2c_port.html#a226fe4821954a937986dd55dc13ea3d8">SetSlave</a> (uint16_t address)</td></tr>
145<tr class="memdesc:a226fe4821954a937986dd55dc13ea3d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set slave's address. <a href="#a226fe4821954a937986dd55dc13ea3d8">More...</a><br /></td></tr>
146<tr class="separator:a226fe4821954a937986dd55dc13ea3d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
147<tr class="memitem:a7eb6ae7b58b055663cd548da7fd77b36"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_unix___i2c_port.html#a7eb6ae7b58b055663cd548da7fd77b36">SetRxTimeout</a> (<a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> timeout_ns)</td></tr>
148<tr class="memdesc:a7eb6ae7b58b055663cd548da7fd77b36"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set RX timeout. <a href="#a7eb6ae7b58b055663cd548da7fd77b36">More...</a><br /></td></tr>
149<tr class="separator:a7eb6ae7b58b055663cd548da7fd77b36"><td class="memSeparator" colspan="2">&#160;</td></tr>
150<tr class="memitem:a5bafddf9907a657fecbba03cee6854af"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_unix___i2c_port.html#a5bafddf9907a657fecbba03cee6854af">SetTxTimeout</a> (<a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> timeout_ns)</td></tr>
151<tr class="memdesc:a5bafddf9907a657fecbba03cee6854af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set TX timeout. <a href="#a5bafddf9907a657fecbba03cee6854af">More...</a><br /></td></tr>
152<tr class="separator:a5bafddf9907a657fecbba03cee6854af"><td class="memSeparator" colspan="2">&#160;</td></tr>
153<tr class="memitem:ae46ea721f4ed1283e52884dd932c42e4"><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_unix___i2c_port.html#ae46ea721f4ed1283e52884dd932c42e4">Write</a> (const void *buf, size_t nbyte)</td></tr>
154<tr class="memdesc:ae46ea721f4ed1283e52884dd932c42e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write datas. <a href="#ae46ea721f4ed1283e52884dd932c42e4">More...</a><br /></td></tr>
155<tr class="separator:ae46ea721f4ed1283e52884dd932c42e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
156<tr class="memitem:a68edd3f3770e836a29e4c4a126310e48"><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_unix___i2c_port.html#a68edd3f3770e836a29e4c4a126310e48">Read</a> (void *buf, size_t nbyte)</td></tr>
157<tr class="memdesc:a68edd3f3770e836a29e4c4a126310e48"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read datas. <a href="#a68edd3f3770e836a29e4c4a126310e48">More...</a><br /></td></tr>
158<tr class="separator:a68edd3f3770e836a29e4c4a126310e48"><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 unix serial port. </p>
226</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
227<a class="anchor" id="aa70ae8845327e8b5570c5bf45ba8b345"></a>
228<div class="memitem">
229<div class="memproto">
230 <table class="memname">
231 <tr>
232 <td class="memname">flair::core::Unix_I2cPort::Unix_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>port_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 unix i2c port</p>
259<dl class="params"><dt>Parameters</dt><dd>
260 <table class="params">
261 <tr><td class="paramname">parent</td><td>parent </td></tr>
262 <tr><td class="paramname">name</td><td>name </td></tr>
263 <tr><td class="paramname">device</td><td>serial device (ex /dev/i2c-1) </td></tr>
264 </table>
265 </dd>
266</dl>
267
268</div>
269</div>
270<a class="anchor" id="adfddddb16245bbf4860495035bf8acac"></a>
271<div class="memitem">
272<div class="memproto">
273 <table class="memname">
274 <tr>
275 <td class="memname">flair::core::Unix_I2cPort::~Unix_I2cPort </td>
276 <td>(</td>
277 <td class="paramname"></td><td>)</td>
278 <td></td>
279 </tr>
280 </table>
281</div><div class="memdoc">
282
283<p>Destructor. </p>
284
285</div>
286</div>
287<h2 class="groupheader">Member Function Documentation</h2>
288<a class="anchor" id="a226fe4821954a937986dd55dc13ea3d8"></a>
289<div class="memitem">
290<div class="memproto">
291<table class="mlabels">
292 <tr>
293 <td class="mlabels-left">
294 <table class="memname">
295 <tr>
296 <td class="memname">int flair::core::Unix_I2cPort::SetSlave </td>
297 <td>(</td>
298 <td class="paramtype">uint16_t&#160;</td>
299 <td class="paramname"><em>address</em></td><td>)</td>
300 <td></td>
301 </tr>
302 </table>
303 </td>
304 <td class="mlabels-right">
305<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
306 </tr>
307</table>
308</div><div class="memdoc">
309
310<p>Set slave's address. </p>
311<p>This method need to be called before any communication.</p>
312<dl class="params"><dt>Parameters</dt><dd>
313 <table class="params">
314 <tr><td class="paramname">address</td><td>slave's address </td></tr>
315 </table>
316 </dd>
317</dl>
318
319<p>Implements <a class="el" href="classflair_1_1core_1_1_i2c_port.html#aed344676d32a7876b4514e8079fcfb39">flair::core::I2cPort</a>.</p>
320
321</div>
322</div>
323<a class="anchor" id="a7eb6ae7b58b055663cd548da7fd77b36"></a>
324<div class="memitem">
325<div class="memproto">
326<table class="mlabels">
327 <tr>
328 <td class="mlabels-left">
329 <table class="memname">
330 <tr>
331 <td class="memname">void flair::core::Unix_I2cPort::SetRxTimeout </td>
332 <td>(</td>
333 <td class="paramtype"><a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a>&#160;</td>
334 <td class="paramname"><em>timeout_ns</em></td><td>)</td>
335 <td></td>
336 </tr>
337 </table>
338 </td>
339 <td class="mlabels-right">
340<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
341 </tr>
342</table>
343</div><div class="memdoc">
344
345<p>Set RX timeout. </p>
346<p>Timeout for waiting datas.</p>
347<dl class="params"><dt>Parameters</dt><dd>
348 <table class="params">
349 <tr><td class="paramname">timeout_ns</td><td>timeout in nano second </td></tr>
350 </table>
351 </dd>
352</dl>
353
354<p>Implements <a class="el" href="classflair_1_1core_1_1_i2c_port.html#a70a00b4119f76bbd3525a5e7a800e774">flair::core::I2cPort</a>.</p>
355
356</div>
357</div>
358<a class="anchor" id="a5bafddf9907a657fecbba03cee6854af"></a>
359<div class="memitem">
360<div class="memproto">
361<table class="mlabels">
362 <tr>
363 <td class="mlabels-left">
364 <table class="memname">
365 <tr>
366 <td class="memname">void flair::core::Unix_I2cPort::SetTxTimeout </td>
367 <td>(</td>
368 <td class="paramtype"><a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a>&#160;</td>
369 <td class="paramname"><em>timeout_ns</em></td><td>)</td>
370 <td></td>
371 </tr>
372 </table>
373 </td>
374 <td class="mlabels-right">
375<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
376 </tr>
377</table>
378</div><div class="memdoc">
379
380<p>Set TX timeout. </p>
381<p>Timeout for waiting an ACK from the slave.</p>
382<dl class="params"><dt>Parameters</dt><dd>
383 <table class="params">
384 <tr><td class="paramname">timeout_ns</td><td>timeout in nano second </td></tr>
385 </table>
386 </dd>
387</dl>
388
389<p>Implements <a class="el" href="classflair_1_1core_1_1_i2c_port.html#ab6fd9827c2301602e5aab8b141800da1">flair::core::I2cPort</a>.</p>
390
391</div>
392</div>
393<a class="anchor" id="ae46ea721f4ed1283e52884dd932c42e4"></a>
394<div class="memitem">
395<div class="memproto">
396<table class="mlabels">
397 <tr>
398 <td class="mlabels-left">
399 <table class="memname">
400 <tr>
401 <td class="memname">ssize_t flair::core::Unix_I2cPort::Write </td>
402 <td>(</td>
403 <td class="paramtype">const void *&#160;</td>
404 <td class="paramname"><em>buf</em>, </td>
405 </tr>
406 <tr>
407 <td class="paramkey"></td>
408 <td></td>
409 <td class="paramtype">size_t&#160;</td>
410 <td class="paramname"><em>nbyte</em>&#160;</td>
411 </tr>
412 <tr>
413 <td></td>
414 <td>)</td>
415 <td></td><td></td>
416 </tr>
417 </table>
418 </td>
419 <td class="mlabels-right">
420<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
421 </tr>
422</table>
423</div><div class="memdoc">
424
425<p>Write datas. </p>
426<dl class="params"><dt>Parameters</dt><dd>
427 <table class="params">
428 <tr><td class="paramname">buf</td><td>pointer to datas </td></tr>
429 <tr><td class="paramname">nbyte</td><td>length of datas</td></tr>
430 </table>
431 </dd>
432</dl>
433<dl class="section return"><dt>Returns</dt><dd>amount of written datas </dd></dl>
434
435<p>Implements <a class="el" href="classflair_1_1core_1_1_i2c_port.html#a851fc14390e08ba50d312a8f5395d28f">flair::core::I2cPort</a>.</p>
436
437</div>
438</div>
439<a class="anchor" id="a68edd3f3770e836a29e4c4a126310e48"></a>
440<div class="memitem">
441<div class="memproto">
442<table class="mlabels">
443 <tr>
444 <td class="mlabels-left">
445 <table class="memname">
446 <tr>
447 <td class="memname">ssize_t flair::core::Unix_I2cPort::Read </td>
448 <td>(</td>
449 <td class="paramtype">void *&#160;</td>
450 <td class="paramname"><em>buf</em>, </td>
451 </tr>
452 <tr>
453 <td class="paramkey"></td>
454 <td></td>
455 <td class="paramtype">size_t&#160;</td>
456 <td class="paramname"><em>nbyte</em>&#160;</td>
457 </tr>
458 <tr>
459 <td></td>
460 <td>)</td>
461 <td></td><td></td>
462 </tr>
463 </table>
464 </td>
465 <td class="mlabels-right">
466<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
467 </tr>
468</table>
469</div><div class="memdoc">
470
471<p>Read datas. </p>
472<dl class="params"><dt>Parameters</dt><dd>
473 <table class="params">
474 <tr><td class="paramname">buf</td><td>pointer to datas </td></tr>
475 <tr><td class="paramname">nbyte</td><td>length of datas</td></tr>
476 </table>
477 </dd>
478</dl>
479<dl class="section return"><dt>Returns</dt><dd>amount of read datas </dd></dl>
480
481<p>Implements <a class="el" href="classflair_1_1core_1_1_i2c_port.html#a1d817db571abf2eb5de697fc476ae143">flair::core::I2cPort</a>.</p>
482
483</div>
484</div>
485</div><!-- contents -->
486</div><!-- doc-content -->
487<!-- start footer part -->
488<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
489 <ul>
490 <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_unix___i2c_port.html">Unix_I2cPort</a></li>
491 <li class="footer">Generated on Mon Dec 4 2017 11:13:44 for Flair by
492 <a href="http://www.doxygen.org/index.html">
493 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
494 </ul>
495</div>
496</body>
497</html>
Note: See TracBrowser for help on using the repository browser.