<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>CThreadSafeVariable.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<div class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</div><div class="right"></div>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">CThreadSafeVariable.h</div> </div>
</div>
<div class="contents">
<a href="_c_thread_safe_variable_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* +---------------------------------------------------------------------------+</span>
<a name="l00002"></a>00002 <span class="comment"> | The Mobile Robot Programming Toolkit (MRPT) C++ library |</span>
<a name="l00003"></a>00003 <span class="comment"> | |</span>
<a name="l00004"></a>00004 <span class="comment"> | http://www.mrpt.org/ |</span>
<a name="l00005"></a>00005 <span class="comment"> | |</span>
<a name="l00006"></a>00006 <span class="comment"> | Copyright (C) 2005-2011 University of Malaga |</span>
<a name="l00007"></a>00007 <span class="comment"> | |</span>
<a name="l00008"></a>00008 <span class="comment"> | This software was written by the Machine Perception and Intelligent |</span>
<a name="l00009"></a>00009 <span class="comment"> | Robotics Lab, University of Malaga (Spain). |</span>
<a name="l00010"></a>00010 <span class="comment"> | Contact: Jose-Luis Blanco <jlblanco@ctima.uma.es> |</span>
<a name="l00011"></a>00011 <span class="comment"> | |</span>
<a name="l00012"></a>00012 <span class="comment"> | This file is part of the MRPT project. |</span>
<a name="l00013"></a>00013 <span class="comment"> | |</span>
<a name="l00014"></a>00014 <span class="comment"> | MRPT is free software: you can redistribute it and/or modify |</span>
<a name="l00015"></a>00015 <span class="comment"> | it under the terms of the GNU General Public License as published by |</span>
<a name="l00016"></a>00016 <span class="comment"> | the Free Software Foundation, either version 3 of the License, or |</span>
<a name="l00017"></a>00017 <span class="comment"> | (at your option) any later version. |</span>
<a name="l00018"></a>00018 <span class="comment"> | |</span>
<a name="l00019"></a>00019 <span class="comment"> | MRPT is distributed in the hope that it will be useful, |</span>
<a name="l00020"></a>00020 <span class="comment"> | but WITHOUT ANY WARRANTY; without even the implied warranty of |</span>
<a name="l00021"></a>00021 <span class="comment"> | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |</span>
<a name="l00022"></a>00022 <span class="comment"> | GNU General Public License for more details. |</span>
<a name="l00023"></a>00023 <span class="comment"> | |</span>
<a name="l00024"></a>00024 <span class="comment"> | You should have received a copy of the GNU General Public License |</span>
<a name="l00025"></a>00025 <span class="comment"> | along with MRPT. If not, see <http://www.gnu.org/licenses/>. |</span>
<a name="l00026"></a>00026 <span class="comment"> | |</span>
<a name="l00027"></a>00027 <span class="comment"> +---------------------------------------------------------------------------+ */</span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef mrpt_synch_threadsafevar_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define mrpt_synch_threadsafevar_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <<a class="code" href="_c_critical_section_8h.html">mrpt/synch/CCriticalSection.h</a>></span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">namespace </span>mrpt
<a name="l00034"></a>00034 {
<a name="l00035"></a>00035 <span class="keyword">namespace </span>synch
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037 <span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment"> /** A template for created thread-safe variables with an internal critical section controlled each read or write.</span>
<a name="l00039"></a>00039 <span class="comment"> * Example:</span>
<a name="l00040"></a>00040 <span class="comment"> * \code</span>
<a name="l00041"></a>00041 <span class="comment"> * CThreadSafeVariable<double> var1;</span>
<a name="l00042"></a>00042 <span class="comment"> * ...</span>
<a name="l00043"></a>00043 <span class="comment"> * var.set(2.3); // Sets the value</span>
<a name="l00044"></a>00044 <span class="comment"> * double x = var.get(); // Reads the variable</span>
<a name="l00045"></a>00045 <span class="comment"> * ...</span>
<a name="l00046"></a>00046 <span class="comment"> * double foo = var; // Also reads the variable</span>
<a name="l00047"></a>00047 <span class="comment"> * var = 2.3; // ERROR: Not allowed, use ".set()" instead.</span>
<a name="l00048"></a>00048 <span class="comment"> * \endcode</span>
<a name="l00049"></a>00049 <span class="comment"> *</span>
<a name="l00050"></a>00050 <span class="comment"> * \sa CCriticalSection</span>
<a name="l00051"></a>00051 <span class="comment"> * \ingroup synch_grp</span>
<a name="l00052"></a>00052 <span class="comment"> */</span>
<a name="l00053"></a>00053 <span class="keyword">template</span> <<span class="keyword">typename</span> T>
<a name="l00054"></a>00054 <span class="keyword">class </span>CThreadSafeVariable
<a name="l00055"></a>00055 {
<a name="l00056"></a>00056 <span class="keyword">private</span>:
<a name="l00057"></a><a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#a4c3f2924452d50ade066d975956822d2">00057</a> <a class="code" href="classmrpt_1_1synch_1_1_c_critical_section.html" title="This class provides simple critical sections functionality.">CCriticalSection</a> <a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#a4c3f2924452d50ade066d975956822d2">m_cs</a>;
<a name="l00058"></a><a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#aff7f23e33809cd0a2dfbf44b3050e100">00058</a> T <a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#aff7f23e33809cd0a2dfbf44b3050e100">m_val</a>;
<a name="l00059"></a>00059 <span class="keyword">public</span>:
<a name="l00060"></a><a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#ac68445cdf923f38f0b5e680ce4efbf89">00060</a> <a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#ac68445cdf923f38f0b5e680ce4efbf89">CThreadSafeVariable</a>() : <a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#a4c3f2924452d50ade066d975956822d2">m_cs</a>(), <a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#aff7f23e33809cd0a2dfbf44b3050e100">m_val</a>() { }
<a name="l00061"></a><a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#a2a3461be24c0cadda21638af54efce4c">00061</a> <a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#a2a3461be24c0cadda21638af54efce4c">CThreadSafeVariable</a>(<span class="keyword">const</span> T& init_val) : <a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#a4c3f2924452d50ade066d975956822d2">m_cs</a>(), <a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#aff7f23e33809cd0a2dfbf44b3050e100">m_val</a>(init_val) { }
<a name="l00062"></a>00062
<a name="l00063"></a><a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#a2f36e96a863a5461cf797509e0bff247">00063</a> <span class="keyword">virtual</span> <a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#a2f36e96a863a5461cf797509e0bff247">~CThreadSafeVariable</a>() { }
<a name="l00064"></a>00064 <span class="comment"></span>
<a name="l00065"></a>00065 <span class="comment"> /** Return a copy of the hold variable */</span>
<a name="l00066"></a><a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#a2335a1f712d0cf9da13eb784b69e02bc">00066</a> T <span class="keyword">get</span>() <span class="keyword">const</span>
<a name="l00067"></a>00067 {
<a name="l00068"></a>00068 T ret;
<a name="l00069"></a>00069 {
<a name="l00070"></a>00070 <a class="code" href="classmrpt_1_1synch_1_1_c_critical_section_locker.html" title="A class acquiring a CCriticalSection at its constructor, and releasing it at destructor.">CCriticalSectionLocker</a> l(&<a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#a4c3f2924452d50ade066d975956822d2">m_cs</a>);
<a name="l00071"></a>00071 ret = <a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#aff7f23e33809cd0a2dfbf44b3050e100">m_val</a>;
<a name="l00072"></a>00072 }
<a name="l00073"></a>00073 <span class="keywordflow">return</span> ret;
<a name="l00074"></a>00074 }
<a name="l00075"></a>00075 <span class="comment"></span>
<a name="l00076"></a>00076 <span class="comment"> /** Return a copy of the hold variable */</span>
<a name="l00077"></a><a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#afa45e7191469ae8bc11ed967d20fcdbc">00077</a> <span class="keywordtype">void</span> <span class="keyword">get</span>(T &out_val) <span class="keyword">const</span>
<a name="l00078"></a>00078 {
<a name="l00079"></a>00079 <a class="code" href="classmrpt_1_1synch_1_1_c_critical_section_locker.html" title="A class acquiring a CCriticalSection at its constructor, and releasing it at destructor.">CCriticalSectionLocker</a> l(&<a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#a4c3f2924452d50ade066d975956822d2">m_cs</a>);
<a name="l00080"></a>00080 out_val = <a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#aff7f23e33809cd0a2dfbf44b3050e100">m_val</a>;
<a name="l00081"></a>00081 }
<a name="l00082"></a>00082 <span class="comment"></span>
<a name="l00083"></a>00083 <span class="comment"> /** Return a copy of the hold variable */</span>
<a name="l00084"></a><a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#ae0cdad9c05c9843871933376b28479a8">00084</a> <a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#ae0cdad9c05c9843871933376b28479a8" title="Return a copy of the hold variable.">operator T</a>(<span class="keywordtype">void</span>)<span class="keyword"> const</span>
<a name="l00085"></a>00085 <span class="keyword"> </span>{
<a name="l00086"></a>00086 <a class="code" href="classmrpt_1_1synch_1_1_c_critical_section_locker.html" title="A class acquiring a CCriticalSection at its constructor, and releasing it at destructor.">CCriticalSectionLocker</a> l(&<a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#a4c3f2924452d50ade066d975956822d2">m_cs</a>);
<a name="l00087"></a>00087 <span class="keywordflow">return</span> <a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#aff7f23e33809cd0a2dfbf44b3050e100">m_val</a>;
<a name="l00088"></a>00088 }
<a name="l00089"></a>00089 <span class="comment"></span>
<a name="l00090"></a>00090 <span class="comment"> /** Return a copy of the hold variable */</span>
<a name="l00091"></a><a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#aaa8d1aa683ba8c7872914ab861e5b1ae">00091</a> <span class="keywordtype">void</span> <span class="keyword">set</span>(<span class="keyword">const</span> T &new_val)
<a name="l00092"></a>00092 {
<a name="l00093"></a>00093 <a class="code" href="classmrpt_1_1synch_1_1_c_critical_section_locker.html" title="A class acquiring a CCriticalSection at its constructor, and releasing it at destructor.">CCriticalSectionLocker</a> l(&<a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#a4c3f2924452d50ade066d975956822d2">m_cs</a>);
<a name="l00094"></a>00094 <a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#aff7f23e33809cd0a2dfbf44b3050e100">m_val</a> = new_val;
<a name="l00095"></a>00095 }
<a name="l00096"></a>00096 <span class="comment"></span>
<a name="l00097"></a>00097 <span class="comment"> /** Swap the current value of the hold variable and the passed one, as one atomic operation. */</span>
<a name="l00098"></a><a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#aa1b1aece365a77089ae56bc27ef9b9f2">00098</a> <span class="keywordtype">void</span> <a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#aa1b1aece365a77089ae56bc27ef9b9f2" title="Swap the current value of the hold variable and the passed one, as one atomic operation.">swap</a>(T &in_out_var)
<a name="l00099"></a>00099 {
<a name="l00100"></a>00100 <a class="code" href="classmrpt_1_1synch_1_1_c_critical_section_locker.html" title="A class acquiring a CCriticalSection at its constructor, and releasing it at destructor.">CCriticalSectionLocker</a> l(&<a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#a4c3f2924452d50ade066d975956822d2">m_cs</a>);
<a name="l00101"></a>00101 <a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#aa1b1aece365a77089ae56bc27ef9b9f2" title="Swap the current value of the hold variable and the passed one, as one atomic operation.">std::swap</a>(in_out_var,<a class="code" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#aff7f23e33809cd0a2dfbf44b3050e100">m_val</a>);
<a name="l00102"></a>00102 }
<a name="l00103"></a>00103 };
<a name="l00104"></a>00104
<a name="l00105"></a>00105 } <span class="comment">// End of namespace</span>
<a name="l00106"></a>00106 } <span class="comment">// End of namespace</span>
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
