<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.8"/> <title>UHD: uhd::atomic_uint32_t Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">UHD  <span id="projectnumber">003.007.002-0-unknown</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.8 --> <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="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"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </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="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <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>Macros</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceuhd.html">uhd</a></li><li class="navelem"><a class="el" href="classuhd_1_1atomic__uint32__t.html">atomic_uint32_t</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classuhd_1_1atomic__uint32__t-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">uhd::atomic_uint32_t Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>A 32-bit integer that can be atomically accessed. <a href="classuhd_1_1atomic__uint32__t.html#details">More...</a></p> <p><code>#include <<a class="el" href="atomic_8hpp_source.html">atomic.hpp</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a94a4bc4493ec3861f213e97fa3311264"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1atomic__uint32__t.html#a94a4bc4493ec3861f213e97fa3311264">atomic_uint32_t</a> (void)</td></tr> <tr class="memdesc:a94a4bc4493ec3861f213e97fa3311264"><td class="mdescLeft"> </td><td class="mdescRight">Create a new atomic 32-bit integer, initialized to zero. <a href="#a94a4bc4493ec3861f213e97fa3311264">More...</a><br /></td></tr> <tr class="separator:a94a4bc4493ec3861f213e97fa3311264"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:adca8dceff939c4497c309ae5407c6ca3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> boost::uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1atomic__uint32__t.html#adca8dceff939c4497c309ae5407c6ca3">cas</a> (boost::uint32_t newval, boost::uint32_t cmp)</td></tr> <tr class="memdesc:adca8dceff939c4497c309ae5407c6ca3"><td class="mdescLeft"> </td><td class="mdescRight">Compare with cmp, swap with newval if same, return old value. <a href="#adca8dceff939c4497c309ae5407c6ca3">More...</a><br /></td></tr> <tr class="separator:adca8dceff939c4497c309ae5407c6ca3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9d82e64f152df723d11b62baf73d7af5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1atomic__uint32__t.html#a9d82e64f152df723d11b62baf73d7af5">write</a> (const boost::uint32_t newval)</td></tr> <tr class="memdesc:a9d82e64f152df723d11b62baf73d7af5"><td class="mdescLeft"> </td><td class="mdescRight">Sets the atomic integer to a new value. <a href="#a9d82e64f152df723d11b62baf73d7af5">More...</a><br /></td></tr> <tr class="separator:a9d82e64f152df723d11b62baf73d7af5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab9e7c93752f3c089b6c426f088152673"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> boost::uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1atomic__uint32__t.html#ab9e7c93752f3c089b6c426f088152673">read</a> (void)</td></tr> <tr class="memdesc:ab9e7c93752f3c089b6c426f088152673"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current value of the atomic integer. <a href="#ab9e7c93752f3c089b6c426f088152673">More...</a><br /></td></tr> <tr class="separator:ab9e7c93752f3c089b6c426f088152673"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a02c1e469a7773b16550355d9d0fc2522"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> boost::uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1atomic__uint32__t.html#a02c1e469a7773b16550355d9d0fc2522">inc</a> (void)</td></tr> <tr class="memdesc:a02c1e469a7773b16550355d9d0fc2522"><td class="mdescLeft"> </td><td class="mdescRight">Increment by 1 and return the old value. <a href="#a02c1e469a7773b16550355d9d0fc2522">More...</a><br /></td></tr> <tr class="separator:a02c1e469a7773b16550355d9d0fc2522"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a712f1d0e775ff2ff6430fb1fff037342"><td class="memItemLeft" align="right" valign="top"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> boost::uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classuhd_1_1atomic__uint32__t.html#a712f1d0e775ff2ff6430fb1fff037342">dec</a> (void)</td></tr> <tr class="memdesc:a712f1d0e775ff2ff6430fb1fff037342"><td class="mdescLeft"> </td><td class="mdescRight">Decrement by 1 and return the old value. <a href="#a712f1d0e775ff2ff6430fb1fff037342">More...</a><br /></td></tr> <tr class="separator:a712f1d0e775ff2ff6430fb1fff037342"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>A 32-bit integer that can be atomically accessed. </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a94a4bc4493ec3861f213e97fa3311264"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> uhd::atomic_uint32_t::atomic_uint32_t </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Create a new atomic 32-bit integer, initialized to zero. </p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="adca8dceff939c4497c309ae5407c6ca3"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> boost::uint32_t uhd::atomic_uint32_t::cas </td> <td>(</td> <td class="paramtype">boost::uint32_t </td> <td class="paramname"><em>newval</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">boost::uint32_t </td> <td class="paramname"><em>cmp</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Compare with cmp, swap with newval if same, return old value. </p> </div> </div> <a class="anchor" id="a712f1d0e775ff2ff6430fb1fff037342"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> boost::uint32_t uhd::atomic_uint32_t::dec </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Decrement by 1 and return the old value. </p> </div> </div> <a class="anchor" id="a02c1e469a7773b16550355d9d0fc2522"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> boost::uint32_t uhd::atomic_uint32_t::inc </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Increment by 1 and return the old value. </p> </div> </div> <a class="anchor" id="ab9e7c93752f3c089b6c426f088152673"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> boost::uint32_t uhd::atomic_uint32_t::read </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Gets the current value of the atomic integer. </p> </div> </div> <a class="anchor" id="a9d82e64f152df723d11b62baf73d7af5"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="config_8hpp.html#a8b9b549161081d54c2161046649a0323">UHD_INLINE</a> void uhd::atomic_uint32_t::write </td> <td>(</td> <td class="paramtype">const boost::uint32_t </td> <td class="paramname"><em>newval</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Sets the atomic integer to a new value. </p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>include/uhd/utils/<a class="el" href="atomic_8hpp_source.html">atomic.hpp</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Wed Oct 15 2014 11:47:53 for UHD by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.8 </small></address> </body> </html>