mirror of
https://github.com/zoriya/Bomberman.git
synced 2026-06-04 10:44:42 +00:00
AnonymusRaccoon
387 lines
18 KiB
HTML
387 lines
18 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">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Bomberman: RAY::Cache< T > 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>
|
|
<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" />
|
|
</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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Bomberman
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- 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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceRAY.html">RAY</a></li><li class="navelem"><a class="el" href="classRAY_1_1Cache.html">Cache</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classRAY_1_1Cache-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">RAY::Cache< T > Class Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>A templated class used to cache ressources, indexed with a string.
|
|
<a href="classRAY_1_1Cache.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Cache_8hpp_source.html">Cache.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for RAY::Cache< T >:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><iframe scrolling="no" frameborder="0" src="classRAY_1_1Cache__coll__graph.svg" width="142" height="176"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
|
|
</div>
|
|
</div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a1b91093efcb811a7ca931d207b3ef788"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Cache.html#a1b91093efcb811a7ca931d207b3ef788">Cache</a> (std::function< T(const char *)> dataLoader, std::function< void(T)> dataUnloader)</td></tr>
|
|
<tr class="separator:a1b91093efcb811a7ca931d207b3ef788"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afdba4de1c06194897811ce22dc218c97"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Cache.html#afdba4de1c06194897811ce22dc218c97">~Cache</a> ()=default</td></tr>
|
|
<tr class="memdesc:afdba4de1c06194897811ce22dc218c97"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor, will destroy ray's data. <a href="classRAY_1_1Cache.html#afdba4de1c06194897811ce22dc218c97">More...</a><br /></td></tr>
|
|
<tr class="separator:afdba4de1c06194897811ce22dc218c97"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe40cfa3c2d595f17fb8284147125b64"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Cache.html#abe40cfa3c2d595f17fb8284147125b64">Cache</a> (const <a class="el" href="classRAY_1_1Cache.html">Cache</a> &)=default</td></tr>
|
|
<tr class="memdesc:abe40cfa3c2d595f17fb8284147125b64"><td class="mdescLeft"> </td><td class="mdescRight">default copy constructor <a href="classRAY_1_1Cache.html#abe40cfa3c2d595f17fb8284147125b64">More...</a><br /></td></tr>
|
|
<tr class="separator:abe40cfa3c2d595f17fb8284147125b64"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa22c25255afb11d16bc23ff0c29849d9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRAY_1_1Cache.html">Cache</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Cache.html#aa22c25255afb11d16bc23ff0c29849d9">operator=</a> (const <a class="el" href="classRAY_1_1Cache.html">Cache</a> &)=default</td></tr>
|
|
<tr class="memdesc:aa22c25255afb11d16bc23ff0c29849d9"><td class="mdescLeft"> </td><td class="mdescRight">a cache is assignable <a href="classRAY_1_1Cache.html#aa22c25255afb11d16bc23ff0c29849d9">More...</a><br /></td></tr>
|
|
<tr class="separator:aa22c25255afb11d16bc23ff0c29849d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4bd49e06084a988ff82d17ac9943f74e"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Cache.html#a4bd49e06084a988ff82d17ac9943f74e">fetch</a> (const std::string &path, bool lonely=false)</td></tr>
|
|
<tr class="separator:a4bd49e06084a988ff82d17ac9943f74e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:a9fe59ca2952cf491baabe6689c7b6b67"><td class="memItemLeft" align="right" valign="top">std::function< T(const char *)> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Cache.html#a9fe59ca2952cf491baabe6689c7b6b67">_dataLoader</a></td></tr>
|
|
<tr class="memdesc:a9fe59ca2952cf491baabe6689c7b6b67"><td class="mdescLeft"> </td><td class="mdescRight">function to call to load data <a href="classRAY_1_1Cache.html#a9fe59ca2952cf491baabe6689c7b6b67">More...</a><br /></td></tr>
|
|
<tr class="separator:a9fe59ca2952cf491baabe6689c7b6b67"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3de91e916723b427d98e0c9fc14d06c3"><td class="memItemLeft" align="right" valign="top">std::function< void(T)> </td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Cache.html#a3de91e916723b427d98e0c9fc14d06c3">_dataUnloader</a></td></tr>
|
|
<tr class="memdesc:a3de91e916723b427d98e0c9fc14d06c3"><td class="mdescLeft"> </td><td class="mdescRight">function to call when the ray data will be unloaded <a href="classRAY_1_1Cache.html#a3de91e916723b427d98e0c9fc14d06c3">More...</a><br /></td></tr>
|
|
<tr class="separator:a3de91e916723b427d98e0c9fc14d06c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7f1c91e732fd7328470974a1d146e8bd"><td class="memItemLeft" align="right" valign="top">std::unordered_map< std::string, std::vector< std::shared_ptr< T > > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Cache.html#a7f1c91e732fd7328470974a1d146e8bd">_cache</a></td></tr>
|
|
<tr class="memdesc:a7f1c91e732fd7328470974a1d146e8bd"><td class="mdescLeft"> </td><td class="mdescRight">map storing shared ptr of caches <a href="classRAY_1_1Cache.html#a7f1c91e732fd7328470974a1d146e8bd">More...</a><br /></td></tr>
|
|
<tr class="separator:a7f1c91e732fd7328470974a1d146e8bd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><h3>template<typename T><br />
|
|
class RAY::Cache< T ></h3>
|
|
|
|
<p>A templated class used to cache ressources, indexed with a string. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a1b91093efcb811a7ca931d207b3ef788"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1b91093efcb811a7ca931d207b3ef788">◆ </a></span>Cache() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classRAY_1_1Cache.html">RAY::Cache</a>< T >::<a class="el" href="classRAY_1_1Cache.html">Cache</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::function< T(const char *)> </td>
|
|
<td class="paramname"><em>dataLoader</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::function< void(T)> </td>
|
|
<td class="paramname"><em>dataUnloader</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afdba4de1c06194897811ce22dc218c97"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afdba4de1c06194897811ce22dc218c97">◆ </a></span>~Cache()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classRAY_1_1Cache.html">RAY::Cache</a>< T >::~<a class="el" href="classRAY_1_1Cache.html">Cache</a> </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default destructor, will destroy ray's data. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abe40cfa3c2d595f17fb8284147125b64"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abe40cfa3c2d595f17fb8284147125b64">◆ </a></span>Cache() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classRAY_1_1Cache.html">RAY::Cache</a>< T >::<a class="el" href="classRAY_1_1Cache.html">Cache</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classRAY_1_1Cache.html">Cache</a>< T > & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>default copy constructor </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a4bd49e06084a988ff82d17ac9943f74e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4bd49e06084a988ff82d17ac9943f74e">◆ </a></span>fetch()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::shared_ptr<T> <a class="el" href="classRAY_1_1Cache.html">RAY::Cache</a>< T >::fetch </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>path</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>lonely</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td>path of the file </td></tr>
|
|
<tr><td class="paramname">lonely</td><td>should be set to true if the loaded data must be held by no other active entites </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>a newly loaded ressource if it hasn't be previously loaded, or one from cache </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa22c25255afb11d16bc23ff0c29849d9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa22c25255afb11d16bc23ff0c29849d9">◆ </a></span>operator=()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classRAY_1_1Cache.html">Cache</a>& <a class="el" href="classRAY_1_1Cache.html">RAY::Cache</a>< T >::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classRAY_1_1Cache.html">Cache</a>< T > & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>a cache is assignable </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a7f1c91e732fd7328470974a1d146e8bd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7f1c91e732fd7328470974a1d146e8bd">◆ </a></span>_cache</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::unordered_map<std::string, std::vector<std::shared_ptr<T> > > <a class="el" href="classRAY_1_1Cache.html">RAY::Cache</a>< T >::_cache</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>map storing shared ptr of caches </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9fe59ca2952cf491baabe6689c7b6b67"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9fe59ca2952cf491baabe6689c7b6b67">◆ </a></span>_dataLoader</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::function<T(const char *)> <a class="el" href="classRAY_1_1Cache.html">RAY::Cache</a>< T >::_dataLoader</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>function to call to load data </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3de91e916723b427d98e0c9fc14d06c3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3de91e916723b427d98e0c9fc14d06c3">◆ </a></span>_dataUnloader</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::function<void(T)> <a class="el" href="classRAY_1_1Cache.html">RAY::Cache</a>< T >::_dataUnloader</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>function to call when the ray data will be unloaded </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>lib/Ray/sources/Utils/<a class="el" href="Cache_8hpp_source.html">Cache.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|