source: flair-dev/trunk/doc/Flair/classflair_1_1sensor_1_1_flash_led_message.html

Last change on this file was 100, checked in by Sanahuja Guillaume, 2 years ago

doc
File size: 11.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::sensor::FlashLedMessage 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_1sensor_1_1_flash_led_message.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_1sensor_1_1_flash_led_message-members.html">List of all members</a>  </div>
113  <div class="headertitle">
114<div class="title">flair::sensor::FlashLedMessage Class Reference</div>  </div>
115</div><!--header-->
116<div class="contents">
117<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
118  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for flair::sensor::FlashLedMessage:</div>
119<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
120</div>
121<div id="dynsection-0-content" class="dyncontent" style="display:none;">
122 <div class="center">
123  <img src="classflair_1_1sensor_1_1_flash_led_message.png" usemap="#flair::sensor::FlashLedMessage_map" alt=""/>
124  <map id="flair::sensor::FlashLedMessage_map" name="flair::sensor::FlashLedMessage_map">
125<area href="classflair_1_1core_1_1_message.html" alt="flair::core::Message" shape="rect" coords="0,0,187,24"/>
126</map>
127 </div></div>
128<table class="memberdecls">
129<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
130Public Member Functions</h2></td></tr>
131<tr class="memitem:a5e8fb37f1a82d0255a260204cdd085b9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e8fb37f1a82d0255a260204cdd085b9"></a>
132&#160;</td><td class="memItemRight" valign="bottom"><b>FlashLedMessage</b> (unsigned int ledId, unsigned int onTime, unsigned int offTime)</td></tr>
133<tr class="separator:a5e8fb37f1a82d0255a260204cdd085b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
134<tr class="memitem:ad840551f024923bd05377309325c3818"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad840551f024923bd05377309325c3818"></a>
135unsigned int&#160;</td><td class="memItemRight" valign="bottom"><b>GetLedId</b> () const </td></tr>
136<tr class="separator:ad840551f024923bd05377309325c3818"><td class="memSeparator" colspan="2">&#160;</td></tr>
137<tr class="memitem:ae87db92821e34830b2036f64768abb73"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae87db92821e34830b2036f64768abb73"></a>
138unsigned int&#160;</td><td class="memItemRight" valign="bottom"><b>GetOnTime</b> () const </td></tr>
139<tr class="separator:ae87db92821e34830b2036f64768abb73"><td class="memSeparator" colspan="2">&#160;</td></tr>
140<tr class="memitem:a5aaed6a248e169071835b298f72f782d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5aaed6a248e169071835b298f72f782d"></a>
141unsigned int&#160;</td><td class="memItemRight" valign="bottom"><b>GetOffTime</b> () const </td></tr>
142<tr class="separator:a5aaed6a248e169071835b298f72f782d"><td class="memSeparator" colspan="2">&#160;</td></tr>
143<tr class="memitem:a367fde4136d68ef436843b0f4c75cc11"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a367fde4136d68ef436843b0f4c75cc11"></a>
144void&#160;</td><td class="memItemRight" valign="bottom"><b>SetLedId</b> (unsigned int ledId)</td></tr>
145<tr class="separator:a367fde4136d68ef436843b0f4c75cc11"><td class="memSeparator" colspan="2">&#160;</td></tr>
146<tr class="memitem:a4be9127272a2911f14282f6cebabb709"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4be9127272a2911f14282f6cebabb709"></a>
147void&#160;</td><td class="memItemRight" valign="bottom"><b>SetOnTime</b> (unsigned int onTime)</td></tr>
148<tr class="separator:a4be9127272a2911f14282f6cebabb709"><td class="memSeparator" colspan="2">&#160;</td></tr>
149<tr class="memitem:a5f0302b5fb3f1ef552ebeb473008aa9b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f0302b5fb3f1ef552ebeb473008aa9b"></a>
150void&#160;</td><td class="memItemRight" valign="bottom"><b>SetOffTime</b> (unsigned int offTime)</td></tr>
151<tr class="separator:a5f0302b5fb3f1ef552ebeb473008aa9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
152<tr class="inherit_header pub_methods_classflair_1_1core_1_1_message"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classflair_1_1core_1_1_message')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classflair_1_1core_1_1_message.html">flair::core::Message</a></td></tr>
153<tr class="memitem:a4730ff306a69775b23d9817b55cd16f2 inherit pub_methods_classflair_1_1core_1_1_message"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4730ff306a69775b23d9817b55cd16f2"></a>
154&#160;</td><td class="memItemRight" valign="bottom"><b>Message</b> (unsigned int myBufferSize)</td></tr>
155<tr class="separator:a4730ff306a69775b23d9817b55cd16f2 inherit pub_methods_classflair_1_1core_1_1_message"><td class="memSeparator" colspan="2">&#160;</td></tr>
156</table><table class="memberdecls">
157<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
158Additional Inherited Members</h2></td></tr>
159<tr class="inherit_header pub_attribs_classflair_1_1core_1_1_message"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classflair_1_1core_1_1_message')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classflair_1_1core_1_1_message.html">flair::core::Message</a></td></tr>
160<tr class="memitem:a557839f1c97332640b84dbbecc15c7bd inherit pub_attribs_classflair_1_1core_1_1_message"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a557839f1c97332640b84dbbecc15c7bd"></a>
161char *&#160;</td><td class="memItemRight" valign="bottom"><b>buffer</b></td></tr>
162<tr class="separator:a557839f1c97332640b84dbbecc15c7bd inherit pub_attribs_classflair_1_1core_1_1_message"><td class="memSeparator" colspan="2">&#160;</td></tr>
163<tr class="memitem:a1bd8cab75ae376ed12f83a291f767d8f inherit pub_attribs_classflair_1_1core_1_1_message"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1bd8cab75ae376ed12f83a291f767d8f"></a>
164size_t&#160;</td><td class="memItemRight" valign="bottom"><b>bufferSize</b></td></tr>
165<tr class="separator:a1bd8cab75ae376ed12f83a291f767d8f inherit pub_attribs_classflair_1_1core_1_1_message"><td class="memSeparator" colspan="2">&#160;</td></tr>
166</table>
167</div><!-- contents -->
168</div><!-- doc-content -->
169<!-- start footer part -->
170<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
171  <ul>
172    <li class="navelem"><a class="el" href="namespaceflair.html">flair</a></li><li class="navelem"><a class="el" href="namespaceflair_1_1sensor.html">sensor</a></li><li class="navelem"><a class="el" href="classflair_1_1sensor_1_1_flash_led_message.html">FlashLedMessage</a></li>
173    <li class="footer">Generated on Thu Jan 31 2019 12:34:23 for Flair by
174    <a href="http://www.doxygen.org/index.html">
175    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
176  </ul>
177</div>
178</body>
179</html>
Note: See TracBrowser for help on using the repository browser.