Sophie

Sophie

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

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: scfArrayWrapConst&lt; IF, Backend &gt; Class Template 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>scfArrayWrapConst&lt; IF, Backend &gt; Class Template Reference<br>
<small>
[<a class="el" href="group__util__containers.html">Containers</a>]</small>
</h1><!-- doxytag: class="scfArrayWrapConst" --><!-- doxytag: inherits="scfImplementation1&lt; scfArrayWrapConst&lt; IF, Backend &gt;, IF &gt;" -->Implementation for iArrayReadOnly&lt;&gt;-derived interfaces, backed by a reference to another array.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="scfarray_8h-source.html">csutil/scfarray.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for scfArrayWrapConst&lt; IF, Backend &gt;:</div>
<div class="dynsection">
<p><center><img src="classscfArrayWrapConst__inherit__graph.png" border="0" usemap="#scfArrayWrapConst_3_01IF_00_01Backend_01_4__inherit__map" alt="Inheritance graph"></center>
<map name="scfArrayWrapConst_3_01IF_00_01Backend_01_4__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\&lt; scfArrayWrapConst\&lt; IF, Backend \&gt;, IF \&gt;" alt="" coords="5,161,435,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\&lt; scfArrayWrapConst\&lt; IF, Backend \&gt; \&gt;" alt="" coords="19,84,421,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="111,7,167,33"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="191,7,412,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classscfArrayWrapConst-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 colspan="2"><div class="groupHeader">iArrayReadOnly&lt;&gt; implementation</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="10c4a7a41da69c06ac04b1ff0c0b39ae"></a><!-- doxytag: member="scfArrayWrapConst::Find" ref="10c4a7a41da69c06ac04b1ff0c0b39ae" args="(ContainedType const &amp;which) const " -->
virtual size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrapConst.html#10c4a7a41da69c06ac04b1ff0c0b39ae">Find</a> (ContainedType const &amp;which) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="17b84a1a11b1060087d60cc2535ae76a"></a><!-- doxytag: member="scfArrayWrapConst::Get" ref="17b84a1a11b1060087d60cc2535ae76a" args="(size_t n) const " -->
virtual <br>
ContainedType const &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrapConst.html#17b84a1a11b1060087d60cc2535ae76a">Get</a> (size_t n) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7926ce9a7f3993ad349daf4c90c16c84"></a><!-- doxytag: member="scfArrayWrapConst::GetAll" ref="7926ce9a7f3993ad349daf4c90c16c84" args="(ContainedType *dest) const " -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrapConst.html#7926ce9a7f3993ad349daf4c90c16c84">GetAll</a> (ContainedType *dest) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="503dbea63bc44e44ccd9f71eb9f23c8e"></a><!-- doxytag: member="scfArrayWrapConst::GetIndex" ref="503dbea63bc44e44ccd9f71eb9f23c8e" args="(const ContainedType *which) const " -->
virtual size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrapConst.html#503dbea63bc44e44ccd9f71eb9f23c8e">GetIndex</a> (const ContainedType *which) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d6b2721d5ca9c7ebacef571d83c96293"></a><!-- doxytag: member="scfArrayWrapConst::GetSize" ref="d6b2721d5ca9c7ebacef571d83c96293" args="() const " -->
virtual size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrapConst.html#d6b2721d5ca9c7ebacef571d83c96293">GetSize</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c2fb7c911bf5aa182e618a7c7b3d220f"></a><!-- doxytag: member="scfArrayWrapConst::IsEmpty" ref="c2fb7c911bf5aa182e618a7c7b3d220f" args="() const " -->
virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrapConst.html#c2fb7c911bf5aa182e618a7c7b3d220f">IsEmpty</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d6306b2ff875b071fcce3f808f46e30c"></a><!-- doxytag: member="scfArrayWrapConst::Top" ref="d6306b2ff875b071fcce3f808f46e30c" args="() const " -->
virtual <br>
ContainedType const &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrapConst.html#d6306b2ff875b071fcce3f808f46e30c">Top</a> () const </td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5d2e13a6a60f832c66c4dff88c5a8685"></a><!-- doxytag: member="scfArrayWrapConst::scfArrayWrapConst" ref="5d2e13a6a60f832c66c4dff88c5a8685" args="(const Backend &amp;storage, iBase *scfParent)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrapConst.html#5d2e13a6a60f832c66c4dff88c5a8685">scfArrayWrapConst</a> (const Backend &amp;<a class="el" href="classscfArrayWrapConst.html#948c67a9e84826fd6ad7e2eb6509b7f3">storage</a>, <a class="el" href="structiBase.html">iBase</a> *<a class="el" href="classscfImplementation.html#fd66881aa3adfbdb3d837fa522ecf825">scfParent</a>)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrapConst.html#b177f29202652d46eac39df0787e2504">scfArrayWrapConst</a> (const Backend &amp;<a class="el" href="classscfArrayWrapConst.html#948c67a9e84826fd6ad7e2eb6509b7f3">storage</a>)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize with a reference to the given storage.  <a href="#b177f29202652d46eac39df0787e2504"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const Backend &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrapConst.html#948c67a9e84826fd6ad7e2eb6509b7f3">storage</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Reference to the array storage.  <a href="#948c67a9e84826fd6ad7e2eb6509b7f3"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;typename IF, typename Backend&gt;<br>
 class scfArrayWrapConst&lt; IF, Backend &gt;</h3>

