Files
SpaghettiKart/classDataRegistry.html
T

386 lines
18 KiB
HTML

<!-- HTML header for doxygen 1.10.0-->
<!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>SpaghettiKart: DataRegistry&lt; TObject &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<link href="docs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</script>
</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">SpaghettiKart
</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&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>
<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">
<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('classDataRegistry.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle"><div class="title">DataRegistry&lt; TObject &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="DataRegistry_8h_source.html">DataRegistry.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for DataRegistry&lt; TObject &gt;:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classDataRegistry__coll__graph.svg" width="198" height="154"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<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:ac11b279cdb0888595e2bc5d0b38a4e85" id="r_ac11b279cdb0888595e2bc5d0b38a4e85"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac11b279cdb0888595e2bc5d0b38a4e85">Add</a> (const std::string &amp;resourceName, TObject &amp;&amp;object)</td></tr>
<tr class="separator:ac11b279cdb0888595e2bc5d0b38a4e85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6e16baae001e6d968f88875c8960b341" id="r_a6e16baae001e6d968f88875c8960b341"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6e16baae001e6d968f88875c8960b341">Add</a> (const std::string &amp;resourceName, const TObject &amp;object)</td></tr>
<tr class="separator:a6e16baae001e6d968f88875c8960b341"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbef71798061b17c030289288b5081d5" id="r_adbef71798061b17c030289288b5081d5"><td class="memItemLeft" align="right" valign="top">TObject *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adbef71798061b17c030289288b5081d5">Get</a> (const std::string &amp;resourceName)</td></tr>
<tr class="separator:adbef71798061b17c030289288b5081d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe239e790697f8a7ac2e4ae3078caaba" id="r_abe239e790697f8a7ac2e4ae3078caaba"><td class="memItemLeft" align="right" valign="top">const TObject *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abe239e790697f8a7ac2e4ae3078caaba">Get</a> (const std::string &amp;resourceName) const</td></tr>
<tr class="separator:abe239e790697f8a7ac2e4ae3078caaba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa4096224fe810d48798ee14d0f85178" id="r_afa4096224fe810d48798ee14d0f85178"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afa4096224fe810d48798ee14d0f85178">Remove</a> (const std::string &amp;resourceName)</td></tr>
<tr class="separator:afa4096224fe810d48798ee14d0f85178"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a962bfbd5eaa28d38c5ac0f54d719abb1" id="r_a962bfbd5eaa28d38c5ac0f54d719abb1"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a962bfbd5eaa28d38c5ac0f54d719abb1">Size</a> () const</td></tr>
<tr class="separator:a962bfbd5eaa28d38c5ac0f54d719abb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3a4518c84b4999a4922f6c116684c42" id="r_ab3a4518c84b4999a4922f6c116684c42"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab3a4518c84b4999a4922f6c116684c42">Clear</a> ()</td></tr>
<tr class="separator:ab3a4518c84b4999a4922f6c116684c42"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a067ffae95df9f90b2b06f3ee93c80f32" id="r_a067ffae95df9f90b2b06f3ee93c80f32"><td class="memItemLeft" align="right" valign="top">std::unordered_map&lt; std::string, std::unique_ptr&lt; TObject &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a067ffae95df9f90b2b06f3ee93c80f32">mMap</a></td></tr>
<tr class="separator:a067ffae95df9f90b2b06f3ee93c80f32"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6e16baae001e6d968f88875c8960b341" name="a6e16baae001e6d968f88875c8960b341"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6e16baae001e6d968f88875c8960b341">&#9670;&#160;</a></span>Add() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TObject&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classDataRegistry.html">DataRegistry</a>&lt; TObject &gt;::Add </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>resourceName</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TObject &amp;</td> <td class="paramname"><span class="paramname"><em>object</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac11b279cdb0888595e2bc5d0b38a4e85" name="ac11b279cdb0888595e2bc5d0b38a4e85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac11b279cdb0888595e2bc5d0b38a4e85">&#9670;&#160;</a></span>Add() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TObject&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classDataRegistry.html">DataRegistry</a>&lt; TObject &gt;::Add </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>resourceName</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TObject &amp;&amp;</td> <td class="paramname"><span class="paramname"><em>object</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classDataRegistry_ac11b279cdb0888595e2bc5d0b38a4e85_icgraph.svg" width="100%" height="600"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
</div>
</div>
</div>
<a id="ab3a4518c84b4999a4922f6c116684c42" name="ab3a4518c84b4999a4922f6c116684c42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3a4518c84b4999a4922f6c116684c42">&#9670;&#160;</a></span>Clear()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TObject&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classDataRegistry.html">DataRegistry</a>&lt; TObject &gt;::Clear </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="adbef71798061b17c030289288b5081d5" name="adbef71798061b17c030289288b5081d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adbef71798061b17c030289288b5081d5">&#9670;&#160;</a></span>Get() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TObject&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">TObject * <a class="el" href="classDataRegistry.html">DataRegistry</a>&lt; TObject &gt;::Get </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>resourceName</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="abe239e790697f8a7ac2e4ae3078caaba" name="abe239e790697f8a7ac2e4ae3078caaba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe239e790697f8a7ac2e4ae3078caaba">&#9670;&#160;</a></span>Get() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TObject&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const TObject * <a class="el" href="classDataRegistry.html">DataRegistry</a>&lt; TObject &gt;::Get </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>resourceName</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="afa4096224fe810d48798ee14d0f85178" name="afa4096224fe810d48798ee14d0f85178"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa4096224fe810d48798ee14d0f85178">&#9670;&#160;</a></span>Remove()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TObject&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classDataRegistry.html">DataRegistry</a>&lt; TObject &gt;::Remove </td>
<td>(</td>
<td class="paramtype">const std::string &amp;</td> <td class="paramname"><span class="paramname"><em>resourceName</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a962bfbd5eaa28d38c5ac0f54d719abb1" name="a962bfbd5eaa28d38c5ac0f54d719abb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a962bfbd5eaa28d38c5ac0f54d719abb1">&#9670;&#160;</a></span>Size()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TObject&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classDataRegistry.html">DataRegistry</a>&lt; TObject &gt;::Size </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 inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Field Documentation</h2>
<a id="a067ffae95df9f90b2b06f3ee93c80f32" name="a067ffae95df9f90b2b06f3ee93c80f32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a067ffae95df9f90b2b06f3ee93c80f32">&#9670;&#160;</a></span>mMap</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TObject&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unordered_map&lt;std::string, std::unique_ptr&lt;TObject&gt; &gt; <a class="el" href="classDataRegistry.html">DataRegistry</a>&lt; TObject &gt;::mMap</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/engine/registry/<a class="el" href="DataRegistry_8h_source.html">DataRegistry.h</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="classDataRegistry.html">DataRegistry</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>