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

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

complementary filter

File size: 24.2 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::Mutex 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_mutex.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="classflair_1_1core_1_1_mutex-members.html">List of all members</a> </div>
111 <div class="headertitle">
112<div class="title">flair::core::Mutex Class Reference</div> </div>
113</div><!--header-->
114<div class="contents">
115
116<p>Class defining a mutex.
117 <a href="classflair_1_1core_1_1_mutex.html#details">More...</a></p>
118
119<p><code>#include &lt;<a class="el" href="_mutex_8h_source.html">Mutex.h</a>&gt;</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::Mutex:</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_mutex.png" usemap="#flair::core::Mutex_map" alt=""/>
127 <map id="flair::core::Mutex_map" name="flair::core::Mutex_map">
128<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="183,0,356,24"/>
129<area href="classflair_1_1core_1_1_condition_variable.html" title="Class defining a condition variable. " alt="flair::core::ConditionVariable" shape="rect" coords="0,112,173,136"/>
130<area href="classflair_1_1core_1_1_i2c_port.html" title="Base class for i2c port. " alt="flair::core::I2cPort" shape="rect" coords="183,112,356,136"/>
131<area href="classflair_1_1core_1_1io__data.html" title="Abstract class for data types. " alt="flair::core::io_data" shape="rect" coords="549,112,722,136"/>
132<area href="classflair_1_1core_1_1_r_t_d_m___i2c_port.html" title="Class for real time i2c port using RTDM. " alt="flair::core::RTDM_I2cPort" shape="rect" coords="366,168,539,192"/>
133<area href="classflair_1_1core_1_1_unix___i2c_port.html" title="Class for unix serial port. " alt="flair::core::Unix_I2cPort" shape="rect" coords="366,224,539,248"/>
134<area href="classflair_1_1core_1_1_ahrs_data.html" title="Class defining AHRS datas. " alt="flair::core::AhrsData" shape="rect" coords="732,168,905,192"/>
135<area href="classflair_1_1core_1_1cvimage.html" title="Class defining an image of kind IplImage. " alt="flair::core::cvimage" shape="rect" coords="732,224,905,248"/>
136<area href="classflair_1_1core_1_1cvmatrix.html" title="Class defining a matrix of kind CvMat. " alt="flair::core::cvmatrix" shape="rect" coords="732,280,905,304"/>
137<area href="classflair_1_1core_1_1_geo_coordinate.html" title="Class defining a point by its lla coordinates. " alt="flair::core::GeoCoordinate" shape="rect" coords="732,336,905,360"/>
138<area href="classflair_1_1core_1_1_imu_data.html" title="Class defining IMU datas. " alt="flair::core::ImuData" shape="rect" coords="732,392,905,416"/>
139<area href="classflair_1_1core_1_1_vector3_ddata.html" title="Class defining a 3D vector and a io_data User must manually use the io_data&#39;s Mutex to access to Vect..." alt="flair::core::Vector3Ddata" shape="rect" coords="732,448,905,472"/>
140</map>
141 </div></div>
142<table class="memberdecls">
143<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
144Public Member Functions</h2></td></tr>
145<tr class="memitem:a1f85044411d838898a794ceaeb78d8f0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_mutex.html#a1f85044411d838898a794ceaeb78d8f0">Mutex</a> (const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *parent, std::string name=&quot;&quot;)</td></tr>
146<tr class="memdesc:a1f85044411d838898a794ceaeb78d8f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a1f85044411d838898a794ceaeb78d8f0">More...</a><br /></td></tr>
147<tr class="separator:a1f85044411d838898a794ceaeb78d8f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
148<tr class="memitem:ac8256454205d5146d1fe95b7538b25eb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_mutex.html#ac8256454205d5146d1fe95b7538b25eb">~Mutex</a> ()</td></tr>
149<tr class="memdesc:ac8256454205d5146d1fe95b7538b25eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#ac8256454205d5146d1fe95b7538b25eb">More...</a><br /></td></tr>
150<tr class="separator:ac8256454205d5146d1fe95b7538b25eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
151<tr class="memitem:a225fbd364b794d698b1c7d8c6962492b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_mutex.html#a225fbd364b794d698b1c7d8c6962492b">GetMutex</a> (void) const </td></tr>
152<tr class="memdesc:a225fbd364b794d698b1c7d8c6962492b"><td class="mdescLeft">&#160;</td><td class="mdescRight">GetMutex. <a href="#a225fbd364b794d698b1c7d8c6962492b">More...</a><br /></td></tr>
153<tr class="separator:a225fbd364b794d698b1c7d8c6962492b"><td class="memSeparator" colspan="2">&#160;</td></tr>
154<tr class="memitem:a1fd1e2cbcacd6a51e21da35cd26800f6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classflair_1_1core_1_1_mutex.html#a1fd1e2cbcacd6a51e21da35cd26800f6">ReleaseMutex</a> (void) const </td></tr>
155<tr class="memdesc:a1fd1e2cbcacd6a51e21da35cd26800f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">ReleaseMutex. <a href="#a1fd1e2cbcacd6a51e21da35cd26800f6">More...</a><br /></td></tr>
156<tr class="separator:a1fd1e2cbcacd6a51e21da35cd26800f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
157<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>
158<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>
159<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>
160<tr class="separator:aec92383fd5bf68d9df10414862b7e95c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
161<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>
162<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>
163<tr class="separator:aa2bde0e6677bbef705c96c93cb06ad09 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
164<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>
165<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>
166<tr class="separator:a9b0344dff7e1c05424d9152c8274523a inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
167<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>
168<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>
169<tr class="separator:a609a250ec037fbcaf8957c8f1dcbfc53 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
170<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>
171<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>
172<tr class="separator:a360c112cc3017a5152ebf6e84d2efa70 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
173<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>
174<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>
175<tr class="separator:ae22db4d723ec2d50b3ba48f26a6a770c inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
176<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>
177<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>
178<tr class="separator:a344f81cd35805a9501098bf727ac1a10 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
179<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>
180<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>
181<tr class="separator:af001feba14fc053aa778e61080a0b4cf inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
182<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>
183<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>
184<tr class="separator:a168b18451b2ee6126e1e81d452005ff6 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
185<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>
186<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>
187<tr class="separator:a3ca9694d29ec2b0491739879685df5ca inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
188<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>
189<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>
190<tr class="separator:a36cdd7f556e78b1bddd1d1fe4264bb85 inherit pub_methods_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
191</table><table class="memberdecls">
192<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
193Additional Inherited Members</h2></td></tr>
194<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>
195<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,
196<b>Red</b> = 31,
197<b>Green</b> = 32,
198<b>Orange</b> = 33
199 }</td></tr>
200<tr class="separator:aed5fccda511f97487040fed29f4efc97 inherit pub_types_classflair_1_1core_1_1_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
201</table>
202<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
203<div class="textblock"><p>Class defining a mutex. </p>
204</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
205<a class="anchor" id="a1f85044411d838898a794ceaeb78d8f0"></a>
206<div class="memitem">
207<div class="memproto">
208 <table class="memname">
209 <tr>
210 <td class="memname">flair::core::Mutex::Mutex </td>
211 <td>(</td>
212 <td class="paramtype">const <a class="el" href="classflair_1_1core_1_1_object.html">Object</a> *&#160;</td>
213 <td class="paramname"><em>parent</em>, </td>
214 </tr>
215 <tr>
216 <td class="paramkey"></td>
217 <td></td>
218 <td class="paramtype">std::string&#160;</td>
219 <td class="paramname"><em>name</em> = <code>&quot;&quot;</code>&#160;</td>
220 </tr>
221 <tr>
222 <td></td>
223 <td>)</td>
224 <td></td><td></td>
225 </tr>
226 </table>
227</div><div class="memdoc">
228
229<p>Constructor. </p>
230<p>Construct a mutex.</p>
231<dl class="params"><dt>Parameters</dt><dd>
232 <table class="params">
233 <tr><td class="paramname">parent</td><td>parent </td></tr>
234 <tr><td class="paramname">name</td><td>name </td></tr>
235 </table>
236 </dd>
237</dl>
238
239</div>
240</div>
241<a class="anchor" id="ac8256454205d5146d1fe95b7538b25eb"></a>
242<div class="memitem">
243<div class="memproto">
244 <table class="memname">
245 <tr>
246 <td class="memname">flair::core::Mutex::~Mutex </td>
247 <td>(</td>
248 <td class="paramname"></td><td>)</td>
249 <td></td>
250 </tr>
251 </table>
252</div><div class="memdoc">
253
254<p>Destructor. </p>
255
256</div>
257</div>
258<h2 class="groupheader">Member Function Documentation</h2>
259<a class="anchor" id="a225fbd364b794d698b1c7d8c6962492b"></a>
260<div class="memitem">
261<div class="memproto">
262 <table class="memname">
263 <tr>
264 <td class="memname">void flair::core::Mutex::GetMutex </td>
265 <td>(</td>
266 <td class="paramtype">void&#160;</td>
267 <td class="paramname"></td><td>)</td>
268 <td> const</td>
269 </tr>
270 </table>
271</div><div class="memdoc">
272
273<p>GetMutex. </p>
274<p>Lock the mutex. </p>
275
276</div>
277</div>
278<a class="anchor" id="a1fd1e2cbcacd6a51e21da35cd26800f6"></a>
279<div class="memitem">
280<div class="memproto">
281 <table class="memname">
282 <tr>
283 <td class="memname">void flair::core::Mutex::ReleaseMutex </td>
284 <td>(</td>
285 <td class="paramtype">void&#160;</td>
286 <td class="paramname"></td><td>)</td>
287 <td> const</td>
288 </tr>
289 </table>
290</div><div class="memdoc">
291
292<p>ReleaseMutex. </p>
293<p>Unlock the mutex. </p>
294
295</div>
296</div>
297</div><!-- contents -->
298</div><!-- doc-content -->
299<!-- start footer part -->
300<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
301 <ul>
302 <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_mutex.html">Mutex</a></li>
303 <li class="footer">Generated on Thu Apr 21 2016 11:41:04 for Flair by
304 <a href="http://www.doxygen.org/index.html">
305 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.7 </li>
306 </ul>
307</div>
308</body>
309</html>
Note: See TracBrowser for help on using the repository browser.