590 lines
33 KiB
HTML
590 lines
33 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: DObject 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>
|
|
<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('class_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-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="class_d_object-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">DObject Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A universal data container class.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_d_object_8h_source.html">DObject.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:ad6fc2e29eae70cf94a2d241527857573" id="r_ad6fc2e29eae70cf94a2d241527857573"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad6fc2e29eae70cf94a2d241527857573">DataType</a></td></tr>
|
|
<tr class="memdesc:ad6fc2e29eae70cf94a2d241527857573"><td class="mdescLeft"> </td><td class="mdescRight">Supported data types for the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. <br /></td></tr>
|
|
<tr class="separator:ad6fc2e29eae70cf94a2d241527857573"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af11334d08ef85c68b3aae7554548e5a7" id="r_af11334d08ef85c68b3aae7554548e5a7"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#af11334d08ef85c68b3aae7554548e5a7">Plugin</a> = std::function<void(<a class="el" href="class_d_object.html">DObject</a>&)></td></tr>
|
|
<tr class="memdesc:af11334d08ef85c68b3aae7554548e5a7"><td class="mdescLeft"> </td><td class="mdescRight">Placeholder type for plugins. <br /></td></tr>
|
|
<tr class="separator:af11334d08ef85c68b3aae7554548e5a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><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:a0ae54853e18265657296bfb5ac3bf9d0" id="r_a0ae54853e18265657296bfb5ac3bf9d0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0ae54853e18265657296bfb5ac3bf9d0">DObject</a> ()</td></tr>
|
|
<tr class="memdesc:a0ae54853e18265657296bfb5ac3bf9d0"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a0ae54853e18265657296bfb5ac3bf9d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab0c940fa193a42158c6726bf1a2ef54d" id="r_ab0c940fa193a42158c6726bf1a2ef54d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab0c940fa193a42158c6726bf1a2ef54d">DObject</a> (const <a class="el" href="#ad6fc2e29eae70cf94a2d241527857573">DataType</a> &data, const <a class="el" href="class_metadata.html">Metadata</a> &metadata)</td></tr>
|
|
<tr class="memdesc:ab0c940fa193a42158c6726bf1a2ef54d"><td class="mdescLeft"> </td><td class="mdescRight">Constructor to initialize a <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a> with data and metadata. <br /></td></tr>
|
|
<tr class="separator:ab0c940fa193a42158c6726bf1a2ef54d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4862655c3634d019b0a45b811d6f7235" id="r_a4862655c3634d019b0a45b811d6f7235"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="#ad6fc2e29eae70cf94a2d241527857573">DataType</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4862655c3634d019b0a45b811d6f7235">getData</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a4862655c3634d019b0a45b811d6f7235"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the data stored in the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. <br /></td></tr>
|
|
<tr class="separator:a4862655c3634d019b0a45b811d6f7235"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab1718571434e84e90f1ec463e4786a8a" id="r_ab1718571434e84e90f1ec463e4786a8a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab1718571434e84e90f1ec463e4786a8a">setData</a> (const <a class="el" href="#ad6fc2e29eae70cf94a2d241527857573">DataType</a> &data)</td></tr>
|
|
<tr class="memdesc:ab1718571434e84e90f1ec463e4786a8a"><td class="mdescLeft"> </td><td class="mdescRight">Sets the data for the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. <br /></td></tr>
|
|
<tr class="separator:ab1718571434e84e90f1ec463e4786a8a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a157b31e881aac6dd40782d3abc561d4e" id="r_a157b31e881aac6dd40782d3abc561d4e"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_metadata.html">Metadata</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a157b31e881aac6dd40782d3abc561d4e">getMetadata</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a157b31e881aac6dd40782d3abc561d4e"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the metadata associated with the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. <br /></td></tr>
|
|
<tr class="separator:a157b31e881aac6dd40782d3abc561d4e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a296b1519249fdc1f6c7b4ab62d5421bc" id="r_a296b1519249fdc1f6c7b4ab62d5421bc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a296b1519249fdc1f6c7b4ab62d5421bc">setMetadata</a> (const <a class="el" href="class_metadata.html">Metadata</a> &metadata)</td></tr>
|
|
<tr class="memdesc:a296b1519249fdc1f6c7b4ab62d5421bc"><td class="mdescLeft"> </td><td class="mdescRight">Updates the metadata for the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. <br /></td></tr>
|
|
<tr class="separator:a296b1519249fdc1f6c7b4ab62d5421bc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6f0023aee463e71d92442dcf61b6ed47" id="r_a6f0023aee463e71d92442dcf61b6ed47"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6f0023aee463e71d92442dcf61b6ed47">setDebugging</a> (bool enableDebug)</td></tr>
|
|
<tr class="memdesc:a6f0023aee463e71d92442dcf61b6ed47"><td class="mdescLeft"> </td><td class="mdescRight">Enables or disables debugging and tracing for the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. <br /></td></tr>
|
|
<tr class="separator:a6f0023aee463e71d92442dcf61b6ed47"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae47bf220fbe2173cf6933c2380035dbd" id="r_ae47bf220fbe2173cf6933c2380035dbd"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae47bf220fbe2173cf6933c2380035dbd">isDebuggingEnabled</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:ae47bf220fbe2173cf6933c2380035dbd"><td class="mdescLeft"> </td><td class="mdescRight">Checks if debugging is enabled for the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. <br /></td></tr>
|
|
<tr class="separator:ae47bf220fbe2173cf6933c2380035dbd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a15afffdf339150fc872bf63bdd08d581" id="r_a15afffdf339150fc872bf63bdd08d581"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a15afffdf339150fc872bf63bdd08d581">registerPlugin</a> (const std::string &id, <a class="el" href="#af11334d08ef85c68b3aae7554548e5a7">Plugin</a> plugin)</td></tr>
|
|
<tr class="memdesc:a15afffdf339150fc872bf63bdd08d581"><td class="mdescLeft"> </td><td class="mdescRight">Registers a plugin with the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. <br /></td></tr>
|
|
<tr class="separator:a15afffdf339150fc872bf63bdd08d581"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a99b8688849e11501033a25f61efb8356" id="r_a99b8688849e11501033a25f61efb8356"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a99b8688849e11501033a25f61efb8356">unregisterPlugin</a> (const std::string &id)</td></tr>
|
|
<tr class="memdesc:a99b8688849e11501033a25f61efb8356"><td class="mdescLeft"> </td><td class="mdescRight">Unregisters a plugin by its identifier. <br /></td></tr>
|
|
<tr class="separator:a99b8688849e11501033a25f61efb8356"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a99072eb52bb22745f0248f273fbf28fb" id="r_a99072eb52bb22745f0248f273fbf28fb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a99072eb52bb22745f0248f273fbf28fb">runPlugin</a> (const std::string &id)</td></tr>
|
|
<tr class="memdesc:a99072eb52bb22745f0248f273fbf28fb"><td class="mdescLeft"> </td><td class="mdescRight">Executes a plugin by its identifier. <br /></td></tr>
|
|
<tr class="separator:a99072eb52bb22745f0248f273fbf28fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1223275dcbbf20334ea11707346acb93" id="r_a1223275dcbbf20334ea11707346acb93"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1223275dcbbf20334ea11707346acb93">runAllPlugins</a> ()</td></tr>
|
|
<tr class="memdesc:a1223275dcbbf20334ea11707346acb93"><td class="mdescLeft"> </td><td class="mdescRight">Executes all registered plugins in the registry. <br /></td></tr>
|
|
<tr class="separator:a1223275dcbbf20334ea11707346acb93"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:aa54e75574f0302a2ca7252f9f0f0b3f1" id="r_aa54e75574f0302a2ca7252f9f0f0b3f1"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa54e75574f0302a2ca7252f9f0f0b3f1">operator<<</a> (std::ostream &os, const <a class="el" href="class_d_object.html">DObject</a> &obj)</td></tr>
|
|
<tr class="memdesc:aa54e75574f0302a2ca7252f9f0f0b3f1"><td class="mdescLeft"> </td><td class="mdescRight">Provides a human-readable summary of the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. <br /></td></tr>
|
|
<tr class="separator:aa54e75574f0302a2ca7252f9f0f0b3f1"><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 universal data container class. </p>
|
|
<p>The <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a> class is designed to store arbitrary data alongside descriptive metadata. It supports plugin registration to allow extensible functionality. </p>
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
<a id="ad6fc2e29eae70cf94a2d241527857573" name="ad6fc2e29eae70cf94a2d241527857573"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad6fc2e29eae70cf94a2d241527857573">◆ </a></span>DataType</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="#ad6fc2e29eae70cf94a2d241527857573">DObject::DataType</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Initial value:</b><div class="fragment"><div class="line"> std::variant<</div>
|
|
<div class="line"> int, float, double, std::string, std::monostate,</div>
|
|
<div class="line"> std::vector<int>, std::vector<float>, std::vector<double></div>
|
|
<div class="line"> ></div>
|
|
</div><!-- fragment -->
|
|
<p>Supported data types for the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. </p>
|
|
<p>This type alias uses <code>std::variant</code> to store different types of data, ensuring type safety and flexibility. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af11334d08ef85c68b3aae7554548e5a7" name="af11334d08ef85c68b3aae7554548e5a7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af11334d08ef85c68b3aae7554548e5a7">◆ </a></span>Plugin</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="#af11334d08ef85c68b3aae7554548e5a7">DObject::Plugin</a> = std::function<void(<a class="el" href="class_d_object.html">DObject</a>&)></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Placeholder type for plugins. </p>
|
|
<p>In the future, this will be replaced with a concrete interface. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a0ae54853e18265657296bfb5ac3bf9d0" name="a0ae54853e18265657296bfb5ac3bf9d0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0ae54853e18265657296bfb5ac3bf9d0">◆ </a></span>DObject() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">DObject::DObject </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
<p>Creates an empty <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a> with default metadata. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab0c940fa193a42158c6726bf1a2ef54d" name="ab0c940fa193a42158c6726bf1a2ef54d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab0c940fa193a42158c6726bf1a2ef54d">◆ </a></span>DObject() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">DObject::DObject </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#ad6fc2e29eae70cf94a2d241527857573">DataType</a> &</td> <td class="paramname"><span class="paramname"><em>data</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="class_metadata.html">Metadata</a> &</td> <td class="paramname"><span class="paramname"><em>metadata</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructor to initialize a <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a> with data and metadata. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>The data to be stored in the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. </td></tr>
|
|
<tr><td class="paramname">metadata</td><td><a class="el" href="class_metadata.html" title="Represents metadata information for data objects in the dobj module.">Metadata</a> describing the stored data. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a4862655c3634d019b0a45b811d6f7235" name="a4862655c3634d019b0a45b811d6f7235"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4862655c3634d019b0a45b811d6f7235">◆ </a></span>getData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="#ad6fc2e29eae70cf94a2d241527857573">DObject::DataType</a> & DObject::getData </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves the data stored in the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. </p>
|
|
<p>Use the appropriate type (matching the stored data) with <code>std::get<T>()</code>.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A constant reference to the stored data. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a157b31e881aac6dd40782d3abc561d4e" name="a157b31e881aac6dd40782d3abc561d4e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a157b31e881aac6dd40782d3abc561d4e">◆ </a></span>getMetadata()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="class_metadata.html">Metadata</a> & DObject::getMetadata </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves the metadata associated with the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. </p>
|
|
<p>The metadata provides essential information about the stored data, such as its type, size, and dimensions.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A constant reference to the metadata. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae47bf220fbe2173cf6933c2380035dbd" name="ae47bf220fbe2173cf6933c2380035dbd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae47bf220fbe2173cf6933c2380035dbd">◆ </a></span>isDebuggingEnabled()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool DObject::isDebuggingEnabled </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel nodiscard">nodiscard</span><span class="mlabel noexcept">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks if debugging is enabled for the <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>True if debugging is enabled, false otherwise. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a15afffdf339150fc872bf63bdd08d581" name="a15afffdf339150fc872bf63bdd08d581"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a15afffdf339150fc872bf63bdd08d581">◆ </a></span>registerPlugin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DObject::registerPlugin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="#af11334d08ef85c68b3aae7554548e5a7">Plugin</a></td> <td class="paramname"><span class="paramname"><em>plugin</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Registers a plugin with the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. </p>
|
|
<p>Plugins are stored in a registry and can add custom functionality to the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>A unique identifier for the plugin. </td></tr>
|
|
<tr><td class="paramname">plugin</td><td>The plugin function to register. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1223275dcbbf20334ea11707346acb93" name="a1223275dcbbf20334ea11707346acb93"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1223275dcbbf20334ea11707346acb93">◆ </a></span>runAllPlugins()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DObject::runAllPlugins </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Executes all registered plugins in the registry. </p>
|
|
<p>Iterates through all plugins and invokes them on the current <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a99072eb52bb22745f0248f273fbf28fb" name="a99072eb52bb22745f0248f273fbf28fb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a99072eb52bb22745f0248f273fbf28fb">◆ </a></span>runPlugin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DObject::runPlugin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>id</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Executes a plugin by its identifier. </p>
|
|
<p>Invokes the registered plugin function. If the plugin is not found, no action is taken.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>The unique identifier of the plugin to execute. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab1718571434e84e90f1ec463e4786a8a" name="ab1718571434e84e90f1ec463e4786a8a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab1718571434e84e90f1ec463e4786a8a">◆ </a></span>setData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DObject::setData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="#ad6fc2e29eae70cf94a2d241527857573">DataType</a> &</td> <td class="paramname"><span class="paramname"><em>data</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the data for the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. </p>
|
|
<p>Updates the stored data and optionally updates metadata.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>The new data to store in the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6f0023aee463e71d92442dcf61b6ed47" name="a6f0023aee463e71d92442dcf61b6ed47"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6f0023aee463e71d92442dcf61b6ed47">◆ </a></span>setDebugging()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DObject::setDebugging </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>enableDebug</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enables or disables debugging and tracing for the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. </p>
|
|
<p>When debugging is enabled, the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a> tracks creation and modification history.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">enableDebug</td><td>True to enable debugging, false to disable it. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a296b1519249fdc1f6c7b4ab62d5421bc" name="a296b1519249fdc1f6c7b4ab62d5421bc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a296b1519249fdc1f6c7b4ab62d5421bc">◆ </a></span>setMetadata()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DObject::setMetadata </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_metadata.html">Metadata</a> &</td> <td class="paramname"><span class="paramname"><em>metadata</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Updates the metadata for the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. </p>
|
|
<p>Use this function carefully to ensure consistency between the data and metadata.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">metadata</td><td>The new metadata to associate with the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a99b8688849e11501033a25f61efb8356" name="a99b8688849e11501033a25f61efb8356"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a99b8688849e11501033a25f61efb8356">◆ </a></span>unregisterPlugin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DObject::unregisterPlugin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>id</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Unregisters a plugin by its identifier. </p>
|
|
<p>Removes the plugin from the registry if it exists.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>The unique identifier of the plugin to unregister. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
|
|
<a id="aa54e75574f0302a2ca7252f9f0f0b3f1" name="aa54e75574f0302a2ca7252f9f0f0b3f1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa54e75574f0302a2ca7252f9f0f0b3f1">◆ </a></span>operator<<</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::ostream & operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::ostream &</td> <td class="paramname"><span class="paramname"><em>os</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="class_d_object.html">DObject</a> &</td> <td class="paramname"><span class="paramname"><em>obj</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel friend">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Provides a human-readable summary of the <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a>. </p>
|
|
<p>Useful for quick inspection or logging during debugging sessions.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">os</td><td>The output stream to write to. </td></tr>
|
|
<tr><td class="paramname">obj</td><td>The <a class="el" href="class_d_object.html" title="A universal data container class.">DObject</a> to summarize. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A reference to the output stream. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/dobj/public/<a class="el" href="_d_object_8h_source.html">DObject.h</a></li>
|
|
<li>src/dobj/private/<a class="el" href="_d_object_8cpp.html">DObject.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_d_object.html">DObject</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>
|