source: flair-dev/trunk/doc/Flair/classflair_1_1core_1_1_thread.html@ 16

Last change on this file since 16 was 16, checked in by Sanahuja Guillaume, 8 years ago

complementary filter
File size: 48.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.7"/>
7<title>Flair: flair::core::Thread 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_thread.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="#pub-static-methods">Static Public Member Functions</a> &#124;
111<a href="classflair_1_1core_1_1_thread-members.html">List of all members</a> </div>
112 <div class="headertitle">
113<div class="title">flair::core::Thread Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
114</div><!--header-->
115<div class="contents">
116
117<p>Abstract class for a thread.
118 <a href="classflair_1_1core_1_1_thread.html#details">More...</a></p>
119
120<p><code>#include &lt;<a class="el" href="_thread_8h_source.html">Thread.h</a>&gt;</code></p>
121<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
122 <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for flair::core::Thread:</div>
123<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
124</div>
125<div id="dynsection-0-content" class="dyncontent" style="display:none;">
126 <div class="center">
127 <img src="classflair_1_1core_1_1_thread.png" usemap="#flair::core::Thread_map" alt=""/>
128 <map id="flair::core::Thread_map" name="flair::core::Thread_map">
129<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,200,24"/>
130<area href="classflair_1_1actuator_1_1_bl_ctrl_v2__x4__speed.html" alt="flair::actuator::BlCtrlV2_x4_speed" shape="rect" coords="210,112,410,136"/>
131<area href="classflair_1_1core_1_1_watchdog.html" title="Watchdog class. " alt="flair::core::Watchdog" shape="rect" coords="210,168,410,192"/>
132<area href="classflair_1_1meta_1_1_uav_state_machine.html" title="State machine for UAV. " alt="flair::meta::UavStateMachine" shape="rect" coords="210,224,410,248"/>
133<area href="classflair_1_1sensor_1_1_gx3__25__imu.html" title="Class for 3dmgx3-25 Imu. " alt="flair::sensor::Gx3_25_imu" shape="rect" coords="210,280,410,304"/>
134<area href="classflair_1_1sensor_1_1_hokuyo_u_t_m30_lx.html" title="Classe intégrant le telemetre laser Hokuyo UTM 30lx. " alt="flair::sensor::HokuyoUTM30Lx" shape="rect" coords="210,336,410,360"/>
135<area href="classflair_1_1sensor_1_1_host_eth_controller.html" title="Base Class for host side remote controls that talks to target side through ethernet connection..." alt="flair::sensor::HostEthController" shape="rect" coords="210,392,410,416"/>
136<area href="classflair_1_1sensor_1_1_mb800.html" title="Class for mb800 gps receiver. " alt="flair::sensor::Mb800" shape="rect" coords="210,448,410,472"/>
137<area href="classflair_1_1sensor_1_1_novatel.html" title="Class for Novatel gps receiver. " alt="flair::sensor::Novatel" shape="rect" coords="210,504,410,528"/>
138<area href="classflair_1_1sensor_1_1_simu_camera.html" title="Class for a simulation camera. " alt="flair::sensor::SimuCamera" shape="rect" coords="210,560,410,584"/>
139<area href="classflair_1_1sensor_1_1_simu_gps.html" title="Class for a simulation GPS. " alt="flair::sensor::SimuGps" shape="rect" coords="210,616,410,640"/>
140<area href="classflair_1_1sensor_1_1_simu_imu.html" title="Class for a simulation Imu. " alt="flair::sensor::SimuImu" shape="rect" coords="210,672,410,696"/>
141<area href="classflair_1_1sensor_1_1_simu_laser.html" alt="flair::sensor::SimuLaser" shape="rect" coords="210,728,410,752"/>
142<area href="classflair_1_1sensor_1_1_simu_us.html" title="Class for a simulation UsRangeFinder. " alt="flair::sensor::SimuUs" shape="rect" coords="210,784,410,808"/>
143<area href="classflair_1_1sensor_1_1_srf08.html" title="Class for ultra sonic SRF08. " alt="flair::sensor::Srf08" shape="rect" coords="210,840,410,864"/>
144<area href="classflair_1_1sensor_1_1_target_controller.html" title="Base Class for target side remote controls. " alt="flair::sensor::TargetController" shape="rect" coords="210,896,410,920"/>
145<area href="classflair_1_1sensor_1_1_v4_l_camera.html" title="Base class for V4l camera. " alt="flair::sensor::V4LCamera" shape="rect" coords="210,952,410,976"/>
146<area href="classflair_1_1sensor_1_1_vrpn_client.html" title="Class to connect to a Vrpn server. " alt="flair::sensor::VrpnClient" shape="rect" coords="210,1008,410,1032"/>
147</map>
148 </div></div>
149<table class="memberdecls">
150<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
151Public Member Functions</h2></td></tr>
152<tr class="memitem:a5ef98773d91697e162ab30b89528b007"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#a5ef98773d91697e162ab30b89528b007">Thread</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string name, uint8_t priority)</td></tr>
153<tr class="memdesc:a5ef98773d91697e162ab30b89528b007"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a5ef98773d91697e162ab30b89528b007">More...</a><br /></td></tr>
154<tr class="separator:a5ef98773d91697e162ab30b89528b007"><td class="memSeparator" colspan="2">&#160;</td></tr>
155<tr class="memitem:a39ede97ff3addeaf48ecec09c6625655"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#a39ede97ff3addeaf48ecec09c6625655">~Thread</a> ()</td></tr>
156<tr class="memdesc:a39ede97ff3addeaf48ecec09c6625655"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#a39ede97ff3addeaf48ecec09c6625655">More...</a><br /></td></tr>
157<tr class="separator:a39ede97ff3addeaf48ecec09c6625655"><td class="memSeparator" colspan="2">&#160;</td></tr>
158<tr class="memitem:a5a4f0f27689ae4292f81bf45e22998a5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#a5a4f0f27689ae4292f81bf45e22998a5">Start</a> (void)</td></tr>
159<tr class="memdesc:a5a4f0f27689ae4292f81bf45e22998a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the thread. <a href="#a5a4f0f27689ae4292f81bf45e22998a5">More...</a><br /></td></tr>
160<tr class="separator:a5a4f0f27689ae4292f81bf45e22998a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
161<tr class="memitem:afa1fb0f8d5b18273394502159dd5dcef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#afa1fb0f8d5b18273394502159dd5dcef">SafeStop</a> (void)</td></tr>
162<tr class="memdesc:afa1fb0f8d5b18273394502159dd5dcef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a stop flag. <a href="#afa1fb0f8d5b18273394502159dd5dcef">More...</a><br /></td></tr>
163<tr class="separator:afa1fb0f8d5b18273394502159dd5dcef"><td class="memSeparator" colspan="2">&#160;</td></tr>
164<tr class="memitem:afcbb4a445fe287b8608b173bdc10f056"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#afcbb4a445fe287b8608b173bdc10f056">ToBeStopped</a> (void) const </td></tr>
165<tr class="memdesc:afcbb4a445fe287b8608b173bdc10f056"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set a stop flag. <a href="#afcbb4a445fe287b8608b173bdc10f056">More...</a><br /></td></tr>
166<tr class="separator:afcbb4a445fe287b8608b173bdc10f056"><td class="memSeparator" colspan="2">&#160;</td></tr>
167<tr class="memitem:aba8b31e2e4c1beccb31333beb8bd41a4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#aba8b31e2e4c1beccb31333beb8bd41a4">Join</a> (void)</td></tr>
168<tr class="memdesc:aba8b31e2e4c1beccb31333beb8bd41a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Join the thread. <a href="#aba8b31e2e4c1beccb31333beb8bd41a4">More...</a><br /></td></tr>
169<tr class="separator:aba8b31e2e4c1beccb31333beb8bd41a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
170<tr class="memitem:a581ae3bdecef47c916671a6aafec9509"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#a581ae3bdecef47c916671a6aafec9509">SetPeriodUS</a> (uint32_t period_us)</td></tr>
171<tr class="memdesc:a581ae3bdecef47c916671a6aafec9509"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the period in micro second. <a href="#a581ae3bdecef47c916671a6aafec9509">More...</a><br /></td></tr>
172<tr class="separator:a581ae3bdecef47c916671a6aafec9509"><td class="memSeparator" colspan="2">&#160;</td></tr>
173<tr class="memitem:ab58a00466581b6cf88ba28b8e2118c65"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab58a00466581b6cf88ba28b8e2118c65"></a>
174uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>GetPeriodUS</b> () const </td></tr>
175<tr class="separator:ab58a00466581b6cf88ba28b8e2118c65"><td class="memSeparator" colspan="2">&#160;</td></tr>
176<tr class="memitem:a37d13f12283d69ebd092a7cc01a7d742"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#a37d13f12283d69ebd092a7cc01a7d742">SetPeriodMS</a> (uint32_t period_ms)</td></tr>
177<tr class="memdesc:a37d13f12283d69ebd092a7cc01a7d742"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the period in milli second. <a href="#a37d13f12283d69ebd092a7cc01a7d742">More...</a><br /></td></tr>
178<tr class="separator:a37d13f12283d69ebd092a7cc01a7d742"><td class="memSeparator" colspan="2">&#160;</td></tr>
179<tr class="memitem:afaa77472d57848bed10204ee5ec1d75a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afaa77472d57848bed10204ee5ec1d75a"></a>
180uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>GetPeriodMS</b> () const </td></tr>
181<tr class="separator:afaa77472d57848bed10204ee5ec1d75a"><td class="memSeparator" colspan="2">&#160;</td></tr>
182<tr class="memitem:af892a1b3025cb842cad8e7f2a11a9526"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#af892a1b3025cb842cad8e7f2a11a9526">IsPeriodSet</a> (void)</td></tr>
183<tr class="memdesc:af892a1b3025cb842cad8e7f2a11a9526"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns if period was set. <a href="#af892a1b3025cb842cad8e7f2a11a9526">More...</a><br /></td></tr>
184<tr class="separator:af892a1b3025cb842cad8e7f2a11a9526"><td class="memSeparator" colspan="2">&#160;</td></tr>
185<tr class="memitem:a50cd2ea88d538e10a30c3e6a5286a944"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#a50cd2ea88d538e10a30c3e6a5286a944">WaitPeriod</a> (void) const </td></tr>
186<tr class="memdesc:a50cd2ea88d538e10a30c3e6a5286a944"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait the period. <a href="#a50cd2ea88d538e10a30c3e6a5286a944">More...</a><br /></td></tr>
187<tr class="separator:a50cd2ea88d538e10a30c3e6a5286a944"><td class="memSeparator" colspan="2">&#160;</td></tr>
188<tr class="memitem:a2b5b5f3cf400729419bd864b654af252"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#a2b5b5f3cf400729419bd864b654af252">WaitUpdate</a> (const <a class="el" href="classflair_1_1core_1_1_i_o_device.html">IODevice</a> *device)</td></tr>
189<tr class="memdesc:a2b5b5f3cf400729419bd864b654af252"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait update of an <a class="el" href="classflair_1_1core_1_1_i_o_device.html" title="Abstract class for input/ouput system. ">IODevice</a>. <a href="#a2b5b5f3cf400729419bd864b654af252">More...</a><br /></td></tr>
190<tr class="separator:a2b5b5f3cf400729419bd864b654af252"><td class="memSeparator" colspan="2">&#160;</td></tr>
191<tr class="memitem:a0e5fc8919ed6042e5736a5dca5ba546b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#a0e5fc8919ed6042e5736a5dca5ba546b">Suspend</a> (void)</td></tr>
192<tr class="memdesc:a0e5fc8919ed6042e5736a5dca5ba546b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Suspend the thread. <a href="#a0e5fc8919ed6042e5736a5dca5ba546b">More...</a><br /></td></tr>
193<tr class="separator:a0e5fc8919ed6042e5736a5dca5ba546b"><td class="memSeparator" colspan="2">&#160;</td></tr>
194<tr class="memitem:af93c2461c31a6c16958bc44189ab4253"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#af93c2461c31a6c16958bc44189ab4253">SuspendUntil</a> (<a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> date)</td></tr>
195<tr class="memdesc:af93c2461c31a6c16958bc44189ab4253"><td class="mdescLeft">&#160;</td><td class="mdescRight">Suspend the thread with timeout. <a href="#af93c2461c31a6c16958bc44189ab4253">More...</a><br /></td></tr>
196<tr class="separator:af93c2461c31a6c16958bc44189ab4253"><td class="memSeparator" colspan="2">&#160;</td></tr>
197<tr class="memitem:ae7c46910a801f1b16302570ad8ae9580"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#ae7c46910a801f1b16302570ad8ae9580">Resume</a> (void)</td></tr>
198<tr class="memdesc:ae7c46910a801f1b16302570ad8ae9580"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resume the thread. <a href="#ae7c46910a801f1b16302570ad8ae9580">More...</a><br /></td></tr>
199<tr class="separator:ae7c46910a801f1b16302570ad8ae9580"><td class="memSeparator" colspan="2">&#160;</td></tr>
200<tr class="memitem:adac9a6d336bdb50bcfa24c66943a355a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#adac9a6d336bdb50bcfa24c66943a355a">IsSuspended</a> (void) const </td></tr>
201<tr class="memdesc:adac9a6d336bdb50bcfa24c66943a355a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the thread suspended? <a href="#adac9a6d336bdb50bcfa24c66943a355a">More...</a><br /></td></tr>
202<tr class="separator:adac9a6d336bdb50bcfa24c66943a355a"><td class="memSeparator" colspan="2">&#160;</td></tr>
203<tr class="memitem:ac09a2d745af3dbb42371949d4c622011"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#ac09a2d745af3dbb42371949d4c622011">SleepUntil</a> (<a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> time) const </td></tr>
204<tr class="memdesc:ac09a2d745af3dbb42371949d4c622011"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sleep until absolute time. <a href="#ac09a2d745af3dbb42371949d4c622011">More...</a><br /></td></tr>
205<tr class="separator:ac09a2d745af3dbb42371949d4c622011"><td class="memSeparator" colspan="2">&#160;</td></tr>
206<tr class="memitem:a3479727dfaf2213f7866fccadb43eeb6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#a3479727dfaf2213f7866fccadb43eeb6">SleepUS</a> (uint32_t time_us) const </td></tr>
207<tr class="memdesc:a3479727dfaf2213f7866fccadb43eeb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sleep for a certain time in micro second. <a href="#a3479727dfaf2213f7866fccadb43eeb6">More...</a><br /></td></tr>
208<tr class="separator:a3479727dfaf2213f7866fccadb43eeb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
209<tr class="memitem:a501e7802d7edd7e6167d111c803b8349"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#a501e7802d7edd7e6167d111c803b8349">SleepMS</a> (uint32_t time_ms) const </td></tr>
210<tr class="memdesc:a501e7802d7edd7e6167d111c803b8349"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sleep for a cartain time in milli second. <a href="#a501e7802d7edd7e6167d111c803b8349">More...</a><br /></td></tr>
211<tr class="separator:a501e7802d7edd7e6167d111c803b8349"><td class="memSeparator" colspan="2">&#160;</td></tr>
212<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>
213<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>
214<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>
215<tr class="separator:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
216<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>
217<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>
218<tr class="separator:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
219<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>
220<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>
221<tr class="separator:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
222<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>
223<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>
224<tr class="separator:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
225<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>
226<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>
227<tr class="separator:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
228<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>
229<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>
230<tr class="separator:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
231<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>
232<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>
233<tr class="separator:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
234<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>
235<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>
236<tr class="separator:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
237<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>
238<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>
239<tr class="separator:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
240<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>
241<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>
242<tr class="separator:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
243<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>
244<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>
245<tr class="separator:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
246</table><table class="memberdecls">
247<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
248Static Public Member Functions</h2></td></tr>
249<tr class="memitem:a7fbf5ad201e7e802f0fa127891849dc9"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_thread.html#a7fbf5ad201e7e802f0fa127891849dc9">WarnUponSwitches</a> (bool enable)</td></tr>
250<tr class="memdesc:a7fbf5ad201e7e802f0fa127891849dc9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Warn if real time / non real time switches occur. <a href="#a7fbf5ad201e7e802f0fa127891849dc9">More...</a><br /></td></tr>
251<tr class="separator:a7fbf5ad201e7e802f0fa127891849dc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
252</table><table class="memberdecls">
253<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
254Additional Inherited Members</h2></td></tr>
255<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>
256<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,
257<b>Red</b> = 31,
258<b>Green</b> = 32,
259<b>Orange</b> = 33
260 }</td></tr>
261<tr class="separator:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
262</table>
263<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
264<div class="textblock"><p>Abstract class for a thread. </p>
265<p>To implement a thread, Run() method must be reimplemented. <br />
266 When <a class="el" href="classflair_1_1core_1_1_thread.html#a5a4f0f27689ae4292f81bf45e22998a5" title="Start the thread. ">Start()</a> is called, it will automatically call Run() reimplemented method. A thread can be periodic, in this case <a class="el" href="classflair_1_1core_1_1_thread.html#a50cd2ea88d538e10a30c3e6a5286a944" title="Wait the period. ">WaitPeriod()</a> will block untill period is met. <a class="el" href="classflair_1_1core_1_1_thread.html" title="Abstract class for a thread. ">Thread</a> can also e synnchronized with an <a class="el" href="classflair_1_1core_1_1_i_o_device.html" title="Abstract class for input/ouput system. ">IODevice</a>, using <a class="el" href="classflair_1_1core_1_1_thread.html#a2b5b5f3cf400729419bd864b654af252" title="Wait update of an IODevice. ">WaitUpdate()</a> method. <br />
267 <a class="el" href="classflair_1_1core_1_1_thread.html" title="Abstract class for a thread. ">Thread</a> period is by default 100ms. </p>
268</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
269<a class="anchor" id="a5ef98773d91697e162ab30b89528b007"></a>
270<div class="memitem">
271<div class="memproto">
272 <table class="memname">
273 <tr>
274 <td class="memname">flair::core::Thread::Thread </td>
275 <td>(</td>
276 <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *&#160;</td>
277 <td class="paramname"><em>parent</em>, </td>
278 </tr>
279 <tr>
280 <td class="paramkey"></td>
281 <td></td>
282 <td class="paramtype">std::string&#160;</td>
283 <td class="paramname"><em>name</em>, </td>
284 </tr>
285 <tr>
286 <td class="paramkey"></td>
287 <td></td>
288 <td class="paramtype">uint8_t&#160;</td>
289 <td class="paramname"><em>priority</em>&#160;</td>
290 </tr>
291 <tr>
292 <td></td>
293 <td>)</td>
294 <td></td><td></td>
295 </tr>
296 </table>
297</div><div class="memdoc">
298
299<p>Constructor. </p>
300<dl class="params"><dt>Parameters</dt><dd>
301 <table class="params">
302 <tr><td class="paramname">parent</td><td>parent </td></tr>
303 <tr><td class="paramname">name</td><td>name </td></tr>
304 <tr><td class="paramname">priority</td><td>priority, should be &gt;20 (&lt;20 is reserved for internal use) </td></tr>
305 </table>
306 </dd>
307</dl>
308
309</div>
310</div>
311<a class="anchor" id="a39ede97ff3addeaf48ecec09c6625655"></a>
312<div class="memitem">
313<div class="memproto">
314<table class="mlabels">
315 <tr>
316 <td class="mlabels-left">
317 <table class="memname">
318 <tr>
319 <td class="memname">virtual flair::core::Thread::~Thread </td>
320 <td>(</td>
321 <td class="paramname"></td><td>)</td>
322 <td></td>
323 </tr>
324 </table>
325 </td>
326 <td class="mlabels-right">
327<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
328 </tr>
329</table>
330</div><div class="memdoc">
331
332<p>Destructor. </p>
333<p>If thread is started, <a class="el" href="classflair_1_1core_1_1_thread.html#afa1fb0f8d5b18273394502159dd5dcef" title="Set a stop flag. ">SafeStop()</a> and <a class="el" href="classflair_1_1core_1_1_thread.html#aba8b31e2e4c1beccb31333beb8bd41a4" title="Join the thread. ">Join()</a> will be automatically called. </p>
334
335</div>
336</div>
337<h2 class="groupheader">Member Function Documentation</h2>
338<a class="anchor" id="a5a4f0f27689ae4292f81bf45e22998a5"></a>
339<div class="memitem">
340<div class="memproto">
341 <table class="memname">
342 <tr>
343 <td class="memname">void flair::core::Thread::Start </td>
344 <td>(</td>
345 <td class="paramtype">void&#160;</td>
346 <td class="paramname"></td><td>)</td>
347 <td></td>
348 </tr>
349 </table>
350</div><div class="memdoc">
351
352<p>Start the thread. </p>
353
354</div>
355</div>
356<a class="anchor" id="afa1fb0f8d5b18273394502159dd5dcef"></a>
357<div class="memitem">
358<div class="memproto">
359 <table class="memname">
360 <tr>
361 <td class="memname">void flair::core::Thread::SafeStop </td>
362 <td>(</td>
363 <td class="paramtype">void&#160;</td>
364 <td class="paramname"></td><td>)</td>
365 <td></td>
366 </tr>
367 </table>
368</div><div class="memdoc">
369
370<p>Set a stop flag. </p>
371<p><a class="el" href="classflair_1_1core_1_1_thread.html#afcbb4a445fe287b8608b173bdc10f056" title="Set a stop flag. ">ToBeStopped()</a> will return true after calling this method. </p>
372
373</div>
374</div>
375<a class="anchor" id="afcbb4a445fe287b8608b173bdc10f056"></a>
376<div class="memitem">
377<div class="memproto">
378 <table class="memname">
379 <tr>
380 <td class="memname">bool flair::core::Thread::ToBeStopped </td>
381 <td>(</td>
382 <td class="paramtype">void&#160;</td>
383 <td class="paramname"></td><td>)</td>
384 <td> const</td>
385 </tr>
386 </table>
387</div><div class="memdoc">
388
389<p>Set a stop flag. </p>
390<p>Reimplemented Run() can poll this method to determine when to stop the thread.</p>
391<dl class="section return"><dt>Returns</dt><dd>true if <a class="el" href="classflair_1_1core_1_1_thread.html#afa1fb0f8d5b18273394502159dd5dcef" title="Set a stop flag. ">SafeStop()</a> was called </dd></dl>
392
393</div>
394</div>
395<a class="anchor" id="aba8b31e2e4c1beccb31333beb8bd41a4"></a>
396<div class="memitem">
397<div class="memproto">
398 <table class="memname">
399 <tr>
400 <td class="memname">void flair::core::Thread::Join </td>
401 <td>(</td>
402 <td class="paramtype">void&#160;</td>
403 <td class="paramname"></td><td>)</td>
404 <td></td>
405 </tr>
406 </table>
407</div><div class="memdoc">
408
409<p>Join the thread. </p>
410<p>This method will block untill Run() returns. </p>
411
412</div>
413</div>
414<a class="anchor" id="a581ae3bdecef47c916671a6aafec9509"></a>
415<div class="memitem">
416<div class="memproto">
417 <table class="memname">
418 <tr>
419 <td class="memname">void flair::core::Thread::SetPeriodUS </td>
420 <td>(</td>
421 <td class="paramtype">uint32_t&#160;</td>
422 <td class="paramname"><em>period_us</em></td><td>)</td>
423 <td></td>
424 </tr>
425 </table>
426</div><div class="memdoc">
427
428<p>Set the period in micro second. </p>
429<p>After calling this method, IsPeriodSet will return true.</p>
430<dl class="params"><dt>Parameters</dt><dd>
431 <table class="params">
432 <tr><td class="paramname">period_us</td><td>period in us </td></tr>
433 </table>
434 </dd>
435</dl>
436
437</div>
438</div>
439<a class="anchor" id="a37d13f12283d69ebd092a7cc01a7d742"></a>
440<div class="memitem">
441<div class="memproto">
442 <table class="memname">
443 <tr>
444 <td class="memname">void flair::core::Thread::SetPeriodMS </td>
445 <td>(</td>
446 <td class="paramtype">uint32_t&#160;</td>
447 <td class="paramname"><em>period_ms</em></td><td>)</td>
448 <td></td>
449 </tr>
450 </table>
451</div><div class="memdoc">
452
453<p>Set the period in milli second. </p>
454<p>After calling this method, IsPeriodSet will return true.</p>
455<dl class="params"><dt>Parameters</dt><dd>
456 <table class="params">
457 <tr><td class="paramname">period_ums</td><td>period in ms </td></tr>
458 </table>
459 </dd>
460</dl>
461
462</div>
463</div>
464<a class="anchor" id="af892a1b3025cb842cad8e7f2a11a9526"></a>
465<div class="memitem">
466<div class="memproto">
467 <table class="memname">
468 <tr>
469 <td class="memname">bool flair::core::Thread::IsPeriodSet </td>
470 <td>(</td>
471 <td class="paramtype">void&#160;</td>
472 <td class="paramname"></td><td>)</td>
473 <td></td>
474 </tr>
475 </table>
476</div><div class="memdoc">
477
478<p>Returns if period was set. </p>
479<dl class="section return"><dt>Returns</dt><dd>true if a period was set using SetPeriodUS or SetPeriodMS false otherwise </dd></dl>
480
481</div>
482</div>
483<a class="anchor" id="a50cd2ea88d538e10a30c3e6a5286a944"></a>
484<div class="memitem">
485<div class="memproto">
486 <table class="memname">
487 <tr>
488 <td class="memname">void flair::core::Thread::WaitPeriod </td>
489 <td>(</td>
490 <td class="paramtype">void&#160;</td>
491 <td class="paramname"></td><td>)</td>
492 <td> const</td>
493 </tr>
494 </table>
495</div><div class="memdoc">
496
497<p>Wait the period. </p>
498<p>This method will block untill period is met. <br />
499 If no period was set (see SetPeriodUS, SetPeriodMS and IsPeriodSet), this method returns immediately. </p>
500
501</div>
502</div>
503<a class="anchor" id="a2b5b5f3cf400729419bd864b654af252"></a>
504<div class="memitem">
505<div class="memproto">
506 <table class="memname">
507 <tr>
508 <td class="memname">int flair::core::Thread::WaitUpdate </td>
509 <td>(</td>
510 <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_i_o_device.html">IODevice</a> *&#160;</td>
511 <td class="paramname"><em>device</em></td><td>)</td>
512 <td></td>
513 </tr>
514 </table>
515</div><div class="memdoc">
516
517<p>Wait update of an <a class="el" href="classflair_1_1core_1_1_i_o_device.html" title="Abstract class for input/ouput system. ">IODevice</a>. </p>
518<p>This method will block untill <a class="el" href="classflair_1_1core_1_1_i_o_device.html#a3df9057ae23eb34f1b1dae8e7a4a9efc" title="Process the childs of type IODevice, and log if needed. ">IODevice::ProcessUpdate</a> is called. <br />
519This method is usefull to synchronize a thread with an <a class="el" href="classflair_1_1core_1_1_i_o_device.html" title="Abstract class for input/ouput system. ">IODevice</a>.</p>
520<dl class="params"><dt>Parameters</dt><dd>
521 <table class="params">
522 <tr><td class="paramname">device</td><td><a class="el" href="classflair_1_1core_1_1_i_o_device.html" title="Abstract class for input/ouput system. ">IODevice</a> to wait update from </td></tr>
523 </table>
524 </dd>
525</dl>
526
527</div>
528</div>
529<a class="anchor" id="a0e5fc8919ed6042e5736a5dca5ba546b"></a>
530<div class="memitem">
531<div class="memproto">
532 <table class="memname">
533 <tr>
534 <td class="memname">void flair::core::Thread::Suspend </td>
535 <td>(</td>
536 <td class="paramtype">void&#160;</td>
537 <td class="paramname"></td><td>)</td>
538 <td></td>
539 </tr>
540 </table>
541</div><div class="memdoc">
542
543<p>Suspend the thread. </p>
544<p>This method will block untill <a class="el" href="classflair_1_1core_1_1_thread.html#ae7c46910a801f1b16302570ad8ae9580" title="Resume the thread. ">Resume()</a> is called. </p>
545
546</div>
547</div>
548<a class="anchor" id="af93c2461c31a6c16958bc44189ab4253"></a>
549<div class="memitem">
550<div class="memproto">
551 <table class="memname">
552 <tr>
553 <td class="memname">bool flair::core::Thread::SuspendUntil </td>
554 <td>(</td>
555 <td class="paramtype"><a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a>&#160;</td>
556 <td class="paramname"><em>date</em></td><td>)</td>
557 <td></td>
558 </tr>
559 </table>
560</div><div class="memdoc">
561
562<p>Suspend the thread with timeout. </p>
563<p>This method will block until <a class="el" href="classflair_1_1core_1_1_thread.html#ae7c46910a801f1b16302570ad8ae9580" title="Resume the thread. ">Resume()</a> is called or the absolute date specified occurs</p>
564<dl class="params"><dt>Parameters</dt><dd>
565 <table class="params">
566 <tr><td class="paramname">date</td><td>absolute date in ns </td></tr>
567 </table>
568 </dd>
569</dl>
570<dl class="section return"><dt>Returns</dt><dd>true if thread is woken up by a call to Resume, false otherwise </dd></dl>
571
572</div>
573</div>
574<a class="anchor" id="ae7c46910a801f1b16302570ad8ae9580"></a>
575<div class="memitem">
576<div class="memproto">
577 <table class="memname">
578 <tr>
579 <td class="memname">void flair::core::Thread::Resume </td>
580 <td>(</td>
581 <td class="paramtype">void&#160;</td>
582 <td class="paramname"></td><td>)</td>
583 <td></td>
584 </tr>
585 </table>
586</div><div class="memdoc">
587
588<p>Resume the thread. </p>
589<p>This method will unblock the call to <a class="el" href="classflair_1_1core_1_1_thread.html#a0e5fc8919ed6042e5736a5dca5ba546b" title="Suspend the thread. ">Suspend()</a>. </p>
590
591</div>
592</div>
593<a class="anchor" id="adac9a6d336bdb50bcfa24c66943a355a"></a>
594<div class="memitem">
595<div class="memproto">
596 <table class="memname">
597 <tr>
598 <td class="memname">bool flair::core::Thread::IsSuspended </td>
599 <td>(</td>
600 <td class="paramtype">void&#160;</td>
601 <td class="paramname"></td><td>)</td>
602 <td> const</td>
603 </tr>
604 </table>
605</div><div class="memdoc">
606
607<p>Is the thread suspended? </p>
608<dl class="section return"><dt>Returns</dt><dd>true if thread is suspended </dd></dl>
609
610</div>
611</div>
612<a class="anchor" id="ac09a2d745af3dbb42371949d4c622011"></a>
613<div class="memitem">
614<div class="memproto">
615 <table class="memname">
616 <tr>
617 <td class="memname">void flair::core::Thread::SleepUntil </td>
618 <td>(</td>
619 <td class="paramtype"><a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a>&#160;</td>
620 <td class="paramname"><em>time</em></td><td>)</td>
621 <td> const</td>
622 </tr>
623 </table>
624</div><div class="memdoc">
625
626<p>Sleep until absolute time. </p>
627<p>This method will block untill time is reached.</p>
628<dl class="params"><dt>Parameters</dt><dd>
629 <table class="params">
630 <tr><td class="paramname">time</td><td>absolute time </td></tr>
631 </table>
632 </dd>
633</dl>
634
635</div>
636</div>
637<a class="anchor" id="a3479727dfaf2213f7866fccadb43eeb6"></a>
638<div class="memitem">
639<div class="memproto">
640 <table class="memname">
641 <tr>
642 <td class="memname">void flair::core::Thread::SleepUS </td>
643 <td>(</td>
644 <td class="paramtype">uint32_t&#160;</td>
645 <td class="paramname"><em>time_us</em></td><td>)</td>
646 <td> const</td>
647 </tr>
648 </table>
649</div><div class="memdoc">
650
651<p>Sleep for a certain time in micro second. </p>
652<p>This method will block untill time is elapsed.</p>
653<dl class="params"><dt>Parameters</dt><dd>
654 <table class="params">
655 <tr><td class="paramname">time_us</td><td>time to wait in micro second </td></tr>
656 </table>
657 </dd>
658</dl>
659
660</div>
661</div>
662<a class="anchor" id="a501e7802d7edd7e6167d111c803b8349"></a>
663<div class="memitem">
664<div class="memproto">
665 <table class="memname">
666 <tr>
667 <td class="memname">void flair::core::Thread::SleepMS </td>
668 <td>(</td>
669 <td class="paramtype">uint32_t&#160;</td>
670 <td class="paramname"><em>time_ms</em></td><td>)</td>
671 <td> const</td>
672 </tr>
673 </table>
674</div><div class="memdoc">
675
676<p>Sleep for a cartain time in milli second. </p>
677<p>This method will block untill time is elapsed.</p>
678<dl class="params"><dt>Parameters</dt><dd>
679 <table class="params">
680 <tr><td class="paramname">time_ms</td><td>time to wait in milli second </td></tr>
681 </table>
682 </dd>
683</dl>
684
685</div>
686</div>
687<a class="anchor" id="a7fbf5ad201e7e802f0fa127891849dc9"></a>
688<div class="memitem">
689<div class="memproto">
690<table class="mlabels">
691 <tr>
692 <td class="mlabels-left">
693 <table class="memname">
694 <tr>
695 <td class="memname">static void flair::core::Thread::WarnUponSwitches </td>
696 <td>(</td>
697 <td class="paramtype">bool&#160;</td>
698 <td class="paramname"><em>enable</em></td><td>)</td>
699 <td></td>
700 </tr>
701 </table>
702 </td>
703 <td class="mlabels-right">
704<span class="mlabels"><span class="mlabel">static</span></span> </td>
705 </tr>
706</table>
707</div><div class="memdoc">
708
709<p>Warn if real time / non real time switches occur. </p>
710<p>If enabled, a message with the call stack will be displayed in case of real time / non real time switches. <br />
711This method can help to debug application and see if switches occur. <br />
712Note that it as no effect if this method is called from the non real time Framework library.</p>
713<dl class="params"><dt>Parameters</dt><dd>
714 <table class="params">
715 <tr><td class="paramname">enable</td><td>enable or disable warns </td></tr>
716 </table>
717 </dd>
718</dl>
719
720</div>
721</div>
722</div><!-- contents -->
723</div><!-- doc-content -->
724<!-- start footer part -->
725<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
726 <ul>
727 <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_thread.html">Thread</a></li>
728 <li class="footer">Generated on Thu Apr 21 2016 11:41:05 for Flair by
729 <a href="http://www.doxygen.org/index.html">
730 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
731 </ul>
732</div>
733</body>
734</html>
Note: See TracBrowser for help on using the repository browser.