| 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::ConditionVariable 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">
|
|---|
| 44 | var 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 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 List</span></a></li>
|
|---|
| 73 | <li><a href="classes.html"><span>Class Index</span></a></li>
|
|---|
| 74 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|---|
| 75 | <li><a href="functions.html"><span>Class 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_condition_variable.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </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> |
|
|---|
| 110 | <a href="classflair_1_1core_1_1_condition_variable-members.html">List of all members</a> </div>
|
|---|
| 111 | <div class="headertitle">
|
|---|
| 112 | <div class="title">flair::core::ConditionVariable Class Reference</div> </div>
|
|---|
| 113 | </div><!--header-->
|
|---|
| 114 | <div class="contents">
|
|---|
| 115 |
|
|---|
| 116 | <p>Class defining a condition variable.
|
|---|
| 117 | <a href="classflair_1_1core_1_1_condition_variable.html#details">More...</a></p>
|
|---|
| 118 |
|
|---|
| 119 | <p><code>#include <<a class="el" href="_condition_variable_8h_source.html">ConditionVariable.h</a>></code></p>
|
|---|
| 120 | <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|---|
| 121 | <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for flair::core::ConditionVariable:</div>
|
|---|
| 122 | <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
|
|---|
| 123 | </div>
|
|---|
| 124 | <div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
|---|
| 125 | <div class="center">
|
|---|
| 126 | <img src="classflair_1_1core_1_1_condition_variable.png" usemap="#flair::core::ConditionVariable_map" alt=""/>
|
|---|
| 127 | <map id="flair::core::ConditionVariable_map" name="flair::core::ConditionVariable_map">
|
|---|
| 128 | <area href="classflair_1_1core_1_1_mutex.html" title="Class defining a mutex. " alt="flair::core::Mutex" shape="rect" coords="0,56,173,80"/>
|
|---|
| 129 | <area href="classflair_1_1core_1_1_object.html" title="Base class for all Framework's classes. " alt="flair::core::Object" shape="rect" coords="0,0,173,24"/>
|
|---|
| 130 | </map>
|
|---|
| 131 | </div></div>
|
|---|
| 132 | <table class="memberdecls">
|
|---|
| 133 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|---|
| 134 | Public Member Functions</h2></td></tr>
|
|---|
| 135 | <tr class="memitem:a39d2c7445e468a1fa8efb62d39f7d082"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_condition_variable.html#a39d2c7445e468a1fa8efb62d39f7d082">ConditionVariable</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string name)</td></tr>
|
|---|
| 136 | <tr class="memdesc:a39d2c7445e468a1fa8efb62d39f7d082"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a39d2c7445e468a1fa8efb62d39f7d082">More...</a><br /></td></tr>
|
|---|
| 137 | <tr class="separator:a39d2c7445e468a1fa8efb62d39f7d082"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 138 | <tr class="memitem:aa2a9990054e13bf0a94dbb19931e8e8c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_condition_variable.html#aa2a9990054e13bf0a94dbb19931e8e8c">~ConditionVariable</a> ()</td></tr>
|
|---|
| 139 | <tr class="memdesc:aa2a9990054e13bf0a94dbb19931e8e8c"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#aa2a9990054e13bf0a94dbb19931e8e8c">More...</a><br /></td></tr>
|
|---|
| 140 | <tr class="separator:aa2a9990054e13bf0a94dbb19931e8e8c"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 141 | <tr class="memitem:ac51adc9331b169c336bee3497a2d2eff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_condition_variable.html#ac51adc9331b169c336bee3497a2d2eff">CondWait</a> (void)</td></tr>
|
|---|
| 142 | <tr class="memdesc:ac51adc9331b169c336bee3497a2d2eff"><td class="mdescLeft"> </td><td class="mdescRight">Block on the condition variable. <a href="#ac51adc9331b169c336bee3497a2d2eff">More...</a><br /></td></tr>
|
|---|
| 143 | <tr class="separator:ac51adc9331b169c336bee3497a2d2eff"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 144 | <tr class="memitem:ac70e08c0d3f2017343022c19f1ffcb63"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_condition_variable.html#ac70e08c0d3f2017343022c19f1ffcb63">CondWaitUntil</a> (<a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> date)</td></tr>
|
|---|
| 145 | <tr class="memdesc:ac70e08c0d3f2017343022c19f1ffcb63"><td class="mdescLeft"> </td><td class="mdescRight">Block on the condition variable with a timeout. <a href="#ac70e08c0d3f2017343022c19f1ffcb63">More...</a><br /></td></tr>
|
|---|
| 146 | <tr class="separator:ac70e08c0d3f2017343022c19f1ffcb63"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 147 | <tr class="memitem:abaec3da1498ecab5c9e53472eda70105"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_condition_variable.html#abaec3da1498ecab5c9e53472eda70105">CondSignal</a> (void)</td></tr>
|
|---|
| 148 | <tr class="memdesc:abaec3da1498ecab5c9e53472eda70105"><td class="mdescLeft"> </td><td class="mdescRight">Unblock threads blocked on the condition variable. <a href="#abaec3da1498ecab5c9e53472eda70105">More...</a><br /></td></tr>
|
|---|
| 149 | <tr class="separator:abaec3da1498ecab5c9e53472eda70105"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 150 | <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="-"/> Public Member Functions inherited from <a class="el" href="classflair_1_1core_1_1_mutex.html">flair::core::Mutex</a></td></tr>
|
|---|
| 151 | <tr class="memitem:a1f85044411d838898a794ceaeb78d8f0 inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="memItemLeft" align="right" valign="top"> </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="")</td></tr>
|
|---|
| 152 | <tr class="memdesc:a1f85044411d838898a794ceaeb78d8f0 inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a1f85044411d838898a794ceaeb78d8f0">More...</a><br /></td></tr>
|
|---|
| 153 | <tr class="separator:a1f85044411d838898a794ceaeb78d8f0 inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 154 | <tr class="memitem:ac8256454205d5146d1fe95b7538b25eb inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_mutex.html#ac8256454205d5146d1fe95b7538b25eb">~Mutex</a> ()</td></tr>
|
|---|
| 155 | <tr class="memdesc:ac8256454205d5146d1fe95b7538b25eb inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ac8256454205d5146d1fe95b7538b25eb">More...</a><br /></td></tr>
|
|---|
| 156 | <tr class="separator:ac8256454205d5146d1fe95b7538b25eb inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 157 | <tr class="memitem:a225fbd364b794d698b1c7d8c6962492b inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_mutex.html#a225fbd364b794d698b1c7d8c6962492b">GetMutex</a> (void) const </td></tr>
|
|---|
| 158 | <tr class="memdesc:a225fbd364b794d698b1c7d8c6962492b inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="mdescLeft"> </td><td class="mdescRight">GetMutex. <a href="#a225fbd364b794d698b1c7d8c6962492b">More...</a><br /></td></tr>
|
|---|
| 159 | <tr class="separator:a225fbd364b794d698b1c7d8c6962492b inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 160 | <tr class="memitem:a1fd1e2cbcacd6a51e21da35cd26800f6 inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_mutex.html#a1fd1e2cbcacd6a51e21da35cd26800f6">ReleaseMutex</a> (void) const </td></tr>
|
|---|
| 161 | <tr class="memdesc:a1fd1e2cbcacd6a51e21da35cd26800f6 inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="mdescLeft"> </td><td class="mdescRight">ReleaseMutex. <a href="#a1fd1e2cbcacd6a51e21da35cd26800f6">More...</a><br /></td></tr>
|
|---|
| 162 | <tr class="separator:a1fd1e2cbcacd6a51e21da35cd26800f6 inherit pub_methods_classflair_1_1core_1_1_mutex"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 163 | <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="-"/> Public Member Functions inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
|
|---|
| 164 | <tr class="memitem:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top"> </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="", std::string type="")</td></tr>
|
|---|
| 165 | <tr class="memdesc:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#aec92383fd5bf68d9df10414862b7e95c">More...</a><br /></td></tr>
|
|---|
| 166 | <tr class="separator:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 167 | <tr class="memitem:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#aa2bde0e6677bbef705c96c93cb06ad09">~Object</a> ()</td></tr>
|
|---|
| 168 | <tr class="memdesc:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#aa2bde0e6677bbef705c96c93cb06ad09">More...</a><br /></td></tr>
|
|---|
| 169 | <tr class="separator:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 170 | <tr class="memitem:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a9b0344dff7e1c05424d9152c8274523a">ObjectName</a> (void) const </td></tr>
|
|---|
| 171 | <tr class="memdesc:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft"> </td><td class="mdescRight">Name. <a href="#a9b0344dff7e1c05424d9152c8274523a">More...</a><br /></td></tr>
|
|---|
| 172 | <tr class="separator:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 173 | <tr class="memitem:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a609a250ec037fbcaf8957c8f1dcbfc53">ObjectType</a> (void) const </td></tr>
|
|---|
| 174 | <tr class="memdesc:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft"> </td><td class="mdescRight">Type. <a href="#a609a250ec037fbcaf8957c8f1dcbfc53">More...</a><br /></td></tr>
|
|---|
| 175 | <tr class="separator:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 176 | <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> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a360c112cc3017a5152ebf6e84d2efa70">Parent</a> (void) const </td></tr>
|
|---|
| 177 | <tr class="memdesc:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft"> </td><td class="mdescRight">Parent. <a href="#a360c112cc3017a5152ebf6e84d2efa70">More...</a><br /></td></tr>
|
|---|
| 178 | <tr class="separator:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 179 | <tr class="memitem:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::vector< const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * > * </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#ae22db4d723ec2d50b3ba48f26a6a770c">TypeChilds</a> (void) const </td></tr>
|
|---|
| 180 | <tr class="memdesc:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft"> </td><td class="mdescRight">Childs of the same type. <a href="#ae22db4d723ec2d50b3ba48f26a6a770c">More...</a><br /></td></tr>
|
|---|
| 181 | <tr class="separator:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 182 | <tr class="memitem:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">std::vector< const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * > * </td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_object.html#a344f81cd35805a9501098bf727ac1a10">Childs</a> (void) const </td></tr>
|
|---|
| 183 | <tr class="memdesc:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft"> </td><td class="mdescRight">Childs. <a href="#a344f81cd35805a9501098bf727ac1a10">More...</a><br /></td></tr>
|
|---|
| 184 | <tr class="separator:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 185 | <tr class="memitem:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void </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>
|
|---|
| 186 | <tr class="memdesc:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft"> </td><td class="mdescRight">Formatted information. <a href="#af001feba14fc053aa778e61080a0b4cf">More...</a><br /></td></tr>
|
|---|
| 187 | <tr class="separator:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 188 | <tr class="memitem:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void </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>
|
|---|
| 189 | <tr class="memdesc:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft"> </td><td class="mdescRight">Formatted warning. <a href="#a168b18451b2ee6126e1e81d452005ff6">More...</a><br /></td></tr>
|
|---|
| 190 | <tr class="separator:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 191 | <tr class="memitem:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">void </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>
|
|---|
| 192 | <tr class="memdesc:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft"> </td><td class="mdescRight">Formatted error. <a href="#a3ca9694d29ec2b0491739879685df5ca">More...</a><br /></td></tr>
|
|---|
| 193 | <tr class="separator:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 194 | <tr class="memitem:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memItemLeft" align="right" valign="top">bool </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>
|
|---|
| 195 | <tr class="memdesc:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="mdescLeft"> </td><td class="mdescRight">Has an errror occured? <a href="#a36cdd7f556e78b1bddd1d1fe4264bb85">More...</a><br /></td></tr>
|
|---|
| 196 | <tr class="separator:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 197 | </table><table class="memberdecls">
|
|---|
| 198 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
|---|
| 199 | Additional Inherited Members</h2></td></tr>
|
|---|
| 200 | <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="-"/> Public Types inherited from <a class="el" href="classflair_1_1core_1_1_object.html">flair::core::Object</a></td></tr>
|
|---|
| 201 | <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  </td><td class="memItemRight" valign="bottom"><b>color_t</b> { <b>Auto</b> = 0,
|
|---|
| 202 | <b>Red</b> = 31,
|
|---|
| 203 | <b>Green</b> = 32,
|
|---|
| 204 | <b>Orange</b> = 33
|
|---|
| 205 | }</td></tr>
|
|---|
| 206 | <tr class="separator:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2"> </td></tr>
|
|---|
| 207 | </table>
|
|---|
| 208 | <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|---|
| 209 | <div class="textblock"><p>Class defining a condition variable. </p>
|
|---|
| 210 | </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|---|
| 211 | <a class="anchor" id="a39d2c7445e468a1fa8efb62d39f7d082"></a>
|
|---|
| 212 | <div class="memitem">
|
|---|
| 213 | <div class="memproto">
|
|---|
| 214 | <table class="memname">
|
|---|
| 215 | <tr>
|
|---|
| 216 | <td class="memname">flair::core::ConditionVariable::ConditionVariable </td>
|
|---|
| 217 | <td>(</td>
|
|---|
| 218 | <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> * </td>
|
|---|
| 219 | <td class="paramname"><em>parent</em>, </td>
|
|---|
| 220 | </tr>
|
|---|
| 221 | <tr>
|
|---|
| 222 | <td class="paramkey"></td>
|
|---|
| 223 | <td></td>
|
|---|
| 224 | <td class="paramtype">std::string </td>
|
|---|
| 225 | <td class="paramname"><em>name</em> </td>
|
|---|
| 226 | </tr>
|
|---|
| 227 | <tr>
|
|---|
| 228 | <td></td>
|
|---|
| 229 | <td>)</td>
|
|---|
| 230 | <td></td><td></td>
|
|---|
| 231 | </tr>
|
|---|
| 232 | </table>
|
|---|
| 233 | </div><div class="memdoc">
|
|---|
| 234 |
|
|---|
| 235 | <p>Constructor. </p>
|
|---|
| 236 | <p>Construct a condition variable with its associated mutex.</p>
|
|---|
| 237 | <dl class="params"><dt>Parameters</dt><dd>
|
|---|
| 238 | <table class="params">
|
|---|
| 239 | <tr><td class="paramname">parent</td><td>parent </td></tr>
|
|---|
| 240 | <tr><td class="paramname">name</td><td>name </td></tr>
|
|---|
| 241 | </table>
|
|---|
| 242 | </dd>
|
|---|
| 243 | </dl>
|
|---|
| 244 |
|
|---|
| 245 | </div>
|
|---|
| 246 | </div>
|
|---|
| 247 | <a class="anchor" id="aa2a9990054e13bf0a94dbb19931e8e8c"></a>
|
|---|
| 248 | <div class="memitem">
|
|---|
| 249 | <div class="memproto">
|
|---|
| 250 | <table class="memname">
|
|---|
| 251 | <tr>
|
|---|
| 252 | <td class="memname">flair::core::ConditionVariable::~ConditionVariable </td>
|
|---|
| 253 | <td>(</td>
|
|---|
| 254 | <td class="paramname"></td><td>)</td>
|
|---|
| 255 | <td></td>
|
|---|
| 256 | </tr>
|
|---|
| 257 | </table>
|
|---|
| 258 | </div><div class="memdoc">
|
|---|
| 259 |
|
|---|
| 260 | <p>Destructor. </p>
|
|---|
| 261 |
|
|---|
| 262 | </div>
|
|---|
| 263 | </div>
|
|---|
| 264 | <h2 class="groupheader">Member Function Documentation</h2>
|
|---|
| 265 | <a class="anchor" id="ac51adc9331b169c336bee3497a2d2eff"></a>
|
|---|
| 266 | <div class="memitem">
|
|---|
| 267 | <div class="memproto">
|
|---|
| 268 | <table class="memname">
|
|---|
| 269 | <tr>
|
|---|
| 270 | <td class="memname">void flair::core::ConditionVariable::CondWait </td>
|
|---|
| 271 | <td>(</td>
|
|---|
| 272 | <td class="paramtype">void </td>
|
|---|
| 273 | <td class="paramname"></td><td>)</td>
|
|---|
| 274 | <td></td>
|
|---|
| 275 | </tr>
|
|---|
| 276 | </table>
|
|---|
| 277 | </div><div class="memdoc">
|
|---|
| 278 |
|
|---|
| 279 | <p>Block on the condition variable. </p>
|
|---|
| 280 | <p>This method must be called with mutex locked (see <a class="el" href="classflair_1_1core_1_1_mutex.html#a225fbd364b794d698b1c7d8c6962492b" title="GetMutex. ">Mutex::GetMutex</a>) by the calling thread or undefined behaviour will result. <br />
|
|---|
| 281 | It atomically releases mutex and causes the calling thread to block on the condition variable. <br />
|
|---|
| 282 | Only one thread can be blocked at the same time. <br />
|
|---|
| 283 | Upon successful return, the mutex has been locked and is owned by the calling thread which should unlock it (see <a class="el" href="classflair_1_1core_1_1_mutex.html#a1fd1e2cbcacd6a51e21da35cd26800f6" title="ReleaseMutex. ">Mutex::ReleaseMutex</a>). </p>
|
|---|
| 284 |
|
|---|
| 285 | </div>
|
|---|
| 286 | </div>
|
|---|
| 287 | <a class="anchor" id="ac70e08c0d3f2017343022c19f1ffcb63"></a>
|
|---|
| 288 | <div class="memitem">
|
|---|
| 289 | <div class="memproto">
|
|---|
| 290 | <table class="memname">
|
|---|
| 291 | <tr>
|
|---|
| 292 | <td class="memname">bool flair::core::ConditionVariable::CondWaitUntil </td>
|
|---|
| 293 | <td>(</td>
|
|---|
| 294 | <td class="paramtype"><a class="el" href="namespaceflair_1_1core.html#acc0fa041e08ecf73b2d1d723c339a736">Time</a> </td>
|
|---|
| 295 | <td class="paramname"><em>date</em></td><td>)</td>
|
|---|
| 296 | <td></td>
|
|---|
| 297 | </tr>
|
|---|
| 298 | </table>
|
|---|
| 299 | </div><div class="memdoc">
|
|---|
| 300 |
|
|---|
| 301 | <p>Block on the condition variable with a timeout. </p>
|
|---|
| 302 | <p>This method must be called with mutex locked (see <a class="el" href="classflair_1_1core_1_1_mutex.html#a225fbd364b794d698b1c7d8c6962492b" title="GetMutex. ">Mutex::GetMutex</a>) by the calling thread or undefined behaviour will result. <br />
|
|---|
| 303 | It atomically releases mutex and causes the calling thread to block on the condition variable. <br />
|
|---|
| 304 | Only one thread can be blocked at the same time. <br />
|
|---|
| 305 | Upon successful return, the mutex has been locked and is owned by the calling thread which should unlock it (see <a class="el" href="classflair_1_1core_1_1_mutex.html#a1fd1e2cbcacd6a51e21da35cd26800f6" title="ReleaseMutex. ">Mutex::ReleaseMutex</a>).</p>
|
|---|
| 306 | <dl class="params"><dt>Parameters</dt><dd>
|
|---|
| 307 | <table class="params">
|
|---|
| 308 | <tr><td class="paramname">date</td><td>absolute date </td></tr>
|
|---|
| 309 | </table>
|
|---|
| 310 | </dd>
|
|---|
| 311 | </dl>
|
|---|
| 312 | <dl class="section return"><dt>Returns</dt><dd>true if the condition variable is signaled before the date specified in parameter elapses, false otherwise </dd></dl>
|
|---|
| 313 |
|
|---|
| 314 | </div>
|
|---|
| 315 | </div>
|
|---|
| 316 | <a class="anchor" id="abaec3da1498ecab5c9e53472eda70105"></a>
|
|---|
| 317 | <div class="memitem">
|
|---|
| 318 | <div class="memproto">
|
|---|
| 319 | <table class="memname">
|
|---|
| 320 | <tr>
|
|---|
| 321 | <td class="memname">void flair::core::ConditionVariable::CondSignal </td>
|
|---|
| 322 | <td>(</td>
|
|---|
| 323 | <td class="paramtype">void </td>
|
|---|
| 324 | <td class="paramname"></td><td>)</td>
|
|---|
| 325 | <td></td>
|
|---|
| 326 | </tr>
|
|---|
| 327 | </table>
|
|---|
| 328 | </div><div class="memdoc">
|
|---|
| 329 |
|
|---|
| 330 | <p>Unblock threads blocked on the condition variable. </p>
|
|---|
| 331 | <p>This method should be called with mutex locked (see <a class="el" href="classflair_1_1core_1_1_mutex.html#a225fbd364b794d698b1c7d8c6962492b" title="GetMutex. ">Mutex::GetMutex</a>) by the calling thread. <br />
|
|---|
| 332 | In this case, upon return, the calling thread should unlock the mutex (see <a class="el" href="classflair_1_1core_1_1_mutex.html#a1fd1e2cbcacd6a51e21da35cd26800f6" title="ReleaseMutex. ">Mutex::ReleaseMutex</a>). </p>
|
|---|
| 333 |
|
|---|
| 334 | </div>
|
|---|
| 335 | </div>
|
|---|
| 336 | </div><!-- contents -->
|
|---|
| 337 | </div><!-- doc-content -->
|
|---|
| 338 | <!-- start footer part -->
|
|---|
| 339 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|---|
| 340 | <ul>
|
|---|
| 341 | <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_condition_variable.html">ConditionVariable</a></li>
|
|---|
| 342 | <li class="footer">Generated on Thu Apr 21 2016 11:41:04 for Flair by
|
|---|
| 343 | <a href="http://www.doxygen.org/index.html">
|
|---|
| 344 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
|
|---|
| 345 | </ul>
|
|---|
| 346 | </div>
|
|---|
| 347 | </body>
|
|---|
| 348 | </html>
|
|---|
