<!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: scfArrayWrap< IF, Backend > 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 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 Pages</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <h1>scfArrayWrap< IF, Backend > Class Template Reference<br> <small> [<a class="el" href="group__util__containers.html">Containers</a>]</small> </h1><!-- doxytag: class="scfArrayWrap" --><!-- doxytag: inherits="scfImplementation1< scfArrayWrap< IF, Backend >, IF >" -->Implementation for iArrayReadOnly<>-, iArrayChangeElements<>- and iArrayChangeAll<>-derived interfaces, backed by a reference to another array. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="scfarray_8h-source.html">csutil/scfarray.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for scfArrayWrap< IF, Backend >:</div> <div class="dynsection"> <p><center><img src="classscfArrayWrap__inherit__graph.png" border="0" usemap="#scfArrayWrap_3_01IF_00_01Backend_01_4__inherit__map" alt="Inheritance graph"></center> <map name="scfArrayWrap_3_01IF_00_01Backend_01_4__inherit__map"> <area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< scfArrayWrap\< IF, Backend \>, IF \>" alt="" coords="5,161,397,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\< scfArrayWrap\< IF, Backend \> \>" alt="" coords="20,84,383,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="92,7,148,33"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="172,7,393,33"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="classscfArrayWrap-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">iArrayChangeAll<> implementation</div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="abceb4332d197a12a014622b4f846254"></a><!-- doxytag: member="scfArrayWrap::Delete" ref="abceb4332d197a12a014622b4f846254" args="(ContainedType const &item)" --> virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#abceb4332d197a12a014622b4f846254">Delete</a> (ContainedType const &item)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="37bf4990d808243927f3920dd8b9af83"></a><!-- doxytag: member="scfArrayWrap::DeleteAll" ref="37bf4990d808243927f3920dd8b9af83" args="()" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#37bf4990d808243927f3920dd8b9af83">DeleteAll</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1521a06776990348c98a0172e415ff37"></a><!-- doxytag: member="scfArrayWrap::DeleteIndex" ref="1521a06776990348c98a0172e415ff37" args="(size_t n)" --> virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#1521a06776990348c98a0172e415ff37">DeleteIndex</a> (size_t n)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0f4580d8fea89e68b0545e285d13b0d8"></a><!-- doxytag: member="scfArrayWrap::DeleteIndexFast" ref="0f4580d8fea89e68b0545e285d13b0d8" args="(size_t n)" --> virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#0f4580d8fea89e68b0545e285d13b0d8">DeleteIndexFast</a> (size_t n)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fead12cb73c96da85815016da16b470b"></a><!-- doxytag: member="scfArrayWrap::Empty" ref="fead12cb73c96da85815016da16b470b" args="()" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#fead12cb73c96da85815016da16b470b">Empty</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="da22c63ff36556d6ab2f786af22970b8"></a><!-- doxytag: member="scfArrayWrap::GetExtend" ref="da22c63ff36556d6ab2f786af22970b8" args="(size_t n)" --> virtual ContainedType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#da22c63ff36556d6ab2f786af22970b8">GetExtend</a> (size_t n)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b0a26dff65159a158b4ad2e8ccf724aa"></a><!-- doxytag: member="scfArrayWrap::Insert" ref="b0a26dff65159a158b4ad2e8ccf724aa" args="(size_t n, ContainedType const &item)" --> virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#b0a26dff65159a158b4ad2e8ccf724aa">Insert</a> (size_t n, ContainedType const &item)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ae35c60996bbb25baf2a0a1fb52dcd16"></a><!-- doxytag: member="scfArrayWrap::Pop" ref="ae35c60996bbb25baf2a0a1fb52dcd16" args="()" --> virtual ContainedType </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#ae35c60996bbb25baf2a0a1fb52dcd16">Pop</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0dd9e39078561165ded0b5747412ebbb"></a><!-- doxytag: member="scfArrayWrap::Push" ref="0dd9e39078561165ded0b5747412ebbb" args="(ContainedType const &what)" --> virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#0dd9e39078561165ded0b5747412ebbb">Push</a> (ContainedType const &what)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6e2018ee30157dd0e7705f47c7cdc7fd"></a><!-- doxytag: member="scfArrayWrap::PushSmart" ref="6e2018ee30157dd0e7705f47c7cdc7fd" args="(ContainedType const &what)" --> virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#6e2018ee30157dd0e7705f47c7cdc7fd">PushSmart</a> (ContainedType const &what)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="92ef34b1e9ef25e60b8b688bbbf5889a"></a><!-- doxytag: member="scfArrayWrap::Put" ref="92ef34b1e9ef25e60b8b688bbbf5889a" args="(size_t n, ContainedType const &what)" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#92ef34b1e9ef25e60b8b688bbbf5889a">Put</a> (size_t n, ContainedType const &what)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="659a140ed9f729c9acf417869ba0e0b9"></a><!-- doxytag: member="scfArrayWrap::SetSize" ref="659a140ed9f729c9acf417869ba0e0b9" args="(size_t n)" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#659a140ed9f729c9acf417869ba0e0b9">SetSize</a> (size_t n)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="840a5566abd5a4cfb8ce5e39db2273d0"></a><!-- doxytag: member="scfArrayWrap::SetSize" ref="840a5566abd5a4cfb8ce5e39db2273d0" args="(size_t n, ContainedType const &what)" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#840a5566abd5a4cfb8ce5e39db2273d0">SetSize</a> (size_t n, ContainedType const &what)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3bf0ba0d506ac6d2b258040b7cfb582e"></a><!-- doxytag: member="scfArrayWrap::Truncate" ref="3bf0ba0d506ac6d2b258040b7cfb582e" args="(size_t n)" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#3bf0ba0d506ac6d2b258040b7cfb582e">Truncate</a> (size_t n)</td></tr> <tr><td colspan="2"><div class="groupHeader">iArrayReadOnly<> implementation</div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9e0d2931117921d85a5afa395cc5cbf4"></a><!-- doxytag: member="scfArrayWrap::Find" ref="9e0d2931117921d85a5afa395cc5cbf4" args="(ContainedType const &which) const " --> virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#9e0d2931117921d85a5afa395cc5cbf4">Find</a> (ContainedType const &which) const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0eee4e7add92ae394313d10644abd41b"></a><!-- doxytag: member="scfArrayWrap::Get" ref="0eee4e7add92ae394313d10644abd41b" args="(size_t n) const " --> virtual <br> ContainedType const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#0eee4e7add92ae394313d10644abd41b">Get</a> (size_t n) const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="564a848ab22df64ef8c3015d16ae0ebe"></a><!-- doxytag: member="scfArrayWrap::GetAll" ref="564a848ab22df64ef8c3015d16ae0ebe" args="(ContainedType *dest) const " --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#564a848ab22df64ef8c3015d16ae0ebe">GetAll</a> (ContainedType *dest) const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="73b645541d179c72cabecac1424e5b65"></a><!-- doxytag: member="scfArrayWrap::GetIndex" ref="73b645541d179c72cabecac1424e5b65" args="(const ContainedType *which) const " --> virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#73b645541d179c72cabecac1424e5b65">GetIndex</a> (const ContainedType *which) const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5c817c4af9ef5002692adaedccd6f8f0"></a><!-- doxytag: member="scfArrayWrap::GetSize" ref="5c817c4af9ef5002692adaedccd6f8f0" args="() const " --> virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#5c817c4af9ef5002692adaedccd6f8f0">GetSize</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="29dc0e436d764a2e695058ce4cbb567d"></a><!-- doxytag: member="scfArrayWrap::IsEmpty" ref="29dc0e436d764a2e695058ce4cbb567d" args="() const " --> virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#29dc0e436d764a2e695058ce4cbb567d">IsEmpty</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f20a7b45b9baaa8adbc2afb0d8b83930"></a><!-- doxytag: member="scfArrayWrap::Top" ref="f20a7b45b9baaa8adbc2afb0d8b83930" args="() const " --> virtual <br> ContainedType const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#f20a7b45b9baaa8adbc2afb0d8b83930">Top</a> () const </td></tr> <tr><td colspan="2"><div class="groupHeader">iArrayChangeElements<> implementation</div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68c65fa115cf99456438c0a97e4801a1"></a><!-- doxytag: member="scfArrayWrap::Get" ref="68c65fa115cf99456438c0a97e4801a1" args="(size_t n)" --> virtual ContainedType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#68c65fa115cf99456438c0a97e4801a1">Get</a> (size_t n)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="13605eee5e92d2eaebb26e8cc4377597"></a><!-- doxytag: member="scfArrayWrap::Top" ref="13605eee5e92d2eaebb26e8cc4377597" args="()" --> virtual ContainedType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#13605eee5e92d2eaebb26e8cc4377597">Top</a> ()</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="e276c30e44aaf354bc335b4a52aed1be"></a><!-- doxytag: member="scfArrayWrap::scfArrayWrap" ref="e276c30e44aaf354bc335b4a52aed1be" args="(Backend &storage, iBase *scfParent)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#e276c30e44aaf354bc335b4a52aed1be">scfArrayWrap</a> (Backend &<a class="el" href="classscfArrayWrap.html#110c6ca27ef37f3afb52990307f18ddf">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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#8ad0cdd8cb853c7ac87240a245243bed">scfArrayWrap</a> (Backend &<a class="el" href="classscfArrayWrap.html#110c6ca27ef37f3afb52990307f18ddf">storage</a>)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize with a reference to the given storage. <a href="#8ad0cdd8cb853c7ac87240a245243bed"></a><br></td></tr> <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">Backend & </td><td class="memItemRight" valign="bottom"><a class="el" href="classscfArrayWrap.html#110c6ca27ef37f3afb52990307f18ddf">storage</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Reference to the array storage. <a href="#110c6ca27ef37f3afb52990307f18ddf"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <h3>template<typename IF, typename Backend><br> class scfArrayWrap< IF, Backend ></h3> Implementation for iArrayReadOnly<>-, iArrayChangeElements<>- and iArrayChangeAll<>-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<>-, iArrayChangeElements<>- and iArrayChangeAll<>...">scfArrayWrap</a> exists! </dd></dl> <p>Definition at line <a class="el" href="scfarray_8h-source.html#l00150">150</a> of file <a class="el" href="scfarray_8h-source.html">scfarray.h</a>.</p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="8ad0cdd8cb853c7ac87240a245243bed"></a><!-- doxytag: member="scfArrayWrap::scfArrayWrap" ref="8ad0cdd8cb853c7ac87240a245243bed" args="(Backend &storage)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename IF, typename Backend> </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classscfArrayWrap.html">scfArrayWrap</a>< IF, Backend >::<a class="el" href="classscfArrayWrap.html">scfArrayWrap</a> </td> <td>(</td> <td class="paramtype">Backend & </td> <td class="paramname"> <em>storage</em> </td> <td> ) </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#l00162">162</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="110c6ca27ef37f3afb52990307f18ddf"></a><!-- doxytag: member="scfArrayWrap::storage" ref="110c6ca27ef37f3afb52990307f18ddf" args="" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename IF, typename Backend> </div> <table class="memname"> <tr> <td class="memname">Backend& <a class="el" href="classscfArrayWrap.html">scfArrayWrap</a>< IF, Backend >::<a class="el" href="classscfArrayWrap.html#110c6ca27ef37f3afb52990307f18ddf">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#l00158">158</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#l00225">scfArrayWrap< IF, Backend >::Delete()</a>, <a class="el" href="scfarray_8h-source.html#l00215">scfArrayWrap< IF, Backend >::DeleteAll()</a>, <a class="el" href="scfarray_8h-source.html#l00221">scfArrayWrap< IF, Backend >::DeleteIndex()</a>, <a class="el" href="scfarray_8h-source.html#l00223">scfArrayWrap< IF, Backend >::DeleteIndexFast()</a>, <a class="el" href="scfarray_8h-source.html#l00219">scfArrayWrap< IF, Backend >::Empty()</a>, <a class="el" href="scfarray_8h-source.html#l00176">scfArrayWrap< IF, Backend >::Find()</a>, <a class="el" href="scfarray_8h-source.html#l00172">scfArrayWrap< IF, Backend >::Get()</a>, <a class="el" href="scfarray_8h-source.html#l00182">scfArrayWrap< IF, Backend >::GetAll()</a>, <a class="el" href="scfarray_8h-source.html#l00203">scfArrayWrap< IF, Backend >::GetExtend()</a>, <a class="el" href="scfarray_8h-source.html#l00178">scfArrayWrap< IF, Backend >::GetIndex()</a>, <a class="el" href="scfarray_8h-source.html#l00170">scfArrayWrap< IF, Backend >::GetSize()</a>, <a class="el" href="scfarray_8h-source.html#l00213">scfArrayWrap< IF, Backend >::Insert()</a>, <a class="el" href="scfarray_8h-source.html#l00180">scfArrayWrap< IF, Backend >::IsEmpty()</a>, <a class="el" href="scfarray_8h-source.html#l00211">scfArrayWrap< IF, Backend >::Pop()</a>, <a class="el" href="scfarray_8h-source.html#l00207">scfArrayWrap< IF, Backend >::Push()</a>, <a class="el" href="scfarray_8h-source.html#l00209">scfArrayWrap< IF, Backend >::PushSmart()</a>, <a class="el" href="scfarray_8h-source.html#l00205">scfArrayWrap< IF, Backend >::Put()</a>, <a class="el" href="scfarray_8h-source.html#l00199">scfArrayWrap< IF, Backend >::SetSize()</a>, <a class="el" href="scfarray_8h-source.html#l00174">scfArrayWrap< IF, Backend >::Top()</a>, and <a class="el" href="scfarray_8h-source.html#l00217">scfArrayWrap< IF, Backend >::Truncate()</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>