tboudreaux/SERiF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(docs): rebuilt docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-06-11 11:41:55 -04:00
parent 1e5938df0d
commit f0e1840c91
138 changed files with 18404 additions and 7317 deletions
Download Patch File Download Diff File Expand all files Collapse all files

113
docs/html/_lockable_d_object_8h_source.html
View File

@@ -5,7 +5,7 @@
<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>New 4DSSE Code: src/dobj/public/LockableDObject.h Source File</title>
<title>SERiF: src/dobj/public/LockableDObject.h Source File</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>
@@ -18,12 +18,9 @@
<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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { init_search(); });
/* @license-end */
</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! -->
@@ -32,21 +29,10 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">New 4DSSE Code<span id="projectnumber">&#160;0.0.1a</span>
<div id="projectname">SERiF<span id="projectnumber">&#160;0.0.1a</span>
</div>
<div id="projectbrief">3+1D Stellar Structure and Evolution</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="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.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
@@ -63,6 +49,17 @@ var searchBox = new SearchBox("searchBox", "search/",'.html');
$(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&amp;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">
@@ -105,36 +102,58 @@ $(function(){initNavTree('_lockable_d_object_8h_source.html',''); initResizable(
<div class="headertitle"><div class="title">LockableDObject.h</div></div>
</div><!--header-->
<div class="contents">
<a href="_lockable_d_object_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef LOCKABLE_DOBJECT_H</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define LOCKABLE_DOBJECT_H</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &quot;<a class="code" href="_d_object_8h.html">DObject.h</a>&quot;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;mutex&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span></div>
<div class="foldopen" id="foldopen00019" data-start="{" data-end="};">
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="class_lockable_d_object.html"> 19</a></span><span class="keyword">class </span><a class="code hl_function" href="class_lockable_d_object.html#ae1a174a2740fa053626fe2820ee0efee">LockableDObject</a> {</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="class_lockable_d_object.html#ae1a174a2740fa053626fe2820ee0efee"> 24</a></span> <a class="code hl_function" href="class_lockable_d_object.html#ae1a174a2740fa053626fe2820ee0efee">LockableDObject</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <a class="code hl_class" href="class_d_object.html">DObject</a>&amp; <a class="code hl_function" href="class_lockable_d_object.html#adcfe201fc728cc1c6fcf638a566ba9a1">get</a>();</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_lockable_d_object.html#ade38ca54703913359fc3b4366f6e292a">lock</a>();</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_lockable_d_object.html#a1481ed99dcd837490bf28309aadaedfb">unlock</a>();</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <a class="code hl_class" href="class_d_object.html">DObject</a> object_; </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> std::mutex mutex_; </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span>};</div>
<a href="_lockable_d_object_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/* ***********************************************************************</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">//</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// Copyright (C) 2025 -- The 4D-STAR Collaboration</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">// File Author: Emily Boudreaux</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">// Last Modified: March 17, 2025</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">//</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment">// 4DSSE is free software; you can use it and/or modify</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">// it under the terms and restrictions the GNU General Library Public</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">// License version 3 (GPLv3) as published by the Free Software Foundation.</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">//</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// 4DSSE is distributed in the hope that it will be useful,</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment">// See the GNU Library General Public License for more details.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment">//</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">// You should have received a copy of the GNU Library General Public License</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">// along with this software; if not, write to the Free Software</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment">//</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">// *********************************************************************** */</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#ifndef LOCKABLE_DOBJECT_H</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#define LOCKABLE_DOBJECT_H</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &quot;<a class="code" href="_d_object_8h.html">DObject.h</a>&quot;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;mutex&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span></div>
<div class="foldopen" id="foldopen00039" data-start="{" data-end="};">
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="class_lockable_d_object.html"> 39</a></span><span class="keyword">class </span><a class="code hl_function" href="class_lockable_d_object.html#ae1a174a2740fa053626fe2820ee0efee">LockableDObject</a> {</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="class_lockable_d_object.html#ae1a174a2740fa053626fe2820ee0efee"> 44</a></span> <a class="code hl_function" href="class_lockable_d_object.html#ae1a174a2740fa053626fe2820ee0efee">LockableDObject</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <a class="code hl_class" href="class_d_object.html">DObject</a>&amp; <a class="code hl_function" href="class_lockable_d_object.html#adcfe201fc728cc1c6fcf638a566ba9a1">get</a>();</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_lockable_d_object.html#ade38ca54703913359fc3b4366f6e292a">lock</a>();</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_lockable_d_object.html#a1481ed99dcd837490bf28309aadaedfb">unlock</a>();</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="class_lockable_d_object.html#a1eb1ca1d9cf979dcb9eead96054b89bb"> 63</a></span> <a class="code hl_class" href="class_d_object.html">DObject</a> <a class="code hl_variable" href="class_lockable_d_object.html#a1eb1ca1d9cf979dcb9eead96054b89bb">object_</a>; </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="class_lockable_d_object.html#a712cd3ea0c565f7e9089a651ef79b7bd"> 64</a></span> std::mutex <a class="code hl_variable" href="class_lockable_d_object.html#a712cd3ea0c565f7e9089a651ef79b7bd">mutex_</a>; </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span>};</div>
</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="preprocessor">#endif </span><span class="comment">// LOCKABLE_DOBJECT_H</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="preprocessor">#endif </span><span class="comment">// LOCKABLE_DOBJECT_H</span></div>
<div class="ttc" id="a_d_object_8h_html"><div class="ttname"><a href="_d_object_8h.html">DObject.h</a></div><div class="ttdoc">Defines the DObject class, a universal data container for the project.</div></div>
<div class="ttc" id="aclass_d_object_html"><div class="ttname"><a href="class_d_object.html">DObject</a></div><div class="ttdoc">A universal data container class.</div><div class="ttdef"><b>Definition</b> DObject.h:29</div></div>
<div class="ttc" id="aclass_lockable_d_object_html_a1481ed99dcd837490bf28309aadaedfb"><div class="ttname"><a href="class_lockable_d_object.html#a1481ed99dcd837490bf28309aadaedfb">LockableDObject::unlock</a></div><div class="ttdeci">void unlock()</div><div class="ttdoc">Unlocks the mutex after thread-safe access.</div><div class="ttdef"><b>Definition</b> LockableDObject.cpp:20</div></div>
<div class="ttc" id="aclass_lockable_d_object_html_adcfe201fc728cc1c6fcf638a566ba9a1"><div class="ttname"><a href="class_lockable_d_object.html#adcfe201fc728cc1c6fcf638a566ba9a1">LockableDObject::get</a></div><div class="ttdeci">DObject &amp; get()</div><div class="ttdoc">Access the underlying DObject.</div><div class="ttdef"><b>Definition</b> LockableDObject.cpp:6</div></div>
<div class="ttc" id="aclass_lockable_d_object_html_ade38ca54703913359fc3b4366f6e292a"><div class="ttname"><a href="class_lockable_d_object.html#ade38ca54703913359fc3b4366f6e292a">LockableDObject::lock</a></div><div class="ttdeci">void lock()</div><div class="ttdoc">Locks the mutex to ensure thread-safe access.</div><div class="ttdef"><b>Definition</b> LockableDObject.cpp:13</div></div>
<div class="ttc" id="aclass_d_object_html"><div class="ttname"><a href="class_d_object.html">DObject</a></div><div class="ttdoc">A universal data container class.</div><div class="ttdef"><b>Definition</b> <a href="_d_object_8h_source.html#l00089">DObject.h:89</a></div></div>
<div class="ttc" id="aclass_lockable_d_object_html_a1481ed99dcd837490bf28309aadaedfb"><div class="ttname"><a href="class_lockable_d_object.html#a1481ed99dcd837490bf28309aadaedfb">LockableDObject::unlock</a></div><div class="ttdeci">void unlock()</div><div class="ttdoc">Unlocks the mutex after thread-safe access.</div><div class="ttdef"><b>Definition</b> <a href="_lockable_d_object_8cpp_source.html#l00040">LockableDObject.cpp:40</a></div></div>
<div class="ttc" id="aclass_lockable_d_object_html_a1eb1ca1d9cf979dcb9eead96054b89bb"><div class="ttname"><a href="class_lockable_d_object.html#a1eb1ca1d9cf979dcb9eead96054b89bb">LockableDObject::object_</a></div><div class="ttdeci">DObject object_</div><div class="ttdoc">The underlying DObject instance.</div><div class="ttdef"><b>Definition</b> <a href="#l00063">LockableDObject.h:63</a></div></div>
<div class="ttc" id="aclass_lockable_d_object_html_a712cd3ea0c565f7e9089a651ef79b7bd"><div class="ttname"><a href="class_lockable_d_object.html#a712cd3ea0c565f7e9089a651ef79b7bd">LockableDObject::mutex_</a></div><div class="ttdeci">std::mutex mutex_</div><div class="ttdoc">Mutex for thread-safe access.</div><div class="ttdef"><b>Definition</b> <a href="#l00064">LockableDObject.h:64</a></div></div>
<div class="ttc" id="aclass_lockable_d_object_html_adcfe201fc728cc1c6fcf638a566ba9a1"><div class="ttname"><a href="class_lockable_d_object.html#adcfe201fc728cc1c6fcf638a566ba9a1">LockableDObject::get</a></div><div class="ttdeci">DObject &amp; get()</div><div class="ttdoc">Access the underlying DObject.</div><div class="ttdef"><b>Definition</b> <a href="_lockable_d_object_8cpp_source.html#l00026">LockableDObject.cpp:26</a></div></div>
<div class="ttc" id="aclass_lockable_d_object_html_ade38ca54703913359fc3b4366f6e292a"><div class="ttname"><a href="class_lockable_d_object.html#ade38ca54703913359fc3b4366f6e292a">LockableDObject::lock</a></div><div class="ttdeci">void lock()</div><div class="ttdoc">Locks the mutex to ensure thread-safe access.</div><div class="ttdef"><b>Definition</b> <a href="_lockable_d_object_8cpp_source.html#l00033">LockableDObject.cpp:33</a></div></div>
<div class="ttc" id="aclass_lockable_d_object_html_ae1a174a2740fa053626fe2820ee0efee"><div class="ttname"><a href="class_lockable_d_object.html#ae1a174a2740fa053626fe2820ee0efee">LockableDObject::LockableDObject</a></div><div class="ttdeci">LockableDObject()=default</div><div class="ttdoc">Default constructor.</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->