192 lines
21 KiB
HTML
192 lines
21 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>New 4DSSE Code: src/dobj/public/DObject.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>
|
|
<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>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { init_search(); });
|
|
/* @license-end */
|
|
</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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">New 4DSSE Code<span id="projectnumber"> 0.0.1a</span>
|
|
</div>
|
|
</td>
|
|
<td> <div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </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>
|
|
</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>
|
|
</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('_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">
|
|
<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="preprocessor">#ifndef DOBJECT_H</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define 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 "<a class="code" href="_metadata_8h.html">Metadata.h</a>"</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <variant></span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include <mutex></span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include <map></span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include <functional></span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span></div>
|
|
<div class="foldopen" id="foldopen00029" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="class_d_object.html"> 29</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="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="class_d_object.html#ad6fc2e29eae70cf94a2d241527857573"> 37</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="class_d_object.html#ad6fc2e29eae70cf94a2d241527857573">DataType</a> = std::variant<</div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> int, float, double, std::string, std::monostate,</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> std::vector<int>, std::vector<float>, std::vector<double></div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> >;</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span></div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="class_d_object.html#af11334d08ef85c68b3aae7554548e5a7"> 47</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="class_d_object.html#af11334d08ef85c68b3aae7554548e5a7">Plugin</a> = std::function<void(<a class="code hl_function" href="class_d_object.html#a0ae54853e18265657296bfb5ac3bf9d0">DObject</a>&)>;</div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span></div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <a class="code hl_function" href="class_d_object.html#a0ae54853e18265657296bfb5ac3bf9d0">DObject</a>();</div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span></div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</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#ad6fc2e29eae70cf94a2d241527857573">DataType</a>& data, <span class="keyword">const</span> <a class="code hl_class" href="class_metadata.html">Metadata</a>& metadata);</div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span></div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">const</span> <a class="code hl_typedef" href="class_d_object.html#ad6fc2e29eae70cf94a2d241527857573">DataType</a>& <a class="code hl_function" href="class_d_object.html#a4862655c3634d019b0a45b811d6f7235">getData</a>() const noexcept;</div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span></div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_d_object.html#ab1718571434e84e90f1ec463e4786a8a">setData</a>(const <a class="code hl_typedef" href="class_d_object.html#ad6fc2e29eae70cf94a2d241527857573">DataType</a>& data);</div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span></div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> const <a class="code hl_class" href="class_metadata.html">Metadata</a>& <a class="code hl_function" href="class_d_object.html#a157b31e881aac6dd40782d3abc561d4e">getMetadata</a>() const noexcept;</div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span></div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_d_object.html#a296b1519249fdc1f6c7b4ab62d5421bc">setMetadata</a>(const <a class="code hl_class" href="class_metadata.html">Metadata</a>& metadata);</div>
|
|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span></div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</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="l00109" name="l00109"></a><span class="lineno"> 109</span></div>
|
|
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> [[nodiscard]] <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="l00116" name="l00116"></a><span class="lineno"> 116</span></div>
|
|
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</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>& <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="l00126" name="l00126"></a><span class="lineno"> 126</span></div>
|
|
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</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>& <span class="keywordtype">id</span>);</div>
|
|
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span></div>
|
|
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</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>& <span class="keywordtype">id</span>);</div>
|
|
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span></div>
|
|
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</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="l00151" name="l00151"></a><span class="lineno"> 151</span></div>
|
|
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"><a class="line" href="class_d_object.html#aa54e75574f0302a2ca7252f9f0f0b3f1"> 161</a></span> friend std::ostream& operator<<(std::ostream& os, const <a class="code hl_function" href="class_d_object.html#a0ae54853e18265657296bfb5ac3bf9d0">DObject</a>& obj);</div>
|
|
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> </div>
|
|
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span>private:</div>
|
|
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> <a class="code hl_typedef" href="class_d_object.html#ad6fc2e29eae70cf94a2d241527857573">DataType</a> data_; </div>
|
|
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span> <a class="code hl_class" href="class_metadata.html">Metadata</a> metadata_; </div>
|
|
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span> <span class="keywordtype">bool</span> debugEnabled_ = false; </div>
|
|
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> std::map<std::<span class="keywordtype">string</span>, <a class="code hl_typedef" href="class_d_object.html#af11334d08ef85c68b3aae7554548e5a7">Plugin</a>> plugins_; </div>
|
|
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> </div>
|
|
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span><span class="preprocessor">#endif </span><span class="comment">// DOBJECT_H</span></div>
|
|
<div class="ttc" id="a_metadata_8h_html"><div class="ttname"><a href="_metadata_8h.html">Metadata.h</a></div><div class="ttdoc">Public interface for the Metadata class used in the dobj module.</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> DObject.cpp:13</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> DObject.cpp:99</div></div>
|
|
<div class="ttc" id="aclass_d_object_html_a157b31e881aac6dd40782d3abc561d4e"><div class="ttname"><a href="class_d_object.html#a157b31e881aac6dd40782d3abc561d4e">DObject::getMetadata</a></div><div class="ttdeci">const Metadata & getMetadata() const noexcept</div><div class="ttdoc">Retrieves the metadata associated with the DObject.</div><div class="ttdef"><b>Definition</b> DObject.cpp:41</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 &id, Plugin plugin)</div><div class="ttdoc">Registers a plugin with the DObject.</div><div class="ttdef"><b>Definition</b> DObject.cpp:69</div></div>
|
|
<div class="ttc" id="aclass_d_object_html_a296b1519249fdc1f6c7b4ab62d5421bc"><div class="ttname"><a href="class_d_object.html#a296b1519249fdc1f6c7b4ab62d5421bc">DObject::setMetadata</a></div><div class="ttdeci">void setMetadata(const Metadata &metadata)</div><div class="ttdoc">Updates the metadata for the DObject.</div><div class="ttdef"><b>Definition</b> DObject.cpp:48</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 & getData() const noexcept</div><div class="ttdoc">Retrieves the data stored in the DObject.</div><div class="ttdef"><b>Definition</b> DObject.cpp:26</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> DObject.cpp:55</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 &id)</div><div class="ttdoc">Executes a plugin by its identifier.</div><div class="ttdef"><b>Definition</b> DObject.cpp:88</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 &id)</div><div class="ttdoc">Unregisters a plugin by its identifier.</div><div class="ttdef"><b>Definition</b> DObject.cpp:79</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 &data)</div><div class="ttdoc">Sets the data for the DObject.</div><div class="ttdef"><b>Definition</b> DObject.cpp:33</div></div>
|
|
<div class="ttc" id="aclass_d_object_html_ad6fc2e29eae70cf94a2d241527857573"><div class="ttname"><a href="class_d_object.html#ad6fc2e29eae70cf94a2d241527857573">DObject::DataType</a></div><div class="ttdeci">std::variant< int, float, double, std::string, std::monostate, std::vector< int >, std::vector< float >, std::vector< double > > DataType</div><div class="ttdoc">Supported data types for the DObject.</div><div class="ttdef"><b>Definition</b> DObject.h:37</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> DObject.cpp:62</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< void(DObject &)> Plugin</div><div class="ttdoc">Placeholder type for plugins.</div><div class="ttdef"><b>Definition</b> DObject.h:47</div></div>
|
|
<div class="ttc" id="aclass_metadata_html"><div class="ttname"><a href="class_metadata.html">Metadata</a></div><div class="ttdoc">Represents metadata information for data objects in the dobj module.</div><div class="ttdef"><b>Definition</b> Metadata.h:31</div></div>
|
|
</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>
|