Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 785

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csNullCacheManager Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li class="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>csNullCacheManager Class Reference</h1><!-- doxytag: class="csNullCacheManager" --><!-- doxytag: inherits="scfImplementation1&lt; csNullCacheManager, iCacheManager &gt;" -->This is a general cache that doesn't cache anything at all.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="nulcache_8h-source.html">csutil/nulcache.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for csNullCacheManager:</div>
<div class="dynsection">
<p><center><img src="classcsNullCacheManager__inherit__graph.png" border="0" usemap="#csNullCacheManager__inherit__map" alt="Inheritance graph"></center>
<map name="csNullCacheManager__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\&lt; csNullCacheManager, iCacheManager \&gt;" alt="" coords="65,161,489,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\&lt; csNullCacheManager \&gt;" alt="" coords="5,84,312,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="331,7,387,33"><area shape="rect" href="structiCacheManager.html" title="A generic cache system." alt="" coords="336,84,459,111"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="48,7,269,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classcsNullCacheManager-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNullCacheManager.html#4e7b26c857964d3c18b56dffa15e0da7">CacheData</a> (const void *data, size_t size, const char *type, const char *scope, <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> id)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Always returns false.  <a href="#4e7b26c857964d3c18b56dffa15e0da7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNullCacheManager.html#2d981f16c349b1f0b863cfa0e1eb7abe">ClearCache</a> (const char *type=0, const char *scope=0, const <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> *id=0)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Does nothing.  <a href="#2d981f16c349b1f0b863cfa0e1eb7abe"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNullCacheManager.html#3e669d57b98c9fcb18195e534d21a36c">csNullCacheManager</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Does nothing.  <a href="#3e669d57b98c9fcb18195e534d21a36c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNullCacheManager.html#94a67b5203c1d8284059fe9759743a98">Flush</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Does nothing.  <a href="#94a67b5203c1d8284059fe9759743a98"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNullCacheManager.html#86ceba26b60ad8645dddb953c9cfc8db">GetCurrentScope</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Always returns 0.  <a href="#86ceba26b60ad8645dddb953c9cfc8db"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNullCacheManager.html#8baeefa2a11dcb25b77ece65056e7bc0">GetCurrentType</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Always returns 0.  <a href="#8baeefa2a11dcb25b77ece65056e7bc0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNullCacheManager.html#69fbf038696378ec0a6001b9dea77947">IsReadOnly</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is the cache manager read-only?  <a href="#69fbf038696378ec0a6001b9dea77947"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsPtr.html">csPtr</a><br>
&lt; <a class="el" href="structiDataBuffer.html">iDataBuffer</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNullCacheManager.html#307bd208fe556f1e298af62fce7941de">ReadCache</a> (const char *type, const char *scope, <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> id)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Always returns 0.  <a href="#307bd208fe556f1e298af62fce7941de"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNullCacheManager.html#e5f4b2d643f46d7bf58892e6b3a35135">SetCurrentScope</a> (const char *scope)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Does nothing.  <a href="#e5f4b2d643f46d7bf58892e6b3a35135"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNullCacheManager.html#94c2e512887ab82dc6c3bfad6e3c4ea4">SetCurrentType</a> (const char *type)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Does nothing.  <a href="#94c2e512887ab82dc6c3bfad6e3c4ea4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNullCacheManager.html#d66c76d2349f6261db3ba2a4c07752bb">SetReadOnly</a> (bool)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Force the cache manager to be read-only.  <a href="#d66c76d2349f6261db3ba2a4c07752bb"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This is a general cache that doesn't cache anything at all. 
<p>Definition at line <a class="el" href="nulcache_8h-source.html#l00032">32</a> of file <a class="el" href="nulcache_8h-source.html">nulcache.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="3e669d57b98c9fcb18195e534d21a36c"></a><!-- doxytag: member="csNullCacheManager::csNullCacheManager" ref="3e669d57b98c9fcb18195e534d21a36c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csNullCacheManager::csNullCacheManager           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Does nothing. 
<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="4e7b26c857964d3c18b56dffa15e0da7"></a><!-- doxytag: member="csNullCacheManager::CacheData" ref="4e7b26c857964d3c18b56dffa15e0da7" args="(const void *data, size_t size, const char *type, const char *scope, uint32 id)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool csNullCacheManager::CacheData           </td>
          <td>(</td>
          <td class="paramtype">const void *&nbsp;</td>
          <td class="paramname"> <em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>scope</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a>&nbsp;</td>
          <td class="paramname"> <em>id</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Always returns false. 
<p>

<p>Implements <a class="el" href="structiCacheManager.html#2aedafde9aa1abfd45423fa2b509a487">iCacheManager</a>.</p>

</div>
</div><p>
<a class="anchor" name="2d981f16c349b1f0b863cfa0e1eb7abe"></a><!-- doxytag: member="csNullCacheManager::ClearCache" ref="2d981f16c349b1f0b863cfa0e1eb7abe" args="(const char *type=0, const char *scope=0, const uint32 *id=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool csNullCacheManager::ClearCache           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>type</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>scope</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> *&nbsp;</td>
          <td class="paramname"> <em>id</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Does nothing. 
<p>

<p>Implements <a class="el" href="structiCacheManager.html#026bda3760ef474ba81032e849bd40b8">iCacheManager</a>.</p>

</div>
</div><p>
<a class="anchor" name="94a67b5203c1d8284059fe9759743a98"></a><!-- doxytag: member="csNullCacheManager::Flush" ref="94a67b5203c1d8284059fe9759743a98" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void csNullCacheManager::Flush           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Does nothing. 
<p>

<p>Implements <a class="el" href="structiCacheManager.html#6f55692170b6a800973260d3efe9dd98">iCacheManager</a>.</p>

<p>Definition at line <a class="el" href="nulcache_8h-source.html#l00081">81</a> of file <a class="el" href="nulcache_8h-source.html">nulcache.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="86ceba26b60ad8645dddb953c9cfc8db"></a><!-- doxytag: member="csNullCacheManager::GetCurrentScope" ref="86ceba26b60ad8645dddb953c9cfc8db" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* csNullCacheManager::GetCurrentScope           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Always returns 0. 
<p>

<p>Implements <a class="el" href="structiCacheManager.html#6c368f02fd33a11c9758daa968e0e6ae">iCacheManager</a>.</p>

<p>Definition at line <a class="el" href="nulcache_8h-source.html#l00062">62</a> of file <a class="el" href="nulcache_8h-source.html">nulcache.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="8baeefa2a11dcb25b77ece65056e7bc0"></a><!-- doxytag: member="csNullCacheManager::GetCurrentType" ref="8baeefa2a11dcb25b77ece65056e7bc0" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* csNullCacheManager::GetCurrentType           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Always returns 0. 
<p>

<p>Implements <a class="el" href="structiCacheManager.html#757fe6fbfa9de749269ee522106ac508">iCacheManager</a>.</p>

<p>Definition at line <a class="el" href="nulcache_8h-source.html#l00054">54</a> of file <a class="el" href="nulcache_8h-source.html">nulcache.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="69fbf038696378ec0a6001b9dea77947"></a><!-- doxytag: member="csNullCacheManager::IsReadOnly" ref="69fbf038696378ec0a6001b9dea77947" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool csNullCacheManager::IsReadOnly           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Is the cache manager read-only? 
<p>

<p>Implements <a class="el" href="structiCacheManager.html#5354f443c37597e6f91c65aa435910c8">iCacheManager</a>.</p>

<p>Definition at line <a class="el" href="nulcache_8h-source.html#l00045">45</a> of file <a class="el" href="nulcache_8h-source.html">nulcache.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="307bd208fe556f1e298af62fce7941de"></a><!-- doxytag: member="csNullCacheManager::ReadCache" ref="307bd208fe556f1e298af62fce7941de" args="(const char *type, const char *scope, uint32 id)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classcsPtr.html">csPtr</a>&lt;<a class="el" href="structiDataBuffer.html">iDataBuffer</a>&gt; csNullCacheManager::ReadCache           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>scope</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a>&nbsp;</td>
          <td class="paramname"> <em>id</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Always returns 0. 
<p>

<p>Implements <a class="el" href="structiCacheManager.html#8720145834e76d05d858b7b4bac6b8b1">iCacheManager</a>.</p>

</div>
</div><p>
<a class="anchor" name="e5f4b2d643f46d7bf58892e6b3a35135"></a><!-- doxytag: member="csNullCacheManager::SetCurrentScope" ref="e5f4b2d643f46d7bf58892e6b3a35135" args="(const char *scope)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void csNullCacheManager::SetCurrentScope           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>scope</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Does nothing. 
<p>

<p>Implements <a class="el" href="structiCacheManager.html#9467a5d21d2f805217fe3017d3475349">iCacheManager</a>.</p>

</div>
</div><p>
<a class="anchor" name="94c2e512887ab82dc6c3bfad6e3c4ea4"></a><!-- doxytag: member="csNullCacheManager::SetCurrentType" ref="94c2e512887ab82dc6c3bfad6e3c4ea4" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void csNullCacheManager::SetCurrentType           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>type</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Does nothing. 
<p>

<p>Implements <a class="el" href="structiCacheManager.html#368ec9b2fdcf57ef7e74a90f60189646">iCacheManager</a>.</p>

</div>
</div><p>
<a class="anchor" name="d66c76d2349f6261db3ba2a4c07752bb"></a><!-- doxytag: member="csNullCacheManager::SetReadOnly" ref="d66c76d2349f6261db3ba2a4c07752bb" args="(bool)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void csNullCacheManager::SetReadOnly           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>ro</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Force the cache manager to be read-only. 
<p>
This will prevent updates of the cache but <a class="el" href="classcsNullCacheManager.html#4e7b26c857964d3c18b56dffa15e0da7" title="Always returns false.">CacheData()</a> will still return true to indicate success. 
<p>Implements <a class="el" href="structiCacheManager.html#013f35481ea7adb2edd11c3c556b6cf4">iCacheManager</a>.</p>

<p>Definition at line <a class="el" href="nulcache_8h-source.html#l00044">44</a> of file <a class="el" href="nulcache_8h-source.html">nulcache.h</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="nulcache_8h-source.html">nulcache.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>