tboudreaux/SERiF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
620f3d495c82dab5e65d89fee743448b971c4eb9
SERiF/docs/html/_d_object_8h_source.html

245 lines
32 KiB
HTML
Raw Normal View History

docs(Doxyfile,docs): added doxygen config and initial built doc
2025-01-19 12:24:13 -05:00
<!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"/>
docs(docs): rebuilt docs
2025-06-11 11:41:55 -04:00
<title>SERiF: src/dobj/public/DObject.h Source File</title>
docs(Doxyfile,docs): added doxygen config and initial built doc
2025-01-19 12:24:13 -05:00
<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" />
docs(docs): rebuilt docs
2025-06-11 11:41:55 -04:00
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
docs(Doxyfile,docs): added doxygen config and initial built doc
2025-01-19 12:24:13 -05:00
</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">
docs(docs): rebuilt docs
2025-06-11 11:41:55 -04:00
<div id="projectname">SERiF<span id="projectnumber">&#160;0.0.1a</span>
docs(Doxyfile,docs): added doxygen config and initial built doc
2025-01-19 12:24:13 -05:00
</div>
docs(docs): rebuilt docs
2025-06-11 11:41:55 -04:00
<div id="projectbrief">3+1D Stellar Structure and Evolution</div>
docs(Doxyfile,docs): added doxygen config and initial built doc
2025-01-19 12:24:13 -05:00
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
docs(docs): rebuilt docs
2025-06-11 11:41:55 -04:00
<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>
docs(Doxyfile,docs): added doxygen config and initial built doc
2025-01-19 12:24:13 -05:00
</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&amp;dn=expat.txt MIT */
$(function(){initNavTree('_d_object_8h_source.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="headertitle"><div class="title">DObject.h</div></div>
</div><!--header-->
<div class="contents">
docs(docs): rebuilt docs
2025-06-11 11:41:55 -04:00
<a href="_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 DOBJECT_H</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#define 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 &lt;variant&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include &lt;mutex&gt;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include &lt;map&gt;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include &lt;functional&gt;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span></div>
<div class="foldopen" id="foldopen00089" data-start="{" data-end="};">
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="class_d_object.html"> 89</a></span><span class="keyword">class </span><a class="code hl_function" href="class_d_object.html#a0ae54853e18265657296bfb5ac3bf9d0">DObject</a> {</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="class_d_object.html#a55b7cdac36a3a518ba6e1ecef0e25dcd"> 97</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="class_d_object.html#a55b7cdac36a3a518ba6e1ecef0e25dcd">DataType</a> = std::variant&lt;</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> bool, <span class="keywordtype">short</span> int, int, <span class="keywordtype">long</span> int, float, double, </div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keywordtype">long</span> double, std::string, std::monostate, std::vector&lt;int&gt;,</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> std::vector&lt;float&gt;, std::vector&lt;double&gt;, std::vector&lt;std::string&gt;,</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> std::vector&lt;std::vector&lt;int&gt;&gt;, std::vector&lt;std::vector&lt;float&gt;&gt;,</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> std::vector&lt;std::vector&lt;double&gt;&gt;,</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> std::vector&lt;std::vector&lt;std::vector&lt;int&gt;&gt;&gt;,</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> std::vector&lt;std::vector&lt;std::vector&lt;float&gt;&gt;&gt;,</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> std::vector&lt;std::vector&lt;std::vector&lt;double&gt;&gt;&gt;</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> &gt;;</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> </div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <span class="comment">// Mapping of data types to their string representations</span></div>
<div class="foldopen" id="foldopen00109" data-start="{" data-end="};">
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"><a class="line" href="class_d_object.html#a358d5f015da09ae5f0cbb46f3fd9e401"> 109</a></span> std::map&lt;int, std::string&gt; <a class="code hl_variable" href="class_d_object.html#a358d5f015da09ae5f0cbb46f3fd9e401">dataTypeMap</a> = {</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> {0, <span class="stringliteral">&quot;bool&quot;</span>}, {1, <span class="stringliteral">&quot;short int&quot;</span>}, {2, <span class="stringliteral">&quot;int&quot;</span>}, {3, <span class="stringliteral">&quot;long int&quot;</span>}, {4, <span class="stringliteral">&quot;float&quot;</span>},</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> {5, <span class="stringliteral">&quot;double&quot;</span>}, {6, <span class="stringliteral">&quot;long double&quot;</span>}, {7, <span class="stringliteral">&quot;string&quot;</span>}, {8, <span class="stringliteral">&quot;std::monostate&quot;</span>},</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> {9, <span class="stringliteral">&quot;vector&lt;int&gt;&quot;</span>}, {10, <span class="stringliteral">&quot;vector&lt;float&gt;&quot;</span>}, {11, <span class="stringliteral">&quot;vector&lt;double&gt;&quot;</span>},</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> {12, <span class="stringliteral">&quot;vector&lt;string&gt;&quot;</span>}, {13, <span class="stringliteral">&quot;vector&lt;vector&lt;int&gt;&quot;</span>},</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> {14, <span class="stringliteral">&quot;vector&lt;vector&lt;float&gt;&quot;</span>}, {15, <span class="stringliteral">&quot;vector&lt;vector&lt;double&gt;&quot;</span>},</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> {16, <span class="stringliteral">&quot;vector&lt;vector&lt;vector&lt;int&gt;&gt;&quot;</span>}, {17, <span class="stringliteral">&quot;vector&lt;vector&lt;vector&lt;float&gt;&gt;&quot;</span>},</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> {18, <span class="stringliteral">&quot;vector&lt;vector&lt;vector&lt;double&gt;&gt;&quot;</span>}</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> };</div>
</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"><a class="line" href="class_d_object.html#af11334d08ef85c68b3aae7554548e5a7"> 125</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="class_d_object.html#af11334d08ef85c68b3aae7554548e5a7">Plugin</a> = std::function&lt;void(<a class="code hl_function" href="class_d_object.html#a0ae54853e18265657296bfb5ac3bf9d0">DObject</a>&amp;)&gt;;</div>
docs(Doxyfile,docs): added doxygen config and initial built doc
2025-01-19 12:24:13 -05:00
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span></div>
docs(docs): rebuilt docs
2025-06-11 11:41:55 -04:00
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> <a class="code hl_function" href="class_d_object.html#a0ae54853e18265657296bfb5ac3bf9d0">DObject</a>();</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> <a class="code hl_function" href="class_d_object.html#a0ae54853e18265657296bfb5ac3bf9d0">DObject</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="class_d_object.html#a55b7cdac36a3a518ba6e1ecef0e25dcd">DataType</a>&amp; data);</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> <span class="keyword">const</span> <a class="code hl_typedef" href="class_d_object.html#a55b7cdac36a3a518ba6e1ecef0e25dcd">DataType</a>&amp; <a class="code hl_function" href="class_d_object.html#a4862655c3634d019b0a45b811d6f7235">getData</a>() const noexcept;</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> template &lt;typename T&gt;</div>
<div class="foldopen" id="foldopen00156" data-start="{" data-end="}">
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"><a class="line" href="class_d_object.html#aca2db093c1c8c6f7893de07544aed619"> 156</a></span> T <a class="code hl_function" href="class_d_object.html#aca2db093c1c8c6f7893de07544aed619">getDataAs</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> <span class="keywordflow">if</span> (std::holds_alternative&lt;T&gt;(<a class="code hl_variable" href="class_d_object.html#ad7ba02f6d87ce64792149096f3310b21">data_</a>)) {</div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> <span class="keywordflow">return</span> std::get&lt;T&gt;(<a class="code hl_variable" href="class_d_object.html#ad7ba02f6d87ce64792149096f3310b21">data_</a>);</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> } <span class="keywordflow">else</span> {</div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> <span class="keywordflow">throw</span> std::bad_variant_access();</div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> }</div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> }</div>
</div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_d_object.html#ab1718571434e84e90f1ec463e4786a8a">setData</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="class_d_object.html#a55b7cdac36a3a518ba6e1ecef0e25dcd">DataType</a>&amp; data);</div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_d_object.html#a6f0023aee463e71d92442dcf61b6ed47">setDebugging</a>(<span class="keywordtype">bool</span> enableDebug);</div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_d_object.html#ae47bf220fbe2173cf6933c2380035dbd">isDebuggingEnabled</a>() const noexcept;</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> <span class="keywordtype">int</span> <a class="code hl_function" href="class_d_object.html#a3dce47a519f9da5085c0c5ac1eea4f38">setErrorCode</a>(<span class="keywordtype">int</span> code) noexcept;</div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno"> 201</span> <span class="keywordtype">int</span> <a class="code hl_function" href="class_d_object.html#afa8926d916081de72478cb8813c25e98">getErrorCode</a>() const noexcept;</div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno"> 202</span> </div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno"> 203</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_d_object.html#a15afffdf339150fc872bf63bdd08d581">registerPlugin</a>(const std::<span class="keywordtype">string</span>&amp; <span class="keywordtype">id</span>, <a class="code hl_typedef" href="class_d_object.html#af11334d08ef85c68b3aae7554548e5a7">Plugin</a> plugin);</div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span></div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_d_object.html#a99b8688849e11501033a25f61efb8356">unregisterPlugin</a>(const std::<span class="keywordtype">string</span>&amp; <span class="keywordtype">id</span>);</div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span></div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_d_object.html#a99072eb52bb22745f0248f273fbf28fb">runPlugin</a>(const std::<span class="keywordtype">string</span>&amp; <span class="keywordtype">id</span>);</div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span></div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno"> 237</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_d_object.html#a1223275dcbbf20334ea11707346acb93">runAllPlugins</a>();</div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</span></div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno"> 248</span> friend std::ostream&amp; operator&lt;&lt;(std::ostream&amp; os, const <a class="code hl_class" href="class_d_object.html">DObject</a>&amp; obj);</div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno"> 249</span> </div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno"> 250</span>private:</div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno"><a class="line" href="class_d_object.html#ad7ba02f6d87ce64792149096f3310b21"> 251</a></span> <a class="code hl_typedef" href="class_d_object.html#a55b7cdac36a3a518ba6e1ecef0e25dcd">DataType</a> <a class="code hl_variable" href="class_d_object.html#ad7ba02f6d87ce64792149096f3310b21">data_</a>; </div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno"><a class="line" href="class_d_object.html#accf5c10d4afc3969607e11b0055312d5"> 252</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="class_d_object.html#accf5c10d4afc3969607e11b0055312d5">debugEnabled_</a> = false; </div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno"><a class="line" href="class_d_object.html#ad8de5890e8dae5fc7e72fabca2520fc3"> 253</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="class_d_object.html#ad8de5890e8dae5fc7e72fabca2520fc3">errorCode_</a> = 0; </div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno"><a class="line" href="class_d_object.html#ae9f7e4d2fbabc076961a40185676e208"> 254</a></span> std::map&lt;std::<span class="keywordtype">string</span>, <a class="code hl_typedef" href="class_d_object.html#af11334d08ef85c68b3aae7554548e5a7">Plugin</a>&gt; <a class="code hl_variable" href="class_d_object.html#ae9f7e4d2fbabc076961a40185676e208">plugins_</a>; </div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno"> 255</span>};</div>
docs(Doxyfile,docs): added doxygen config and initial built doc
2025-01-19 12:24:13 -05:00
</div>
docs(docs): rebuilt docs
2025-06-11 11:41:55 -04:00
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno"> 256</span> </div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno"> 257</span><span class="preprocessor">#endif </span><span class="comment">// DOBJECT_H</span></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="#l00089">DObject.h:89</a></div></div>
<div class="ttc" id="aclass_d_object_html_a0ae54853e18265657296bfb5ac3bf9d0"><div class="ttname"><a href="class_d_object.html#a0ae54853e18265657296bfb5ac3bf9d0">DObject::DObject</a></div><div class="ttdeci">DObject()</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition</b> <a href="_d_object_8cpp_source.html#l00033">DObject.cpp:33</a></div></div>
<div class="ttc" id="aclass_d_object_html_a1223275dcbbf20334ea11707346acb93"><div class="ttname"><a href="class_d_object.html#a1223275dcbbf20334ea11707346acb93">DObject::runAllPlugins</a></div><div class="ttdeci">void runAllPlugins()</div><div class="ttdoc">Executes all registered plugins in the registry.</div><div class="ttdef"><b>Definition</b> <a href="_d_object_8cpp_source.html#l00117">DObject.cpp:117</a></div></div>
<div class="ttc" id="aclass_d_object_html_a15afffdf339150fc872bf63bdd08d581"><div class="ttname"><a href="class_d_object.html#a15afffdf339150fc872bf63bdd08d581">DObject::registerPlugin</a></div><div class="ttdeci">void registerPlugin(const std::string &amp;id, Plugin plugin)</div><div class="ttdoc">Registers a plugin with the DObject.</div><div class="ttdef"><b>Definition</b> <a href="_d_object_8cpp_source.html#l00087">DObject.cpp:87</a></div></div>
<div class="ttc" id="aclass_d_object_html_a358d5f015da09ae5f0cbb46f3fd9e401"><div class="ttname"><a href="class_d_object.html#a358d5f015da09ae5f0cbb46f3fd9e401">DObject::dataTypeMap</a></div><div class="ttdeci">std::map&lt; int, std::string &gt; dataTypeMap</div><div class="ttdef"><b>Definition</b> <a href="#l00109">DObject.h:109</a></div></div>
<div class="ttc" id="aclass_d_object_html_a3dce47a519f9da5085c0c5ac1eea4f38"><div class="ttname"><a href="class_d_object.html#a3dce47a519f9da5085c0c5ac1eea4f38">DObject::setErrorCode</a></div><div class="ttdeci">int setErrorCode(int code) noexcept</div><div class="ttdef"><b>Definition</b> <a href="_d_object_8cpp_source.html#l00074">DObject.cpp:74</a></div></div>
<div class="ttc" id="aclass_d_object_html_a4862655c3634d019b0a45b811d6f7235"><div class="ttname"><a href="class_d_object.html#a4862655c3634d019b0a45b811d6f7235">DObject::getData</a></div><div class="ttdeci">const DataType &amp; getData() const noexcept</div><div class="ttdoc">Retrieves the data stored in the DObject.</div><div class="ttdef"><b>Definition</b> <a href="_d_object_8cpp_source.html#l00046">DObject.cpp:46</a></div></div>
<div class="ttc" id="aclass_d_object_html_a55b7cdac36a3a518ba6e1ecef0e25dcd"><div class="ttname"><a href="class_d_object.html#a55b7cdac36a3a518ba6e1ecef0e25dcd">DObject::DataType</a></div><div class="ttdeci">std::variant&lt; bool, short int, int, long int, float, double, long double, std::string, std::monostate, std::vector&lt; int &gt;, std::vector&lt; float &gt;, std::vector&lt; double &gt;, std::vector&lt; std::string &gt;, std::vector&lt; std::vector&lt; int &gt; &gt;, std::vector&lt; std::vector&lt; float &gt; &gt;, std::vector&lt; std::vector&lt; double &gt; &gt;, std::vector&lt; std::vector&lt; std::vector&lt; int &gt; &gt; &gt;, std::vector&lt; std::vector&lt; std::vector&lt; float &gt; &gt; &gt;, std::vector&lt; std::vector&lt; std::vector&lt; double &gt; &gt; &gt; &gt; DataType</div><div class="ttdoc">Supported data types for the DObject.</div><div class="ttdef"><b>Definition</b> <a href="#l00097">DObject.h:97</a></div></div>
<div class="ttc" id="aclass_d_object_html_a6f0023aee463e71d92442dcf61b6ed47"><div class="ttname"><a href="class_d_object.html#a6f0023aee463e71d92442dcf61b6ed47">DObject::setDebugging</a></div><div class="ttdeci">void setDebugging(bool enableDebug)</div><div class="ttdoc">Enables or disables debugging and tracing for the DObject.</div><div class="ttdef"><b>Definition</b> <a href="_d_object_8cpp_source.html#l00060">DObject.cpp:60</a></div></div>
<div class="ttc" id="aclass_d_object_html_a99072eb52bb22745f0248f273fbf28fb"><div class="ttname"><a href="class_d_object.html#a99072eb52bb22745f0248f273fbf28fb">DObject::runPlugin</a></div><div class="ttdeci">void runPlugin(const std::string &amp;id)</div><div class="ttdoc">Executes a plugin by its identifier.</div><div class="ttdef"><b>Definition</b> <a href="_d_object_8cpp_source.html#l00106">DObject.cpp:106</a></div></div>
<div class="ttc" id="aclass_d_object_html_a99b8688849e11501033a25f61efb8356"><div class="ttname"><a href="class_d_object.html#a99b8688849e11501033a25f61efb8356">DObject::unregisterPlugin</a></div><div class="ttdeci">void unregisterPlugin(const std::string &amp;id)</div><div class="ttdoc">Unregisters a plugin by its identifier.</div><div class="ttdef"><b>Definition</b> <a href="_d_object_8cpp_source.html#l00097">DObject.cpp:97</a></div></div>
<div class="ttc" id="aclass_d_object_html_ab1718571434e84e90f1ec463e4786a8a"><div class="ttname"><a href="class_d_object.html#ab1718571434e84e90f1ec463e4786a8a">DObject::setData</a></div><div class="ttdeci">void setData(const DataType &amp;data)</div><div class="ttdoc">Sets the data for the DObject.</div><div class="ttdef"><b>Definition</b> <a href="_d_object_8cpp_source.html#l00053">DObject.cpp:53</a></div></div>
<div class="ttc" id="aclass_d_object_html_aca2db093c1c8c6f7893de07544aed619"><div class="ttname"><a href="class_d_object.html#aca2db093c1c8c6f7893de07544aed619">DObject::getDataAs</a></div><div class="ttdeci">T getDataAs() const</div><div class="ttdoc">Retrieves the data stored in the DObject as a typed object so that std::get&lt;T&gt;() is not needed.</div><div class="ttdef"><b>Definition</b> <a href="#l00156">DObject.h:156</a></div></div>
<div class="ttc" id="aclass_d_object_html_accf5c10d4afc3969607e11b0055312d5"><div class="ttname"><a href="class_d_object.html#accf5c10d4afc3969607e11b0055312d5">DObject::debugEnabled_</a></div><div class="ttdeci">bool debugEnabled_</div><div class="ttdoc">Indicates whether debugging is enabled.</div><div class="ttdef"><b>Definition</b> <a href="#l00252">DObject.h:252</a></div></div>
<div class="ttc" id="aclass_d_object_html_ad7ba02f6d87ce64792149096f3310b21"><div class="ttname"><a href="class_d_object.html#ad7ba02f6d87ce64792149096f3310b21">DObject::data_</a></div><div class="ttdeci">DataType data_</div><div class="ttdoc">The main data stored in the DObject.</div><div class="ttdef"><b>Definition</b> <a href="#l00251">DObject.h:251</a></div></div>
<div class="ttc" id="aclass_d_object_html_ad8de5890e8dae5fc7e72fabca2520fc3"><div class="ttname"><a href="class_d_object.html#ad8de5890e8dae5fc7e72fabca2520fc3">DObject::errorCode_</a></div><div class="ttdeci">int errorCode_</div><div class="ttdoc">Error code tracked by the DObject.</div><div class="ttdef"><b>Definition</b> <a href="#l00253">DObject.h:253</a></div></div>
<div class="ttc" id="aclass_d_object_html_ae47bf220fbe2173cf6933c2380035dbd"><div class="ttname"><a href="class_d_object.html#ae47bf220fbe2173cf6933c2380035dbd">DObject::isDebuggingEnabled</a></div><div class="ttdeci">bool isDebuggingEnabled() const noexcept</div><div class="ttdoc">Checks if debugging is enabled for the DObject.</div><div class="ttdef"><b>Definition</b> <a href="_d_object_8cpp_source.html#l00067">DObject.cpp:67</a></div></div>
<div class="ttc" id="aclass_d_object_html_ae9f7e4d2fbabc076961a40185676e208"><div class="ttname"><a href="class_d_object.html#ae9f7e4d2fbabc076961a40185676e208">DObject::plugins_</a></div><div class="ttdeci">std::map&lt; std::string, Plugin &gt; plugins_</div><div class="ttdoc">Registry for dynamically registered plugins.</div><div class="ttdef"><b>Definition</b> <a href="#l00254">DObject.h:254</a></div></div>
<div class="ttc" id="aclass_d_object_html_af11334d08ef85c68b3aae7554548e5a7"><div class="ttname"><a href="class_d_object.html#af11334d08ef85c68b3aae7554548e5a7">DObject::Plugin</a></div><div class="ttdeci">std::function&lt; void(DObject &amp;)&gt; Plugin</div><div class="ttdoc">Placeholder type for plugins.</div><div class="ttdef"><b>Definition</b> <a href="#l00125">DObject.h:125</a></div></div>
<div class="ttc" id="aclass_d_object_html_afa8926d916081de72478cb8813c25e98"><div class="ttname"><a href="class_d_object.html#afa8926d916081de72478cb8813c25e98">DObject::getErrorCode</a></div><div class="ttdeci">int getErrorCode() const noexcept</div><div class="ttdoc">Get the error code tracked by the DObject.</div><div class="ttdef"><b>Definition</b> <a href="_d_object_8cpp_source.html#l00080">DObject.cpp:80</a></div></div>
docs(Doxyfile,docs): added doxygen config and initial built doc
2025-01-19 12:24:13 -05:00
</div><!-- fragment --></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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_768194193337d64eaa7edd2c5f5038a4.html">dobj</a></li><li class="navelem"><a class="el" href="dir_5657658ab0dc14c9c63c088cb1f6321c.html">public</a></li><li class="navelem"><a class="el" href="_d_object_8h.html">DObject.h</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>
Reference in New Issue Copy Permalink