304 lines
15 KiB
HTML
304 lines
15 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>SERiF: LockableDObject 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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-awesome-sidebar-only.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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">SERiF<span id="projectnumber"> 0.0.1a</span>
|
|
</div>
|
|
<div id="projectbrief">3+1D Stellar Structure and Evolution</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('class_lockable_d_object.html',''); initResizable(true); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="class_lockable_d_object-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">LockableDObject Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Wrapper for <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a> with thread-safe access.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_lockable_d_object_8h_source.html">LockableDObject.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:ae1a174a2740fa053626fe2820ee0efee" id="r_ae1a174a2740fa053626fe2820ee0efee"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae1a174a2740fa053626fe2820ee0efee">LockableDObject</a> ()=default</td></tr>
|
|
<tr class="memdesc:ae1a174a2740fa053626fe2820ee0efee"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:ae1a174a2740fa053626fe2820ee0efee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adcfe201fc728cc1c6fcf638a566ba9a1" id="r_adcfe201fc728cc1c6fcf638a566ba9a1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_d_object.html">DObject</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#adcfe201fc728cc1c6fcf638a566ba9a1">get</a> ()</td></tr>
|
|
<tr class="memdesc:adcfe201fc728cc1c6fcf638a566ba9a1"><td class="mdescLeft"> </td><td class="mdescRight">Access the underlying <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. <br /></td></tr>
|
|
<tr class="separator:adcfe201fc728cc1c6fcf638a566ba9a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ade38ca54703913359fc3b4366f6e292a" id="r_ade38ca54703913359fc3b4366f6e292a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ade38ca54703913359fc3b4366f6e292a">lock</a> ()</td></tr>
|
|
<tr class="memdesc:ade38ca54703913359fc3b4366f6e292a"><td class="mdescLeft"> </td><td class="mdescRight">Locks the mutex to ensure thread-safe access. <br /></td></tr>
|
|
<tr class="separator:ade38ca54703913359fc3b4366f6e292a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1481ed99dcd837490bf28309aadaedfb" id="r_a1481ed99dcd837490bf28309aadaedfb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1481ed99dcd837490bf28309aadaedfb">unlock</a> ()</td></tr>
|
|
<tr class="memdesc:a1481ed99dcd837490bf28309aadaedfb"><td class="mdescLeft"> </td><td class="mdescRight">Unlocks the mutex after thread-safe access. <br /></td></tr>
|
|
<tr class="separator:a1481ed99dcd837490bf28309aadaedfb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:a1eb1ca1d9cf979dcb9eead96054b89bb" id="r_a1eb1ca1d9cf979dcb9eead96054b89bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_d_object.html">DObject</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1eb1ca1d9cf979dcb9eead96054b89bb">object_</a></td></tr>
|
|
<tr class="memdesc:a1eb1ca1d9cf979dcb9eead96054b89bb"><td class="mdescLeft"> </td><td class="mdescRight">The underlying <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a> instance. <br /></td></tr>
|
|
<tr class="separator:a1eb1ca1d9cf979dcb9eead96054b89bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a712cd3ea0c565f7e9089a651ef79b7bd" id="r_a712cd3ea0c565f7e9089a651ef79b7bd"><td class="memItemLeft" align="right" valign="top">std::mutex </td><td class="memItemRight" valign="bottom"><a class="el" href="#a712cd3ea0c565f7e9089a651ef79b7bd">mutex_</a></td></tr>
|
|
<tr class="memdesc:a712cd3ea0c565f7e9089a651ef79b7bd"><td class="mdescLeft"> </td><td class="mdescRight">Mutex for thread-safe access. <br /></td></tr>
|
|
<tr class="separator:a712cd3ea0c565f7e9089a651ef79b7bd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Wrapper for <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a> with thread-safe access. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_lockable_d_object_8h_source.html#l00039">39</a> of file <a class="el" href="_lockable_d_object_8h_source.html">LockableDObject.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="ae1a174a2740fa053626fe2820ee0efee" name="ae1a174a2740fa053626fe2820ee0efee"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae1a174a2740fa053626fe2820ee0efee">◆ </a></span>LockableDObject()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">LockableDObject::LockableDObject </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel default">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="adcfe201fc728cc1c6fcf638a566ba9a1" name="adcfe201fc728cc1c6fcf638a566ba9a1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adcfe201fc728cc1c6fcf638a566ba9a1">◆ </a></span>get()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_d_object.html">DObject</a> & LockableDObject::get </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Access the underlying <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to the wrapped <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_lockable_d_object_8cpp_source.html#l00026">26</a> of file <a class="el" href="_lockable_d_object_8cpp_source.html">LockableDObject.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ade38ca54703913359fc3b4366f6e292a" name="ade38ca54703913359fc3b4366f6e292a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ade38ca54703913359fc3b4366f6e292a">◆ </a></span>lock()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LockableDObject::lock </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Locks the mutex to ensure thread-safe access. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_lockable_d_object_8cpp_source.html#l00033">33</a> of file <a class="el" href="_lockable_d_object_8cpp_source.html">LockableDObject.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1481ed99dcd837490bf28309aadaedfb" name="a1481ed99dcd837490bf28309aadaedfb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1481ed99dcd837490bf28309aadaedfb">◆ </a></span>unlock()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void LockableDObject::unlock </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Unlocks the mutex after thread-safe access. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_lockable_d_object_8cpp_source.html#l00040">40</a> of file <a class="el" href="_lockable_d_object_8cpp_source.html">LockableDObject.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a712cd3ea0c565f7e9089a651ef79b7bd" name="a712cd3ea0c565f7e9089a651ef79b7bd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a712cd3ea0c565f7e9089a651ef79b7bd">◆ </a></span>mutex_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::mutex LockableDObject::mutex_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Mutex for thread-safe access. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_lockable_d_object_8h_source.html#l00064">64</a> of file <a class="el" href="_lockable_d_object_8h_source.html">LockableDObject.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1eb1ca1d9cf979dcb9eead96054b89bb" name="a1eb1ca1d9cf979dcb9eead96054b89bb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1eb1ca1d9cf979dcb9eead96054b89bb">◆ </a></span>object_</h2>
|
|
|
|
<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="class_d_object.html">DObject</a> LockableDObject::object_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The underlying <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a> instance. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_lockable_d_object_8h_source.html#l00063">63</a> of file <a class="el" href="_lockable_d_object_8h_source.html">LockableDObject.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/dobj/public/<a class="el" href="_lockable_d_object_8h_source.html">LockableDObject.h</a></li>
|
|
<li>src/dobj/private/<a class="el" href="_lockable_d_object_8cpp_source.html">LockableDObject.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="class_lockable_d_object.html">LockableDObject</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|