docs/html/class_sylph_1_1_collection.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>LibSylph: Sylph::Collection&lt; T &gt; Class Template Reference</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.5.8 -->
   7 <div class="navigation" id="top">
   8   <div class="tabs">
   9     <ul>
  10       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  11       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  12       <li class="current"><a href="classes.html"><span>Classes</span></a></li>
  13       <li><a href="files.html"><span>Files</span></a></li>
  14     </ul>
  15   </div>
  16   <div class="tabs">
  17     <ul>
  18       <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
  19       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  20       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  21     </ul>
  22   </div>
  23   <div class="navpath"><a class="el" href="namespace_sylph.html">Sylph</a>::<a class="el" href="class_sylph_1_1_collection.html">Collection</a>
  24   </div>
  25 </div>
  26 <div class="contents">
  27 <h1>Sylph::Collection&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="Sylph::Collection" --><!-- doxytag: inherits="Sylph::Object" -->A <a class="el" href="class_sylph_1_1_collection.html" title="A Collection represents a group of objects, known as its elements.">Collection</a> represents a group of objects, known as its <em>elements</em>.
  28 <a href="#_details">More...</a>
  29 <p>
  30 <code>#include &lt;<a class="el" href="_collection_8h-source.html">Sylph/Core/Collection.h</a>&gt;</code>
  31 <p>
  32 <div class="dynheader">
  33 Inheritance diagram for Sylph::Collection&lt; T &gt;:</div>
  34 <div class="dynsection">
  35
  36 <p><center><img src="class_sylph_1_1_collection.png" usemap="#Sylph::Collection< T >_map" border="0" alt=""></center>
  37 <map name="Sylph::Collection< T >_map">
  38 <area href="class_sylph_1_1_object.html" alt="Sylph::Object" shape="rect" coords="0,0,137,24">
  39 </map>
  40 </div>
  41
  42 <p>
  43 <a href="class_sylph_1_1_collection-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
  44 <tr><td></td></tr>
  45 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
  46 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef bool(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_collection.html#4dba972208ceaf48eac3569d0c70145a">FilterFunction</a> )(const T &amp;, <a class="el" href="class_sylph_1_1_any.html">Any</a> &amp;)</td></tr>
  47
  48 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A function that is used for filtering by the filter() method.  <a href="#4dba972208ceaf48eac3569d0c70145a"></a><br></td></tr>
  49 </table>
  50 <hr><a name="_details"></a><h2>Detailed Description</h2>
  51 <h3>template&lt;class T&gt;<br>
  52  class Sylph::Collection&lt; T &gt;</h3>
  53
  54 A <a class="el" href="class_sylph_1_1_collection.html" title="A Collection represents a group of objects, known as its elements.">Collection</a> represents a group of objects, known as its <em>elements</em>.
  55 <p>
  56 Some collections allow duplicate elements and others do not. Some are ordered and others unordered. This interface is used to pass around the various <a class="el" href="class_sylph_1_1_collection.html" title="A Collection represents a group of objects, known as its elements.">Collection</a> classes, such as Vector, and erm... -- well there are more to come -- around with a maximum generality. Most <code><a class="el" href="class_sylph_1_1_collection.html" title="A Collection represents a group of objects, known as its elements.">Collection</a></code> s do the same thing (holding data) and the abstraction layer provided here makes dealing with different types of <code><a class="el" href="class_sylph_1_1_collection.html" title="A Collection represents a group of objects, known as its elements.">Collection</a></code> s easy. <p>
  57 All "destructive" methods (those not marked as <code>const</code> ) are allowed to throw an <code>UnsupportedOperationException</code>. <code><a class="el" href="class_sylph_1_1_collection.html" title="A Collection represents a group of objects, known as its elements.">Collection</a></code> that do not allow <code>NULL</code> (0) elements are allowed to throw <code><a class="el" href="class_sylph_1_1_null_pointer_exception.html" title="This Exception gets thrown when a pointer to NULL is passed to a function or method...">NullPointerException</a></code> s . <code><a class="el" href="class_sylph_1_1_collection.html" title="A Collection represents a group of objects, known as its elements.">Collection</a></code> s that are backed by <code><a class="el" href="class_sylph_1_1_array.html" title="Array provides a safe array.">Array</a></code> s are allowed to throw <code><a class="el" href="class_sylph_1_1_array_exception.html" title="A generic Exception when an error occurs with an Array.">ArrayException</a></code> s if the underlying <code><a class="el" href="class_sylph_1_1_array.html" title="Array provides a safe array.">Array</a></code> gets an out-of-bounds error. <hr><h2>Member Typedef Documentation</h2>
  58 <a class="anchor" name="4dba972208ceaf48eac3569d0c70145a"></a><!-- doxytag: member="Sylph::Collection::FilterFunction" ref="4dba972208ceaf48eac3569d0c70145a" args=")(const T &amp;, Any &amp;)" -->
  59 <div class="memitem">
  60 <div class="memproto">
  61 <div class="memtemplate">
  62 template&lt;class T&gt; </div>
  63       <table class="memname">
  64         <tr>
  65           <td class="memname">typedef bool(* <a class="el" href="class_sylph_1_1_collection.html">Sylph::Collection</a>&lt; T &gt;::<a class="el" href="class_sylph_1_1_collection.html#4dba972208ceaf48eac3569d0c70145a">FilterFunction</a>)(const T &amp;, <a class="el" href="class_sylph_1_1_any.html">Any</a> &amp;)          </td>
  66         </tr>
  67       </table>
  68 </div>
  69 <div class="memdoc">
  70
  71 <p>
  72 A function that is used for filtering by the filter() method.
  73 <p>
  74 This function takes both an instance of the class this <a class="el" href="class_sylph_1_1_array.html" title="Array provides a safe array.">Array</a> contains, and a reference to a reference to any kind of other data that may need to be passed to the FilterFunction.
  75 </div>
  76 </div><p>
  77 </div>
  78 <hr size="1" class="unhidden"><address style="text-align: right;"><small>
  79 Documentation for LibSylph by Doxygen
  80 </body>
  81 </html>