Implementation for iArrayReadOnly&lt;&gt;-derived interfaces, backed by a reference to another array. 
<p>
The <code>IF</code> template parameter denotes the array interface to be implemented, the <code>Backend</code> template parameter the array type used for storage. <dl class="warning" compact><dt><b>Warning:</b></dt><dd>It must be ensured that the referenced array used for storage is alive as long as any instance of <a class="el" href="classscfArrayWrap.html" title="Implementation for iArrayReadOnly&lt;&gt;-, iArrayChangeElements&lt;&gt;- and iArrayChangeAll&lt;&gt...">scfArrayWrap</a> exists! </dd></dl>

<p>Definition at line <a class="el" href="scfarray_8h-source.html#l00239">239</a> of file <a class="el" href="scfarray_8h-source.html">scfarray.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="b177f29202652d46eac39df0787e2504"></a><!-- doxytag: member="scfArrayWrapConst::scfArrayWrapConst" ref="b177f29202652d46eac39df0787e2504" args="(const Backend &amp;storage)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename IF, typename Backend&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classscfArrayWrapConst.html">scfArrayWrapConst</a>&lt; IF, Backend &gt;::<a class="el" href="classscfArrayWrapConst.html">scfArrayWrapConst</a>           </td>
          <td>(</td>
          <td class="paramtype">const Backend &amp;&nbsp;</td>
          <td class="paramname"> <em>storage</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Initialize with a reference to the given storage. 
<p>

<p>Definition at line <a class="el" href="scfarray_8h-source.html#l00251">251</a> of file <a class="el" href="scfarray_8h-source.html">scfarray.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="948c67a9e84826fd6ad7e2eb6509b7f3"></a><!-- doxytag: member="scfArrayWrapConst::storage" ref="948c67a9e84826fd6ad7e2eb6509b7f3" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename IF, typename Backend&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const Backend&amp; <a class="el" href="classscfArrayWrapConst.html">scfArrayWrapConst</a>&lt; IF, Backend &gt;::<a class="el" href="classscfArrayWrapConst.html#948c67a9e84826fd6ad7e2eb6509b7f3">storage</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Reference to the array storage. 
<p>

<p>Definition at line <a class="el" href="scfarray_8h-source.html#l00247">247</a> of file <a class="el" href="scfarray_8h-source.html">scfarray.h</a>.</p>

<p>Referenced by <a class="el" href="scfarray_8h-source.html#l00265">scfArrayWrapConst&lt; iGradientShades, csArray&lt; csGradientShade &gt; &gt;::Find()</a>, <a class="el" href="scfarray_8h-source.html#l00261">scfArrayWrapConst&lt; iGradientShades, csArray&lt; csGradientShade &gt; &gt;::Get()</a>, <a class="el" href="scfarray_8h-source.html#l00271">scfArrayWrapConst&lt; iGradientShades, csArray&lt; csGradientShade &gt; &gt;::GetAll()</a>, <a class="el" href="scfarray_8h-source.html#l00267">scfArrayWrapConst&lt; iGradientShades, csArray&lt; csGradientShade &gt; &gt;::GetIndex()</a>, <a class="el" href="scfarray_8h-source.html#l00259">scfArrayWrapConst&lt; iGradientShades, csArray&lt; csGradientShade &gt; &gt;::GetSize()</a>, <a class="el" href="scfarray_8h-source.html#l00269">scfArrayWrapConst&lt; iGradientShades, csArray&lt; csGradientShade &gt; &gt;::IsEmpty()</a>, and <a class="el" href="scfarray_8h-source.html#l00263">scfArrayWrapConst&lt; iGradientShades, csArray&lt; csGradientShade &gt; &gt;::Top()</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="scfarray_8h-source.html">scfarray.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>