Sophie

Sophie

distrib > Fedora > 16 > i386 > by-pkgid > 4bc66056a634db26a1f4d0845dc41ca6 > files > 5182

mrpt-doc-0.9.5-0.1.20110925svn2670.fc16.i686.rpm

<!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::CAtomicCounter 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> &gt; <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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;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_atomic_counter.html">CAtomicCounter</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a>  </div>
  <div class="headertitle">
<div class="title">mrpt::synch::CAtomicCounter 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::CAtomicCounter" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class acts exactly as an int (or long) variable, but with atomic increment and decrement operators. </p>
<p>This is a useful component of thread-safe smart pointers. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Based on code from the Boost library. </dd></dl>
</div>
<p><code>#include &lt;<a class="el" href="atomic__incr_8h_source.html">mrpt/synch/atomic_incr.h</a>&gt;</code></p>

<p><a href="classmrpt_1_1synch_1_1_c_atomic_counter-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_atomic_counter.html#a0260ff84830add7d91a922e9fa8f60cb">atomic_num_t</a></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_atomic_counter.html#aa7424627e09a8b090e9e420ef0ee5b04">CAtomicCounter</a> (long v)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_atomic_counter.html#aaf81a39603e8c407fbb8a96f24f7cbe7">operator++</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Atomic increment of value.  <a href="#aaf81a39603e8c407fbb8a96f24f7cbe7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmrpt_1_1synch_1_1_c_atomic_counter.html#a0260ff84830add7d91a922e9fa8f60cb">atomic_num_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_atomic_counter.html#ad6faf165134035617817e0a5a0339f9f">operator--</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Atomic decrement of value and return new value.  <a href="#ad6faf165134035617817e0a5a0339f9f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_atomic_counter.html#a4b3daade9a5ccf1ba93682111ae15009">operator atomic_num_t</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get current value.  <a href="#a4b3daade9a5ccf1ba93682111ae15009"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_atomic_counter.html#a3f81ae657883e1419f284147d164f5f9">CAtomicCounter</a> (<a class="el" href="classmrpt_1_1synch_1_1_c_atomic_counter.html">CAtomicCounter</a> const &amp;)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Forbidden method.  <a href="#a3f81ae657883e1419f284147d164f5f9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmrpt_1_1synch_1_1_c_atomic_counter.html">CAtomicCounter</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_atomic_counter.html#a7a1779b0d2bd4a70ef73ee8d2bbba6a5">operator=</a> (<a class="el" href="classmrpt_1_1synch_1_1_c_atomic_counter.html">CAtomicCounter</a> const &amp;)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Forbidden method.  <a href="#a7a1779b0d2bd4a70ef73ee8d2bbba6a5"></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_atomic_counter.html#a0260ff84830add7d91a922e9fa8f60cb">atomic_num_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1synch_1_1_c_atomic_counter.html#af1da4fcaed1e7f03e27c25dc54fa82cb">m_value</a></td></tr>
</table>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a0260ff84830add7d91a922e9fa8f60cb"></a><!-- doxytag: member="mrpt::synch::CAtomicCounter::atomic_num_t" ref="a0260ff84830add7d91a922e9fa8f60cb" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef int <a class="el" href="classmrpt_1_1synch_1_1_c_atomic_counter.html#a0260ff84830add7d91a922e9fa8f60cb">mrpt::synch::CAtomicCounter::atomic_num_t</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="atomic__incr_8h_source.html#l00051">51</a> of file <a class="el" href="atomic__incr_8h_source.html">atomic_incr.h</a>.</p>

</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aa7424627e09a8b090e9e420ef0ee5b04"></a><!-- doxytag: member="mrpt::synch::CAtomicCounter::CAtomicCounter" ref="aa7424627e09a8b090e9e420ef0ee5b04" args="(long v)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">mrpt::synch::CAtomicCounter::CAtomicCounter </td>
          <td>(</td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>v</em></td><td>)</td>
          <td><code> [inline, explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="atomic__incr_8h_source.html#l00054">54</a> of file <a class="el" href="atomic__incr_8h_source.html">atomic_incr.h</a>.</p>

</div>
</div>
<a class="anchor" id="a3f81ae657883e1419f284147d164f5f9"></a><!-- doxytag: member="mrpt::synch::CAtomicCounter::CAtomicCounter" ref="a3f81ae657883e1419f284147d164f5f9" args="(CAtomicCounter const &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">mrpt::synch::CAtomicCounter::CAtomicCounter </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classmrpt_1_1synch_1_1_c_atomic_counter.html">CAtomicCounter</a> const &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Forbidden method. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4b3daade9a5ccf1ba93682111ae15009"></a><!-- doxytag: member="mrpt::synch::CAtomicCounter::operator atomic_num_t" ref="a4b3daade9a5ccf1ba93682111ae15009" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">mrpt::synch::CAtomicCounter::operator <a class="el" href="classmrpt_1_1synch_1_1_c_atomic_counter.html#a0260ff84830add7d91a922e9fa8f60cb">atomic_num_t</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get current value. </p>

</div>
</div>
<a class="anchor" id="aaf81a39603e8c407fbb8a96f24f7cbe7"></a><!-- doxytag: member="mrpt::synch::CAtomicCounter::operator++" ref="aaf81a39603e8c407fbb8a96f24f7cbe7" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mrpt::synch::CAtomicCounter::operator++ </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Atomic increment of value. </p>

</div>
</div>
<a class="anchor" id="ad6faf165134035617817e0a5a0339f9f"></a><!-- doxytag: member="mrpt::synch::CAtomicCounter::operator&#45;&#45;" ref="ad6faf165134035617817e0a5a0339f9f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classmrpt_1_1synch_1_1_c_atomic_counter.html#a0260ff84830add7d91a922e9fa8f60cb">atomic_num_t</a> mrpt::synch::CAtomicCounter::operator-- </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Atomic decrement of value and return new value. </p>

</div>
</div>
<a class="anchor" id="a7a1779b0d2bd4a70ef73ee8d2bbba6a5"></a><!-- doxytag: member="mrpt::synch::CAtomicCounter::operator=" ref="a7a1779b0d2bd4a70ef73ee8d2bbba6a5" args="(CAtomicCounter const &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classmrpt_1_1synch_1_1_c_atomic_counter.html">CAtomicCounter</a>&amp; mrpt::synch::CAtomicCounter::operator= </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classmrpt_1_1synch_1_1_c_atomic_counter.html">CAtomicCounter</a> const &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Forbidden method. </p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="af1da4fcaed1e7f03e27c25dc54fa82cb"></a><!-- doxytag: member="mrpt::synch::CAtomicCounter::m_value" ref="af1da4fcaed1e7f03e27c25dc54fa82cb" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classmrpt_1_1synch_1_1_c_atomic_counter.html#a0260ff84830add7d91a922e9fa8f60cb">atomic_num_t</a> <a class="el" href="classmrpt_1_1synch_1_1_c_atomic_counter.html#af1da4fcaed1e7f03e27c25dc54fa82cb">mrpt::synch::CAtomicCounter::m_value</a><code> [mutable, private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="atomic__incr_8h_source.html#l00062">62</a> of file <a class="el" href="atomic__incr_8h_source.html">atomic_incr.h</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>