<!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>mrpt::synch::CThreadSafeVariable Class Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><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="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacemrpt.html">mrpt</a> </li>
<li class="navelem"><a class="el" href="namespacemrpt_1_1synch.html">synch</a> </li>
<li class="navelem"><a class="el" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html">CThreadSafeVariable</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<div class="title">mrpt::synch::CThreadSafeVariable Class Reference<div class="ingroups"><a class="el" href="group__synch__grp.html">Synchronization, multi-threading synch tools</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="mrpt::synch::CThreadSafeVariable" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A template for created thread-safe variables with an internal critical section controlled each read or write. </p>
<p>Example: </p>
<div class="fragment"><pre class="fragment"> CThreadSafeVariable<double> var1;
...
var.set(2.3); <span class="comment">// Sets the value</span>
<span class="keywordtype">double</span> x = var.get(); <span class="comment">// Reads the variable</span>
...
<span class="keywordtype">double</span> foo = var; <span class="comment">// Also reads the variable</span>
var = 2.3; <span class="comment">// ERROR: Not allowed, use ".set()" instead.</span>
</pre></div><dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html" title="This class provides simple critical sections functionality.">CCriticalSection</a> </dd></dl>
</div>
<p><code>#include <<a class="el" href="_c_thread_safe_variable_8h_source.html">mrpt/synch/CThreadSafeVariable.h</a>></code></p>
<p><a href="classmrpt_1_1synch_1_1_c_thread_safe_variable-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#ac68445cdf923f38f0b5e680ce4efbf89">CThreadSafeVariable</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#a2a3461be24c0cadda21638af54efce4c">CThreadSafeVariable</a> (const T &init_val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#a2f36e96a863a5461cf797509e0bff247">~CThreadSafeVariable</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#a2335a1f712d0cf9da13eb784b69e02bc">get</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a copy of the hold variable. <a href="#a2335a1f712d0cf9da13eb784b69e02bc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#afa45e7191469ae8bc11ed967d20fcdbc">get</a> (T &out_val) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a copy of the hold variable. <a href="#afa45e7191469ae8bc11ed967d20fcdbc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#ae0cdad9c05c9843871933376b28479a8">operator T</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a copy of the hold variable. <a href="#ae0cdad9c05c9843871933376b28479a8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#aaa8d1aa683ba8c7872914ab861e5b1ae">set</a> (const T &new_val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a copy of the hold variable. <a href="#aaa8d1aa683ba8c7872914ab861e5b1ae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#aa1b1aece365a77089ae56bc27ef9b9f2">swap</a> (T &in_out_var)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Swap the current value of the hold variable and the passed one, as one atomic operation. <a href="#aa1b1aece365a77089ae56bc27ef9b9f2"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html">CCriticalSection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#a4c3f2924452d50ade066d975956822d2">m_cs</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#aff7f23e33809cd0a2dfbf44b3050e100">m_val</a></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ac68445cdf923f38f0b5e680ce4efbf89"></a><!-- doxytag: member="mrpt::synch::CThreadSafeVariable::CThreadSafeVariable" ref="ac68445cdf923f38f0b5e680ce4efbf89" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::synch::CThreadSafeVariable::CThreadSafeVariable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_thread_safe_variable_8h_source.html#l00060">60</a> of file <a class="el" href="_c_thread_safe_variable_8h_source.html">CThreadSafeVariable.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2a3461be24c0cadda21638af54efce4c"></a><!-- doxytag: member="mrpt::synch::CThreadSafeVariable::CThreadSafeVariable" ref="a2a3461be24c0cadda21638af54efce4c" args="(const T &init_val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::synch::CThreadSafeVariable::CThreadSafeVariable </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>init_val</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_thread_safe_variable_8h_source.html#l00061">61</a> of file <a class="el" href="_c_thread_safe_variable_8h_source.html">CThreadSafeVariable.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2f36e96a863a5461cf797509e0bff247"></a><!-- doxytag: member="mrpt::synch::CThreadSafeVariable::~CThreadSafeVariable" ref="a2f36e96a863a5461cf797509e0bff247" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual mrpt::synch::CThreadSafeVariable::~CThreadSafeVariable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_thread_safe_variable_8h_source.html#l00063">63</a> of file <a class="el" href="_c_thread_safe_variable_8h_source.html">CThreadSafeVariable.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a2335a1f712d0cf9da13eb784b69e02bc"></a><!-- doxytag: member="mrpt::synch::CThreadSafeVariable::get" ref="a2335a1f712d0cf9da13eb784b69e02bc" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T mrpt::synch::CThreadSafeVariable::get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a copy of the hold variable. </p>
<p>Definition at line <a class="el" href="_c_thread_safe_variable_8h_source.html#l00066">66</a> of file <a class="el" href="_c_thread_safe_variable_8h_source.html">CThreadSafeVariable.h</a>.</p>
<p>References <a class="el" href="_c_thread_safe_variable_8h_source.html#l00057">m_cs</a>, and <a class="el" href="_c_thread_safe_variable_8h_source.html#l00058">m_val</a>.</p>
</div>
</div>
<a class="anchor" id="afa45e7191469ae8bc11ed967d20fcdbc"></a><!-- doxytag: member="mrpt::synch::CThreadSafeVariable::get" ref="afa45e7191469ae8bc11ed967d20fcdbc" args="(T &out_val) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::synch::CThreadSafeVariable::get </td>
<td>(</td>
<td class="paramtype">T & </td>
<td class="paramname"><em>out_val</em></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a copy of the hold variable. </p>
<p>Definition at line <a class="el" href="_c_thread_safe_variable_8h_source.html#l00077">77</a> of file <a class="el" href="_c_thread_safe_variable_8h_source.html">CThreadSafeVariable.h</a>.</p>
<p>References <a class="el" href="_c_thread_safe_variable_8h_source.html#l00057">m_cs</a>, and <a class="el" href="_c_thread_safe_variable_8h_source.html#l00058">m_val</a>.</p>
</div>
</div>
<a class="anchor" id="ae0cdad9c05c9843871933376b28479a8"></a><!-- doxytag: member="mrpt::synch::CThreadSafeVariable::operator T" ref="ae0cdad9c05c9843871933376b28479a8" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::synch::CThreadSafeVariable::operator T </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a copy of the hold variable. </p>
<p>Definition at line <a class="el" href="_c_thread_safe_variable_8h_source.html#l00084">84</a> of file <a class="el" href="_c_thread_safe_variable_8h_source.html">CThreadSafeVariable.h</a>.</p>
<p>References <a class="el" href="_c_thread_safe_variable_8h_source.html#l00057">m_cs</a>, and <a class="el" href="_c_thread_safe_variable_8h_source.html#l00058">m_val</a>.</p>
</div>
</div>
<a class="anchor" id="aaa8d1aa683ba8c7872914ab861e5b1ae"></a><!-- doxytag: member="mrpt::synch::CThreadSafeVariable::set" ref="aaa8d1aa683ba8c7872914ab861e5b1ae" args="(const T &new_val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::synch::CThreadSafeVariable::set </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"><em>new_val</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a copy of the hold variable. </p>
<p>Definition at line <a class="el" href="_c_thread_safe_variable_8h_source.html#l00091">91</a> of file <a class="el" href="_c_thread_safe_variable_8h_source.html">CThreadSafeVariable.h</a>.</p>
<p>References <a class="el" href="_c_thread_safe_variable_8h_source.html#l00057">m_cs</a>, and <a class="el" href="_c_thread_safe_variable_8h_source.html#l00058">m_val</a>.</p>
</div>
</div>
<a class="anchor" id="aa1b1aece365a77089ae56bc27ef9b9f2"></a><!-- doxytag: member="mrpt::synch::CThreadSafeVariable::swap" ref="aa1b1aece365a77089ae56bc27ef9b9f2" args="(T &in_out_var)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::synch::CThreadSafeVariable::swap </td>
<td>(</td>
<td class="paramtype">T & </td>
<td class="paramname"><em>in_out_var</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Swap the current value of the hold variable and the passed one, as one atomic operation. </p>
<p>Definition at line <a class="el" href="_c_thread_safe_variable_8h_source.html#l00098">98</a> of file <a class="el" href="_c_thread_safe_variable_8h_source.html">CThreadSafeVariable.h</a>.</p>
<p>References <a class="el" href="_c_thread_safe_variable_8h_source.html#l00057">m_cs</a>, and <a class="el" href="_c_thread_safe_variable_8h_source.html#l00058">m_val</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a4c3f2924452d50ade066d975956822d2"></a><!-- doxytag: member="mrpt::synch::CThreadSafeVariable::m_cs" ref="a4c3f2924452d50ade066d975956822d2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmrpt_1_1synch_1_1_c_critical_section.html">CCriticalSection</a> <a class="el" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#a4c3f2924452d50ade066d975956822d2">mrpt::synch::CThreadSafeVariable::m_cs</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_thread_safe_variable_8h_source.html#l00057">57</a> of file <a class="el" href="_c_thread_safe_variable_8h_source.html">CThreadSafeVariable.h</a>.</p>
<p>Referenced by <a class="el" href="_c_thread_safe_variable_8h_source.html#l00066">get()</a>, <a class="el" href="_c_thread_safe_variable_8h_source.html#l00084">operator T()</a>, <a class="el" href="_c_thread_safe_variable_8h_source.html#l00091">set()</a>, and <a class="el" href="_c_thread_safe_variable_8h_source.html#l00098">swap()</a>.</p>
</div>
</div>
<a class="anchor" id="aff7f23e33809cd0a2dfbf44b3050e100"></a><!-- doxytag: member="mrpt::synch::CThreadSafeVariable::m_val" ref="aff7f23e33809cd0a2dfbf44b3050e100" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">T <a class="el" href="classmrpt_1_1synch_1_1_c_thread_safe_variable.html#aff7f23e33809cd0a2dfbf44b3050e100">mrpt::synch::CThreadSafeVariable::m_val</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_thread_safe_variable_8h_source.html#l00058">58</a> of file <a class="el" href="_c_thread_safe_variable_8h_source.html">CThreadSafeVariable.h</a>.</p>
<p>Referenced by <a class="el" href="_c_thread_safe_variable_8h_source.html#l00066">get()</a>, <a class="el" href="_c_thread_safe_variable_8h_source.html#l00084">operator T()</a>, <a class="el" href="_c_thread_safe_variable_8h_source.html#l00091">set()</a>, and <a class="el" href="_c_thread_safe_variable_8h_source.html#l00098">swap()</a>.</p>
</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>
