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

Last change on this file was 100, checked in by Sanahuja Guillaume, 22 months ago

doc

File size: 13.8 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6<meta name="generator" content="Doxygen 1.8.9.1"/>
7<title>Flair: ConditionVariable.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
53      <li class="current"><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="files.html"><span>File&#160;List</span></a></li>
75    </ul>
76  </div>
77</div><!-- top -->
78<div id="side-nav" class="ui-resizable side-nav-resizable">
79  <div id="nav-tree">
80    <div id="nav-tree-contents">
81      <div id="nav-sync" class="sync"></div>
82    </div>
83  </div>
84  <div id="splitbar" style="-moz-user-select:none;" 
85       class="ui-resizable-handle">
86  </div>
87</div>
88<script type="text/javascript">
89$(document).ready(function(){initNavTree('_condition_variable_8h_source.html','');});
90</script>
91<div id="doc-content">
92<!-- window showing the filter options -->
93<div id="MSearchSelectWindow"
94     onmouseover="return searchBox.OnSearchSelectShow()"
95     onmouseout="return searchBox.OnSearchSelectHide()"
96     onkeydown="return searchBox.OnSearchSelectKey(event)">
97</div>
98
99<!-- iframe showing the search results (closed by default) -->
100<div id="MSearchResultsWindow">
101<iframe src="javascript:void(0)" frameborder="0" 
102        name="MSearchResults" id="MSearchResults">
103</iframe>
104</div>
105
106<div class="header">
107  <div class="headertitle">
108<div class="title">ConditionVariable.h</div>  </div>
109</div><!--header-->
110<div class="contents">
111<a href="_condition_variable_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">// %flair:license{</span></div>
112<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">// This file is part of the Flair framework distributed under the</span></div>
113<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">// CECILL-C License, Version 1.0.</span></div>
114<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">// %flair:license}</span></div>
115<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"></span><span class="preprocessor">#ifndef CONDITIONVARIABLE_H</span></div>
116<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#define CONDITIONVARIABLE_H</span></div>
117<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div>
118<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="_mutex_8h.html">Mutex.h</a>&gt;</span></div>
119<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div>
120<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="keyword">class </span>ConditionVariable_impl;</div>
121<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;</div>
122<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceflair.html">flair</a> {</div>
123<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="keyword">namespace </span>core {</div>
124<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div>
125<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classflair_1_1core_1_1_condition_variable.html">   29</a></span>&#160;<span class="keyword">class </span><a class="code" href="classflair_1_1core_1_1_condition_variable.html">ConditionVariable</a> : <span class="keyword">public</span> <a class="code" href="classflair_1_1core_1_1_mutex.html">Mutex</a> {</div>
126<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="keyword">public</span>:</div>
127<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;  <a class="code" href="classflair_1_1core_1_1_condition_variable.html#a39d2c7445e468a1fa8efb62d39f7d082">ConditionVariable</a>(<span class="keyword">const</span> <a class="code" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string name);</div>
128<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;</div>
129<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;  <a class="code" href="classflair_1_1core_1_1_condition_variable.html#aa2a9990054e13bf0a94dbb19931e8e8c">~ConditionVariable</a>();</div>
130<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div>
131<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_condition_variable.html#ac51adc9331b169c336bee3497a2d2eff">CondWait</a>(<span class="keywordtype">void</span>);</div>
132<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div>
133<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;  <span class="keywordtype">bool</span> <a class="code" href="classflair_1_1core_1_1_condition_variable.html#ac70e08c0d3f2017343022c19f1ffcb63">CondWaitUntil</a>(<a class="code" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> date);</div>
134<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;</div>
135<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;  <span class="keywordtype">void</span> <a class="code" href="classflair_1_1core_1_1_condition_variable.html#abaec3da1498ecab5c9e53472eda70105">CondSignal</a>(<span class="keywordtype">void</span>);</div>
136<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;</div>
137<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="keyword">private</span>:</div>
138<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;  <span class="keyword">class </span>ConditionVariable_impl *pimpl_;</div>
139<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;};</div>
140<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;</div>
141<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;} <span class="comment">// end namespace core</span></div>
142<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;} <span class="comment">// end namespace flair</span></div>
143<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;</div>
144<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="preprocessor">#endif // CONDITIONVARIABLE_H</span></div>
145<div class="ttc" id="classflair_1_1core_1_1_condition_variable_html_ac51adc9331b169c336bee3497a2d2eff"><div class="ttname"><a href="classflair_1_1core_1_1_condition_variable.html#ac51adc9331b169c336bee3497a2d2eff">flair::core::ConditionVariable::CondWait</a></div><div class="ttdeci">void CondWait(void)</div><div class="ttdoc">Block on the condition variable. </div></div>
146<div class="ttc" id="classflair_1_1core_1_1_object_html"><div class="ttname"><a href="classflair_1_1core_1_1_object.html">flair::core::Object</a></div><div class="ttdoc">Base class for all Framework&#39;s classes. </div><div class="ttdef"><b>Definition:</b> Object.h:83</div></div>
147<div class="ttc" id="namespaceflair_html"><div class="ttname"><a href="namespaceflair.html">flair</a></div><div class="ttdoc">namespace of the flair Framework </div><div class="ttdef"><b>Definition:</b> Ahrs.h:19</div></div>
148<div class="ttc" id="classflair_1_1core_1_1_mutex_html"><div class="ttname"><a href="classflair_1_1core_1_1_mutex.html">flair::core::Mutex</a></div><div class="ttdoc">Class defining a mutex. </div><div class="ttdef"><b>Definition:</b> Mutex.h:29</div></div>
149<div class="ttc" id="namespaceflair_1_1core_html_acc0fa041e08ecf73b2d1d723c339a736"><div class="ttname"><a href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">flair::core::Time</a></div><div class="ttdeci">unsigned long long Time</div><div class="ttdoc">Time definition, in ns. </div><div class="ttdef"><b>Definition:</b> Object.h:55</div></div>
150<div class="ttc" id="classflair_1_1core_1_1_condition_variable_html_ac70e08c0d3f2017343022c19f1ffcb63"><div class="ttname"><a href="classflair_1_1core_1_1_condition_variable.html#ac70e08c0d3f2017343022c19f1ffcb63">flair::core::ConditionVariable::CondWaitUntil</a></div><div class="ttdeci">bool CondWaitUntil(Time date)</div><div class="ttdoc">Block on the condition variable with a timeout. </div></div>
151<div class="ttc" id="classflair_1_1core_1_1_condition_variable_html_a39d2c7445e468a1fa8efb62d39f7d082"><div class="ttname"><a href="classflair_1_1core_1_1_condition_variable.html#a39d2c7445e468a1fa8efb62d39f7d082">flair::core::ConditionVariable::ConditionVariable</a></div><div class="ttdeci">ConditionVariable(const Object *parent, std::string name)</div><div class="ttdoc">Constructor. </div></div>
152<div class="ttc" id="classflair_1_1core_1_1_condition_variable_html"><div class="ttname"><a href="classflair_1_1core_1_1_condition_variable.html">flair::core::ConditionVariable</a></div><div class="ttdoc">Class defining a condition variable. </div><div class="ttdef"><b>Definition:</b> ConditionVariable.h:29</div></div>
153<div class="ttc" id="_mutex_8h_html"><div class="ttname"><a href="_mutex_8h.html">Mutex.h</a></div><div class="ttdoc">Class defining a mutex. </div></div>
154<div class="ttc" id="classflair_1_1core_1_1_condition_variable_html_aa2a9990054e13bf0a94dbb19931e8e8c"><div class="ttname"><a href="classflair_1_1core_1_1_condition_variable.html#aa2a9990054e13bf0a94dbb19931e8e8c">flair::core::ConditionVariable::~ConditionVariable</a></div><div class="ttdeci">~ConditionVariable()</div><div class="ttdoc">Destructor. </div></div>
155<div class="ttc" id="classflair_1_1core_1_1_condition_variable_html_abaec3da1498ecab5c9e53472eda70105"><div class="ttname"><a href="classflair_1_1core_1_1_condition_variable.html#abaec3da1498ecab5c9e53472eda70105">flair::core::ConditionVariable::CondSignal</a></div><div class="ttdeci">void CondSignal(void)</div><div class="ttdoc">Unblock threads blocked on the condition variable. </div></div>
156</div><!-- fragment --></div><!-- contents -->
157</div><!-- doc-content -->
158<!-- start footer part -->
159<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
160  <ul>
161    <li class="navelem"><a class="el" href="dir_33c2ee9b1665499374b4225c427cf176.html">igep</a></li><li class="navelem"><a class="el" href="dir_f1fe274389177bd7e17de7949c4ffada.html">flair-src</a></li><li class="navelem"><a class="el" href="dir_3ef62148cf94871b4b6ee5d6e3a989c1.html">lib</a></li><li class="navelem"><a class="el" href="dir_97265977dbbd48c696782ccac102bad5.html">FlairCore</a></li><li class="navelem"><a class="el" href="dir_6c198461db290ac9abcdd44184573216.html">src</a></li><li class="navelem"><a class="el" href="_condition_variable_8h.html">ConditionVariable.h</a></li>
162    <li class="footer">Generated on Thu Jan 31 2019 12:34:23 for Flair by
163    <a href="http://www.doxygen.org/index.html">
164    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
165  </ul>
166</div>
167</body>
168</html>
Note: See TracBrowser for help on using the repository browser.