lili/opennurbs
1
0
Fork 0
mirror of https://github.com/mcneel/opennurbs.git synced 2026-03-30 07:26:53 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
05ca20eaf4faacef2aba407d3d0ce037e9ed1e16
opennurbs/6/d5/d00/opennurbs__fsp_8h_source.html
Bozo 832ccb5c1a Publish! 
Generated from v6.0.11315.11111-test14
2018-02-03 11:08:49 -08:00

89 lines
110 KiB
HTML
Raw Blame History

<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>openNURBS SDK Help: D:/BuildAgent/work/d8e3bf9e94f4c621/src4/bin/opennurbs_public/opennurbs_fsp.h Source File</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<!-- <script type="text/javascript" src="../../jquery.js"></script> -->
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
<link href="../../customdoxygen.css" rel="stylesheet" type="text/css"/>
<!-- bootstrap -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
<!-- smartmenus -->
<link href="../../jquery.smartmenus.bootstrap.css" rel="stylesheet">
<script type="text/javascript" src="../../jquery.smartmenus.js"></script>
<script type="text/javascript" src="../../jquery.smartmenus.bootstrap.js"></script>
</head>
<body>
<!-- <div class="version-banner">
Go back to the <a href="/">main site</a>...
</div> -->
<div class="container">
<!-- navbar -->
<nav class="navbar navbar-default">
<div class="container-fluid">
<a class="navbar-brand" href="#">openNURBS SDK Help</a>
<div class="navbar-collapse collapse" id="main-nav-placeholder">
<!-- <p class="navbar-text navbar-right">v6.0</p> -->
<ul class="nav navbar-nav navbar-right">
<li class="dropdown">
<a class="dropdown-toggle" href="#">v6.0 <span class="caret"></span></a>
<ul class="dropdown-menu">
<li><a href="#">Latest (6.x)</a></li>
<li class="disabled"><a href="#">WIP (7.x)</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div class="page-content">
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('../../',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="../../dir_2ea30aa2956a8db99dd22aa5e597f384.html">bin</a></li><li class="navelem"><a class="el" href="../../dir_7a6cfee8d318bd47c162fe536aecd3a7.html">opennurbs_public</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">opennurbs_fsp.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* $NoKeywords: $ */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// Copyright (c) 1993-2012 Robert McNeel &amp; Associates. All rights reserved.</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// OpenNURBS, Rhinoceros, and Rhino3D are registered trademarks of Robert</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// McNeel &amp; Associates.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// THIS SOFTWARE IS PROVIDED &quot;AS IS&quot; WITHOUT EXPRESS OR IMPLIED WARRANTY.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// ALL IMPLIED WARRANTIES OF FITNESS FOR ANY PARTICULAR PURPOSE AND OF</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// MERCHANTABILITY ARE HEREBY DISCLAIMED.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// </span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// For complete openNURBS copyright information see &lt;http://www.opennurbs.org&gt;.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">//</span><span class="comment"></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">////////////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"></span>*/</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#if !defined(OPENNURBS_FSP_INC_)</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#define OPENNURBS_FSP_INC_</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="../../d8/d75/class_o_n___fixed_size_pool.html"> 19</a></span>&#160;<span class="keyword">class </span>ON_CLASS <a class="code" href="../../d8/d75/class_o_n___fixed_size_pool.html">ON_FixedSizePool</a></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;{</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <a class="code" href="../../d8/d75/class_o_n___fixed_size_pool.html">ON_FixedSizePool</a>();</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; ~<a class="code" href="../../d8/d75/class_o_n___fixed_size_pool.html">ON_FixedSizePool</a>();</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#if defined(ON_HAS_RVALUEREF)</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <a class="code" href="../../d8/d75/class_o_n___fixed_size_pool.html">ON_FixedSizePool</a>(<a class="code" href="../../d8/d75/class_o_n___fixed_size_pool.html">ON_FixedSizePool</a>&amp;&amp;);</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <a class="code" href="../../d8/d75/class_o_n___fixed_size_pool.html">ON_FixedSizePool</a>&amp; operator=(<a class="code" href="../../d8/d75/class_o_n___fixed_size_pool.html">ON_FixedSizePool</a>&amp;&amp;);</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"> Create a fixed size memory pool.</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment"> sizeof_element - [in] </span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="comment"> number of bytes in each element. This parameter must be greater than zero.</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment"> In general, use sizeof(element type). If you pass a &quot;raw&quot; number as </span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment"> sizeof_element, then be certain that it is the right size to insure the </span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment"> fields in your elements will be properly aligned.</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment"> element_count_estimate - [in] (0 = good default)</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment"> If you know how many elements you will need, pass that number here.</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment"> It is better to slightly overestimate than to slightly underestimate.</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment"> If you do not have a good estimate, then use zero.</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="comment"> block_element_capacity - [in] (0 = good default)</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="comment"> If block_element_capacity is zero, Create() will calculate a block</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="comment"> size that is efficent for most applications. If you are an expert</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="comment"> user and want to specify the number of elements per block,</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="comment"> then pass the number of elements per block here. When </span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="comment"> block_element_capacity &gt; 0 and element_count_estimate &gt; 0, the first </span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment"> block will have a capacity of at least element_count_estimate; in this</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="comment"> case do not ask for extraordinarly large amounts of contiguous heap.</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="comment"> You must call Create() on an unused ON_FixedSizePool or call Destroy()</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="comment"> before calling create.</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="comment"> True if successful and the pool can be used.</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordtype">bool</span> Create( </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordtype">size_t</span> sizeof_element,</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordtype">size_t</span> element_count_estimate,</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordtype">size_t</span> block_element_capacity</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; );</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="comment"> Size of the elements in this pool.</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">size_t</span> SizeofElement() <span class="keyword">const</span>;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="comment"> A pointer to sizeof_element bytes. The memory is zeroed.</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordtype">void</span>* AllocateElement();</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="comment"> A pointer to sizeof_element bytes. The values in the returned block are undefined.</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordtype">void</span>* AllocateDirtyElement();</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;<span class="comment"> Return an element to the pool.</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="comment"> p - [in]</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;<span class="comment"> A pointer returned by AllocateElement().</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="comment"> It is critical that p be from this pool and that</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="comment"> you return a pointer no more than one time.</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="comment"> If you find the following remarks confusing, but you really want to use</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;<span class="comment"> ReturnElement(), then here are some simple guidelines.</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;<span class="comment"> 1) SizeofElement() must be &gt;= 16</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;<span class="comment"> 2) SizeofElement() must be a multiple of 8.</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="comment"> 3) Do not use FirstElement() and NextElement() to iterate through</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;<span class="comment"> the pool.</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;<span class="comment"> If 1 to 3 don&#39;t work for you, then you need to understand the following</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;<span class="comment"> information before using ReturnElement().</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;<span class="comment"> ON_FixedMemoryPool uses the first sizeof(void*) bytes of the</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;<span class="comment"> returned element for bookkeeping purposes. Therefore, if you</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;<span class="comment"> are going to use ReturnElement(), then SizeofElement() must be </span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160;<span class="comment"> at least sizeof(void*). If you are using a platform that requires</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;<span class="comment"> pointers to be aligned on sizeof(void*) boundaries, then</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160;<span class="comment"> SizeofElement() must be a multiple of sizeof(void*).</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160;<span class="comment"> If you are going to use ReturnElement() and then use FirstElement()</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160;<span class="comment"> and NextElement() to iterate through the list of elements, then you</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160;<span class="comment"> need to set a value in the returned element to indicate that it</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160;<span class="comment"> needs to be skipped during the iteration. This value cannot be</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160;<span class="comment"> located in the fist sizeof(void*) bytes of the element. If the </span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160;<span class="comment"> element is a class with a vtable, you cannot call a virtual </span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;<span class="comment"> function on a returned element because the vtable pointer is </span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;<span class="comment"> trashed when ReturnElement() modifies the fist sizeof(void*) bytes.</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; <span class="keywordtype">void</span> ReturnElement(<span class="keywordtype">void</span>* p);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;<span class="comment"> Return all allocated elements to the pool. No heap is freed and</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;<span class="comment"> the pool remains initialized and ready for AllocateElement()</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160;<span class="comment"> to be called.</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordtype">void</span> ReturnAll();</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;<span class="comment"> Destroy the pool and free all the heap. The pool cannot be used again</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;<span class="comment"> until Create() is called.</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <span class="keywordtype">void</span> Destroy();</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;<span class="comment"> Number of active elements. (Elements that have been returned are not active.)</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>&#160; <span class="keywordtype">size_t</span> ActiveElementCount() <span class="keyword">const</span>;</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;<span class="comment"> Total number of elements = number of active elements + number of returned elements.</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; <span class="keywordtype">size_t</span> TotalElementCount() <span class="keyword">const</span>;</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>&#160;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160;<span class="comment"> Get the i-th elment in the fixed size pool.</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;<span class="comment"> element_index - [in]</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;<span class="comment"> A pointer to the element with the specified index. </span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;<span class="comment"> The first element has element_index = 0 and is the element</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;<span class="comment"> returned by the first call to AllocateElement().</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;<span class="comment"> The last element has element_index = ElementCount()-1.</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160;<span class="comment"> If element_index is out of range, nullptr is returned.</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160;<span class="comment"> It is faster to use ON_FixedSizePoolIterator.FirstElement() and</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160;<span class="comment"> ON_FixedSizePoolIterator.NextElement() to iterate through the </span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160;<span class="comment"> entire list of elements. This function is relatively</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;<span class="comment"> efficient when there are a few large blocks in the pool</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;<span class="comment"> or element_index is small compared to the number of elements</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;<span class="comment"> in the first few blocks.</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160;<span class="comment"> If ReturnElement() is not used or no AllocateElement() calls</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160;<span class="comment"> are made after any use of ReturnElement(), then the i-th </span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160;<span class="comment"> element is the one returned by the (i+1)-th call to </span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160;<span class="comment"> AllocateElement()</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; <span class="keywordtype">void</span>* Element(</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160; <span class="keywordtype">size_t</span> element_index</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160; ) <span class="keyword">const</span>;</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160;</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160;<span class="comment"> Get the fixed size pool index of an element.</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;<span class="comment"> element_pointer - [in]</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160;<span class="comment"> An index &gt;= 0 and &lt; ON_MAX_SIZE_T if the element_pointer</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160;<span class="comment"> points to an element managed by the this fixed size pool.</span></div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160;<span class="comment"> ON_MAX_SIZE_T otherwise.</span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160;<span class="comment"> It is faster to use ON_FixedSizePoolIterator.FirstElement() and</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160;<span class="comment"> ON_FixedSizePoolIterator.NextElement() to iterate through the </span></div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160;<span class="comment"> entire list of elements. This function is relatively</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160;<span class="comment"> efficient when there are a few large blocks in the pool</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160;<span class="comment"> or element_pointer is an element in the first few blocks.</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160;<span class="comment"> If ReturnElement() is not used or no AllocateElement() calls</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160;<span class="comment"> are made after any use of ReturnElement(), then the i-th </span></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160;<span class="comment"> element is the one returned by the (i+1)-th call to </span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160;<span class="comment"> AllocateElement().</span></div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; <span class="keywordtype">size_t</span> ElementIndex(</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; <span class="keyword">const</span> <span class="keywordtype">void</span>* element_pointer</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; ) <span class="keyword">const</span>;</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160;</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160;<span class="comment"> If you are certain that all elements in hte pool (active and returned)</span></div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160;<span class="comment"> have an unsigned id that is unique and increasing, then you may use</span></div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160;<span class="comment"> this function to find them.</span></div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160;<span class="comment"> id_offset - [in]</span></div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;<span class="comment"> offset into the element where the id is stored.</span></div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160;<span class="comment"> id - [in]</span></div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>&#160;<span class="comment"> id to search for</span></div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00209"></a><span class="lineno"><a class="line" href="../../d8/d75/class_o_n___fixed_size_pool.html#a6b3a440f8ac861a8d7731be18603eb84"> 209</a></span>&#160; <span class="keywordtype">void</span>* ElementFromId(</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span>&#160; <span class="keywordtype">size_t</span> id_offset,</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <span class="keywordtype">id</span></div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>&#160; ) <span class="keyword">const</span>;</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span>&#160;</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>&#160; <span class="comment">// Primarily used for debugging</span></div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span>&#160; <span class="keywordtype">bool</span> IsValid() <span class="keyword">const</span>;</div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span>&#160;</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="../../de/da1/class_o_n___fixed_size_pool_iterator.html">ON_FixedSizePoolIterator</a>;</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>&#160;</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>&#160; <span class="keywordtype">void</span>* m_first_block;</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span>&#160;</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>&#160; <span class="comment">// ReturnElement() adds to the m_al_element stack.</span></div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span>&#160; <span class="comment">// AllocateElement() will use the stack before using m_al_element_array[]</span></div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span>&#160; <span class="keywordtype">void</span>* m_al_element_stack;</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>&#160;</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>&#160; <span class="keywordtype">void</span>* m_al_block; <span class="comment">// current element allocation block.</span></div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>&#160; <span class="comment">// m_al_element_array[] is in m_al_block and has length m_al_count.</span></div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span>&#160; <span class="keywordtype">void</span>* m_al_element_array;</div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>&#160; <span class="keywordtype">size_t</span> m_al_count;</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span>&#160; <span class="keywordtype">size_t</span> m_sizeof_element;</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>&#160; <span class="keywordtype">size_t</span> m_block_element_count; <span class="comment">// block element count</span></div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>&#160; <span class="keywordtype">size_t</span> m_active_element_count; <span class="comment">// number of active elements</span></div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span>&#160; <span class="keywordtype">size_t</span> m_total_element_count; <span class="comment">// total number of elements (active + returned)</span></div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>&#160; </div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>&#160; <span class="comment">// returns capacity of elements in existing block</span></div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>&#160; <span class="keywordtype">size_t</span> BlockElementCapacity( <span class="keyword">const</span> <span class="keywordtype">void</span>* block ) <span class="keyword">const</span>;</div><div class="line"><a name="l00239"></a><span class="lineno"><a class="line" href="../../de/da1/class_o_n___fixed_size_pool_iterator.html"> 239</a></span>&#160;</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>&#160; <span class="comment">// returns number of allocated of elements in existing block</span></div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160; <span class="keywordtype">size_t</span> BlockElementCount( <span class="keyword">const</span> <span class="keywordtype">void</span>* block ) <span class="keyword">const</span>;</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160;</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160; <span class="comment">// prohibit copy construction and operator=.</span></div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160; <a class="code" href="../../d8/d75/class_o_n___fixed_size_pool.html">ON_FixedSizePool</a>(<span class="keyword">const</span> <a class="code" href="../../d8/d75/class_o_n___fixed_size_pool.html">ON_FixedSizePool</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160; <a class="code" href="../../d8/d75/class_o_n___fixed_size_pool.html">ON_FixedSizePool</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="../../d8/d75/class_o_n___fixed_size_pool.html">ON_FixedSizePool</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160;};</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>&#160;</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span>&#160;<span class="keyword">class </span>ON_CLASS <a class="code" href="../../de/da1/class_o_n___fixed_size_pool_iterator.html">ON_FixedSizePoolIterator</a></div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span>&#160;{</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span>&#160; <a class="code" href="../../de/da1/class_o_n___fixed_size_pool_iterator.html">ON_FixedSizePoolIterator</a>();</div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span>&#160; <a class="code" href="../../de/da1/class_o_n___fixed_size_pool_iterator.html">ON_FixedSizePoolIterator</a>( <span class="keyword">const</span> <span class="keyword">class</span> <a class="code" href="../../d8/d75/class_o_n___fixed_size_pool.html">ON_FixedSizePool</a>&amp; fsp );</div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>&#160;</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>&#160; <span class="keyword">const</span> <span class="keyword">class </span><a class="code" href="../../d8/d75/class_o_n___fixed_size_pool.html">ON_FixedSizePool</a>* FixedSizePool();</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span>&#160;</div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span>&#160; <span class="keywordtype">void</span> <a class="code" href="../../d8/d75/class_o_n___fixed_size_pool.html#a0904463b277ba449081d8b2929c8ef26">Create</a>(<span class="keyword">const</span> <a class="code" href="../../d8/d75/class_o_n___fixed_size_pool.html">ON_FixedSizePool</a>* fsp);</div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span>&#160;</div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span>&#160;<span class="comment"> Get the first element when iterating through the list of elements.</span></div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span>&#160;<span class="comment"> element_index - [in]</span></div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span>&#160;<span class="comment"> If you use the version of FirstElement() that has an </span></div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span>&#160;<span class="comment"> element_index parameter, then the iteration begins at</span></div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>&#160;<span class="comment"> that element.</span></div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span>&#160;<span class="comment"> Example:</span></div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span>&#160;<span class="comment"> The loop will iteratate through all the elements returned from</span></div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span>&#160;<span class="comment"> AllocateElement(), including any that have be returned to the pool</span></div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span>&#160;<span class="comment"> using ReturnElement().</span></div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span>&#160;<span class="comment"> // iterate through all elements in the pool</span></div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span>&#160;<span class="comment"> // This iteration will go through TotalElements() items.</span></div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span>&#160;<span class="comment"> for ( void* p = FirstElement(); 0 != p; p = NextElement() )</span></div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span>&#160;<span class="comment"> {</span></div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span>&#160;<span class="comment"> // If you are not using ReturnElement(), then you may process</span></div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span>&#160;<span class="comment"> // &quot;p&quot; immediately. If you have used ReturnElement(), then you</span></div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span>&#160;<span class="comment"> // must check some value in p located after the first sizeof(void*)</span></div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span>&#160;<span class="comment"> // bytes to see if p is active.</span></div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span>&#160;<span class="comment"> if ( p is not active )</span></div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span>&#160;<span class="comment"> continue;</span></div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span>&#160;<span class="comment"> ... process p</span></div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span>&#160;<span class="comment"> }</span></div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span>&#160;<span class="comment"> The first element when iterating through the list of elements.</span></div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span>&#160;<span class="comment"> FirstElement() and NextElement() will return elements that have </span></div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span>&#160;<span class="comment"> been returned to the pool using ReturnElement(). If you use </span></div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span>&#160;<span class="comment"> ReturnElement(), then be sure to mark the element so it can be</span></div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span>&#160;<span class="comment"> identified and skipped.</span></div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span>&#160;<span class="comment"> Do not make any calls to FirstBlock() or NextBlock() when using</span></div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span>&#160;<span class="comment"> FirstElement() and NextElement() to iteratate through elements.</span></div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span>&#160; <span class="keywordtype">void</span>* FirstElement();</div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span>&#160; <span class="keywordtype">void</span>* FirstElement( <span class="keywordtype">size_t</span> element_index );</div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span>&#160;</div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span>&#160;<span class="comment"> Get the next element when iterating through the list of elements.</span></div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span>&#160;<span class="comment"> If FirstElement() is not called, then the first call to</span></div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span>&#160;<span class="comment"> NextElement() returns the first element.</span></div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span>&#160;<span class="comment"> Example:</span></div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span>&#160;<span class="comment"> See the FirstElement() documentation.</span></div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span>&#160;<span class="comment"> The next element when iterating through the list of elements.</span></div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span>&#160;<span class="comment"> FirstElement() and NextElement() will return elements that have </span></div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span>&#160;<span class="comment"> been returned to the pool using ReturnElement(). If you use </span></div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span>&#160;<span class="comment"> ReturnElement(), then be sure to mark the element so it can be</span></div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span>&#160;<span class="comment"> identified and skipped.</span></div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span>&#160;<span class="comment"> Do not make any calls to FirstBlock() or NextBlock() when using</span></div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span>&#160;<span class="comment"> FirstElement() and NextElement() to iteratate through elements.</span></div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span>&#160; <span class="keywordtype">void</span>* NextElement();</div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span>&#160;</div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span>&#160;<span class="comment"> The most recently returned value from a call to FirstElement()</span></div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span>&#160;<span class="comment"> or NextElement().</span></div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span>&#160;<span class="comment"> Do not make any calls to FirstBlock() or NextBlock() when using</span></div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span>&#160;<span class="comment"> FirstElement() and NextElement() to iteratate through elements.</span></div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span>&#160; <span class="keywordtype">void</span>* CurrentElement() <span class="keyword">const</span>;</div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span>&#160;</div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span>&#160;<span class="comment"> Sets the state of the iterator to the initial state that</span></div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span>&#160;<span class="comment"> exists after construction. This is useful if the iterator</span></div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span>&#160;<span class="comment"> has been used the get one or more elements and then</span></div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span>&#160;<span class="comment"> the referenced fixed size pool is modified or code wants</span></div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span>&#160;<span class="comment"> to begin iteration again a used a call to NextElement()</span></div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span>&#160;<span class="comment"> to return the first element.</span></div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span>&#160; <span class="keywordtype">void</span> Reset();</div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span>&#160;</div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span>&#160;</div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span>&#160;<span class="comment"> Get a pointer to the first element in the first block.</span></div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span>&#160;<span class="comment"> block_element_count - [out] (can be null)</span></div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span>&#160;<span class="comment"> If not null, the number of elements allocated from the</span></div><div class="line"><a name="l00348"></a><span class="lineno"> 348</span>&#160;<span class="comment"> first block is returned in block_element_count.</span></div><div class="line"><a name="l00349"></a><span class="lineno"> 349</span>&#160;<span class="comment"> Note that if you have used ReturnElement(), some</span></div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span>&#160;<span class="comment"> of these elemements may have been returned.</span></div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span>&#160;<span class="comment"> Example:</span></div><div class="line"><a name="l00352"></a><span class="lineno"> 352</span>&#160;<span class="comment"> The loop will iteratate through all the blocks.</span></div><div class="line"><a name="l00353"></a><span class="lineno"> 353</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00354"></a><span class="lineno"> 354</span>&#160;<span class="comment"> // iterate through all blocks in the pool</span></div><div class="line"><a name="l00355"></a><span class="lineno"> 355</span>&#160;<span class="comment"> size_t block_element_count = 0;</span></div><div class="line"><a name="l00356"></a><span class="lineno"> 356</span>&#160;<span class="comment"> for ( void* p = FirstBlock(&amp;block_element_count); </span></div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span>&#160;<span class="comment"> 0 != p; </span></div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span>&#160;<span class="comment"> p = NextBlock(&amp;block_element_count) </span></div><div class="line"><a name="l00359"></a><span class="lineno"> 359</span>&#160;<span class="comment"> )</span></div><div class="line"><a name="l00360"></a><span class="lineno"> 360</span>&#160;<span class="comment"> {</span></div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span>&#160;<span class="comment"> ElementType* e = (ElementType*)p;</span></div><div class="line"><a name="l00362"></a><span class="lineno"> 362</span>&#160;<span class="comment"> for ( size_t i = 0; </span></div><div class="line"><a name="l00363"></a><span class="lineno"> 363</span>&#160;<span class="comment"> i &lt; block_element_count; </span></div><div class="line"><a name="l00364"></a><span class="lineno"> 364</span>&#160;<span class="comment"> i++, e = ((const char*)e) + SizeofElement() </span></div><div class="line"><a name="l00365"></a><span class="lineno"> 365</span>&#160;<span class="comment"> )</span></div><div class="line"><a name="l00366"></a><span class="lineno"> 366</span>&#160;<span class="comment"> {</span></div><div class="line"><a name="l00367"></a><span class="lineno"> 367</span>&#160;<span class="comment"> ...</span></div><div class="line"><a name="l00368"></a><span class="lineno"> 368</span>&#160;<span class="comment"> }</span></div><div class="line"><a name="l00369"></a><span class="lineno"> 369</span>&#160;<span class="comment"> }</span></div><div class="line"><a name="l00370"></a><span class="lineno"> 370</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00371"></a><span class="lineno"> 371</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00372"></a><span class="lineno"> 372</span>&#160;<span class="comment"> The first block when iterating the list of blocks.</span></div><div class="line"><a name="l00373"></a><span class="lineno"> 373</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00374"></a><span class="lineno"> 374</span>&#160;<span class="comment"> The heap for a fixed size memory pool is simply a linked</span></div><div class="line"><a name="l00375"></a><span class="lineno"> 375</span>&#160;<span class="comment"> list of blocks. FirstBlock() and NextBlock() can be used</span></div><div class="line"><a name="l00376"></a><span class="lineno"> 376</span>&#160;<span class="comment"> to iterate through the list of blocks.</span></div><div class="line"><a name="l00377"></a><span class="lineno"> 377</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00378"></a><span class="lineno"> 378</span>&#160;<span class="comment"> Do not make any calls to FirstElement() or NextElement() when using</span></div><div class="line"><a name="l00379"></a><span class="lineno"> 379</span>&#160;<span class="comment"> FirstBlock() and NextBlock() to iteratate through blocks.</span></div><div class="line"><a name="l00380"></a><span class="lineno"> 380</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00381"></a><span class="lineno"> 381</span>&#160; <span class="keywordtype">void</span>* FirstBlock( <span class="keywordtype">size_t</span>* block_element_count );</div><div class="line"><a name="l00382"></a><span class="lineno"> 382</span>&#160;</div><div class="line"><a name="l00383"></a><span class="lineno"> 383</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00384"></a><span class="lineno"> 384</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00385"></a><span class="lineno"> 385</span>&#160;<span class="comment"> Get the next block when iterating through the blocks.</span></div><div class="line"><a name="l00386"></a><span class="lineno"> 386</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00387"></a><span class="lineno"> 387</span>&#160;<span class="comment"> block_element_count - [out] (can be null)</span></div><div class="line"><a name="l00388"></a><span class="lineno"> 388</span>&#160;<span class="comment"> If not null, the number of elements allocated from the</span></div><div class="line"><a name="l00389"></a><span class="lineno"> 389</span>&#160;<span class="comment"> block is returned in block_element_count. Note that if</span></div><div class="line"><a name="l00390"></a><span class="lineno"> 390</span>&#160;<span class="comment"> you have used ReturnElement(), some of these elemements</span></div><div class="line"><a name="l00391"></a><span class="lineno"> 391</span>&#160;<span class="comment"> may have been returned.</span></div><div class="line"><a name="l00392"></a><span class="lineno"> 392</span>&#160;<span class="comment"> Example:</span></div><div class="line"><a name="l00393"></a><span class="lineno"> 393</span>&#160;<span class="comment"> See the FirstBlock() documentation.</span></div><div class="line"><a name="l00394"></a><span class="lineno"> 394</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00395"></a><span class="lineno"> 395</span>&#160;<span class="comment"> The next block when iterating through the blocks.</span></div><div class="line"><a name="l00396"></a><span class="lineno"> 396</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00397"></a><span class="lineno"> 397</span>&#160;<span class="comment"> Do not make any calls to FirstElement() or NextElement() when using</span></div><div class="line"><a name="l00398"></a><span class="lineno"> 398</span>&#160;<span class="comment"> FirstBlock() and NextBlock() to iteratate through blocks.</span></div><div class="line"><a name="l00399"></a><span class="lineno"> 399</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00400"></a><span class="lineno"> 400</span>&#160; <span class="keywordtype">void</span>* NextBlock( <span class="keywordtype">size_t</span>* block_element_count );</div><div class="line"><a name="l00401"></a><span class="lineno"> 401</span>&#160;</div><div class="line"><a name="l00402"></a><span class="lineno"> 402</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00403"></a><span class="lineno"> 403</span>&#160; <span class="keyword">const</span> <span class="keyword">class </span><a class="code" href="../../d8/d75/class_o_n___fixed_size_pool.html">ON_FixedSizePool</a>* m_fsp;</div><div class="line"><a name="l00404"></a><span class="lineno"> 404</span>&#160; <span class="keywordtype">void</span>* m_it_block;</div><div class="line"><a name="l00405"></a><span class="lineno"> 405</span>&#160; <span class="keywordtype">void</span>* m_it_element;</div><div class="line"><a name="l00406"></a><span class="lineno"> 406</span>&#160;};</div><div class="line"><a name="l00407"></a><span class="lineno"> 407</span>&#160;</div><div class="line"><a name="l00408"></a><span class="lineno"> 408</span>&#160;</div><div class="line"><a name="l00409"></a><span class="lineno"> 409</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span><a class="code" href="../../d0/d41/class_o_n___simple_fixed_size_pool.html">ON_SimpleFixedSizePool</a> : <span class="keyword">private</span> <a class="code" href="../../d8/d75/class_o_n___fixed_size_pool.html">ON_FixedSizePool</a></div><div class="line"><a name="l00410"></a><span class="lineno"> 410</span>&#160;{</div><div class="line"><a name="l00411"></a><span class="lineno"><a class="line" href="../../d0/d41/class_o_n___simple_fixed_size_pool.html"> 411</a></span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00412"></a><span class="lineno"> 412</span>&#160; <span class="comment">// construction ////////////////////////////////////////////////////////</span></div><div class="line"><a name="l00413"></a><span class="lineno"> 413</span>&#160;</div><div class="line"><a name="l00414"></a><span class="lineno"> 414</span>&#160; <a class="code" href="../../d0/d41/class_o_n___simple_fixed_size_pool.html">ON_SimpleFixedSizePool</a>();</div><div class="line"><a name="l00415"></a><span class="lineno"> 415</span>&#160; ~<a class="code" href="../../d0/d41/class_o_n___simple_fixed_size_pool.html">ON_SimpleFixedSizePool</a>();</div><div class="line"><a name="l00416"></a><span class="lineno"> 416</span>&#160; </div><div class="line"><a name="l00417"></a><span class="lineno"> 417</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00418"></a><span class="lineno"> 418</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00419"></a><span class="lineno"> 419</span>&#160;<span class="comment"> Create a fixed size memory pool.</span></div><div class="line"><a name="l00420"></a><span class="lineno"> 420</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00421"></a><span class="lineno"> 421</span>&#160;<span class="comment"> element_count_estimate - [in] (0 = good default)</span></div><div class="line"><a name="l00422"></a><span class="lineno"> 422</span>&#160;<span class="comment"> If you know how many elements you will need, pass that number here.</span></div><div class="line"><a name="l00423"></a><span class="lineno"> 423</span>&#160;<span class="comment"> It is better to slightly overestimate than to slightly underestimate.</span></div><div class="line"><a name="l00424"></a><span class="lineno"> 424</span>&#160;<span class="comment"> If you do not have a good estimate, then use zero.</span></div><div class="line"><a name="l00425"></a><span class="lineno"> 425</span>&#160;<span class="comment"> block_element_count - [in] (0 = good default)</span></div><div class="line"><a name="l00426"></a><span class="lineno"> 426</span>&#160;<span class="comment"> If block_element_count is zero, Create() will calculate a block</span></div><div class="line"><a name="l00427"></a><span class="lineno"> 427</span>&#160;<span class="comment"> size that is efficent for most applications. If you are an expert</span></div><div class="line"><a name="l00428"></a><span class="lineno"> 428</span>&#160;<span class="comment"> user and want to specify the number of blocks, then pass the number</span></div><div class="line"><a name="l00429"></a><span class="lineno"> 429</span>&#160;<span class="comment"> of elements per block here. When block_element_count &gt; 0 and</span></div><div class="line"><a name="l00430"></a><span class="lineno"> 430</span>&#160;<span class="comment"> element_count_estimate &gt; 0, the first block will be large enough</span></div><div class="line"><a name="l00431"></a><span class="lineno"> 431</span>&#160;<span class="comment"> element_count_estimate*sizeof(T) bytes; in this case do not</span></div><div class="line"><a name="l00432"></a><span class="lineno"> 432</span>&#160;<span class="comment"> ask for extraordinarly large amounts of contiguous heap.</span></div><div class="line"><a name="l00433"></a><span class="lineno"> 433</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00434"></a><span class="lineno"> 434</span>&#160;<span class="comment"> You must call Create() on an unused ON_FixedSizePool or call Destroy()</span></div><div class="line"><a name="l00435"></a><span class="lineno"> 435</span>&#160;<span class="comment"> before calling create.</span></div><div class="line"><a name="l00436"></a><span class="lineno"> 436</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00437"></a><span class="lineno"> 437</span>&#160;<span class="comment"> True if successful and the pool can be used.</span></div><div class="line"><a name="l00438"></a><span class="lineno"> 438</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00439"></a><span class="lineno"> 439</span>&#160; <span class="keywordtype">bool</span> Create( </div><div class="line"><a name="l00440"></a><span class="lineno"> 440</span>&#160; <span class="keywordtype">size_t</span> element_count_estimate,</div><div class="line"><a name="l00441"></a><span class="lineno"> 441</span>&#160; <span class="keywordtype">size_t</span> block_element_count</div><div class="line"><a name="l00442"></a><span class="lineno"> 442</span>&#160; );</div><div class="line"><a name="l00443"></a><span class="lineno"> 443</span>&#160;</div><div class="line"><a name="l00444"></a><span class="lineno"> 444</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00445"></a><span class="lineno"> 445</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00446"></a><span class="lineno"> 446</span>&#160;<span class="comment"> Size of the elements in this pool.</span></div><div class="line"><a name="l00447"></a><span class="lineno"> 447</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00448"></a><span class="lineno"> 448</span>&#160; <span class="keywordtype">size_t</span> SizeofElement() <span class="keyword">const</span>;</div><div class="line"><a name="l00449"></a><span class="lineno"> 449</span>&#160;</div><div class="line"><a name="l00450"></a><span class="lineno"> 450</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00451"></a><span class="lineno"> 451</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00452"></a><span class="lineno"> 452</span>&#160;<span class="comment"> A pointer to sizeof_element bytes. The memory is zeroed.</span></div><div class="line"><a name="l00453"></a><span class="lineno"> 453</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00454"></a><span class="lineno"> 454</span>&#160; T* AllocateElement();</div><div class="line"><a name="l00455"></a><span class="lineno"> 455</span>&#160; </div><div class="line"><a name="l00456"></a><span class="lineno"> 456</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00457"></a><span class="lineno"> 457</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00458"></a><span class="lineno"> 458</span>&#160;<span class="comment"> Return an element to the pool.</span></div><div class="line"><a name="l00459"></a><span class="lineno"> 459</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00460"></a><span class="lineno"> 460</span>&#160;<span class="comment"> p - [in]</span></div><div class="line"><a name="l00461"></a><span class="lineno"> 461</span>&#160;<span class="comment"> A pointer returned by AllocateElement().</span></div><div class="line"><a name="l00462"></a><span class="lineno"> 462</span>&#160;<span class="comment"> It is critical that p be from this pool and that</span></div><div class="line"><a name="l00463"></a><span class="lineno"> 463</span>&#160;<span class="comment"> you return a pointer no more than one time.</span></div><div class="line"><a name="l00464"></a><span class="lineno"> 464</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00465"></a><span class="lineno"> 465</span>&#160;<span class="comment"> If you find the following remarks confusing, but you really want to use</span></div><div class="line"><a name="l00466"></a><span class="lineno"> 466</span>&#160;<span class="comment"> ReturnElement(), then here are some simple guidelines.</span></div><div class="line"><a name="l00467"></a><span class="lineno"> 467</span>&#160;<span class="comment"> 1) SizeofElement() must be &gt;= 16</span></div><div class="line"><a name="l00468"></a><span class="lineno"> 468</span>&#160;<span class="comment"> 2) SizeofElement() must be a multiple of 8.</span></div><div class="line"><a name="l00469"></a><span class="lineno"> 469</span>&#160;<span class="comment"> 3) Do not use FirstElement() and NextElement() to iterate through</span></div><div class="line"><a name="l00470"></a><span class="lineno"> 470</span>&#160;<span class="comment"> the pool.</span></div><div class="line"><a name="l00471"></a><span class="lineno"> 471</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00472"></a><span class="lineno"> 472</span>&#160;<span class="comment"> If 1 to 3 don&#39;t work for you, then you need to understand the following</span></div><div class="line"><a name="l00473"></a><span class="lineno"> 473</span>&#160;<span class="comment"> information before using ReturnElement().</span></div><div class="line"><a name="l00474"></a><span class="lineno"> 474</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00475"></a><span class="lineno"> 475</span>&#160;<span class="comment"> ON_FixedMemoryPool uses the first sizeof(void*) bytes of the</span></div><div class="line"><a name="l00476"></a><span class="lineno"> 476</span>&#160;<span class="comment"> returned element for bookkeeping purposes. Therefore, if you</span></div><div class="line"><a name="l00477"></a><span class="lineno"> 477</span>&#160;<span class="comment"> are going to use ReturnElement(), then SizeofElement() must be </span></div><div class="line"><a name="l00478"></a><span class="lineno"> 478</span>&#160;<span class="comment"> at least sizeof(void*). If you are using a platform that requires</span></div><div class="line"><a name="l00479"></a><span class="lineno"> 479</span>&#160;<span class="comment"> pointers to be aligned on sizeof(void*) boundaries, then</span></div><div class="line"><a name="l00480"></a><span class="lineno"> 480</span>&#160;<span class="comment"> SizeofElement() must be a multiple of sizeof(void*).</span></div><div class="line"><a name="l00481"></a><span class="lineno"> 481</span>&#160;<span class="comment"> If you are going to use ReturnElement() and then use FirstElement()</span></div><div class="line"><a name="l00482"></a><span class="lineno"> 482</span>&#160;<span class="comment"> and NextElement() to iterate through the list of elements, then you</span></div><div class="line"><a name="l00483"></a><span class="lineno"> 483</span>&#160;<span class="comment"> need to set a value in the returned element to indicate that it</span></div><div class="line"><a name="l00484"></a><span class="lineno"> 484</span>&#160;<span class="comment"> needs to be skipped during the iteration. This value cannot be</span></div><div class="line"><a name="l00485"></a><span class="lineno"> 485</span>&#160;<span class="comment"> located in the fist sizeof(void*) bytes of the element. If the </span></div><div class="line"><a name="l00486"></a><span class="lineno"> 486</span>&#160;<span class="comment"> element is a class with a vtable, you cannot call a virtual </span></div><div class="line"><a name="l00487"></a><span class="lineno"> 487</span>&#160;<span class="comment"> function on a returned element because the vtable pointer is </span></div><div class="line"><a name="l00488"></a><span class="lineno"> 488</span>&#160;<span class="comment"> trashed when ReturnElement() modifies the fist sizeof(void*) bytes.</span></div><div class="line"><a name="l00489"></a><span class="lineno"> 489</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00490"></a><span class="lineno"> 490</span>&#160; <span class="keywordtype">void</span> ReturnElement(T* p);</div><div class="line"><a name="l00491"></a><span class="lineno"> 491</span>&#160;</div><div class="line"><a name="l00492"></a><span class="lineno"> 492</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00493"></a><span class="lineno"> 493</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00494"></a><span class="lineno"> 494</span>&#160;<span class="comment"> Return all allocated elements to the pool. No heap is freed and</span></div><div class="line"><a name="l00495"></a><span class="lineno"> 495</span>&#160;<span class="comment"> the pool remains initialized and ready for AllocateElement()</span></div><div class="line"><a name="l00496"></a><span class="lineno"> 496</span>&#160;<span class="comment"> to be called.</span></div><div class="line"><a name="l00497"></a><span class="lineno"> 497</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00498"></a><span class="lineno"> 498</span>&#160; <span class="keywordtype">void</span> ReturnAll();</div><div class="line"><a name="l00499"></a><span class="lineno"> 499</span>&#160;</div><div class="line"><a name="l00500"></a><span class="lineno"> 500</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00501"></a><span class="lineno"> 501</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00502"></a><span class="lineno"> 502</span>&#160;<span class="comment"> Destroy the pool and free all the heap. The pool cannot be used again</span></div><div class="line"><a name="l00503"></a><span class="lineno"> 503</span>&#160;<span class="comment"> until Create() is called.</span></div><div class="line"><a name="l00504"></a><span class="lineno"> 504</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00505"></a><span class="lineno"> 505</span>&#160; <span class="keywordtype">void</span> Destroy();</div><div class="line"><a name="l00506"></a><span class="lineno"> 506</span>&#160;</div><div class="line"><a name="l00507"></a><span class="lineno"> 507</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00508"></a><span class="lineno"> 508</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00509"></a><span class="lineno"> 509</span>&#160;<span class="comment"> Number of active elements. (Elements that have been returned are not active.)</span></div><div class="line"><a name="l00510"></a><span class="lineno"> 510</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00511"></a><span class="lineno"> 511</span>&#160; <span class="keywordtype">size_t</span> ActiveElementCount() <span class="keyword">const</span>;</div><div class="line"><a name="l00512"></a><span class="lineno"> 512</span>&#160;</div><div class="line"><a name="l00513"></a><span class="lineno"> 513</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00514"></a><span class="lineno"> 514</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00515"></a><span class="lineno"> 515</span>&#160;<span class="comment"> Total number of elements = number of active elements + number of returned elements.</span></div><div class="line"><a name="l00516"></a><span class="lineno"> 516</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00517"></a><span class="lineno"> 517</span>&#160; <span class="keywordtype">size_t</span> TotalElementCount() <span class="keyword">const</span>;</div><div class="line"><a name="l00518"></a><span class="lineno"> 518</span>&#160;</div><div class="line"><a name="l00519"></a><span class="lineno"> 519</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00520"></a><span class="lineno"> 520</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00521"></a><span class="lineno"> 521</span>&#160;<span class="comment"> Get the i-th elment in the pool.</span></div><div class="line"><a name="l00522"></a><span class="lineno"> 522</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00523"></a><span class="lineno"> 523</span>&#160;<span class="comment"> element_index - [in]</span></div><div class="line"><a name="l00524"></a><span class="lineno"> 524</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00525"></a><span class="lineno"> 525</span>&#160;<span class="comment"> A pointer to the i-th element. The first element has index = 0</span></div><div class="line"><a name="l00526"></a><span class="lineno"> 526</span>&#160;<span class="comment"> and is the element returned by the first call to AllocateElement().</span></div><div class="line"><a name="l00527"></a><span class="lineno"> 527</span>&#160;<span class="comment"> The last element has index = ElementCount()-1.</span></div><div class="line"><a name="l00528"></a><span class="lineno"> 528</span>&#160;<span class="comment"> If i is out of range, null is returned.</span></div><div class="line"><a name="l00529"></a><span class="lineno"> 529</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00530"></a><span class="lineno"> 530</span>&#160;<span class="comment"> It is faster to use FirstElement() and NextElement() to iterate</span></div><div class="line"><a name="l00531"></a><span class="lineno"> 531</span>&#160;<span class="comment"> through the entire list of elements. This function is relatively</span></div><div class="line"><a name="l00532"></a><span class="lineno"> 532</span>&#160;<span class="comment"> efficient when there are a few large blocks in the pool</span></div><div class="line"><a name="l00533"></a><span class="lineno"> 533</span>&#160;<span class="comment"> or element_index is small compared to the number of elements</span></div><div class="line"><a name="l00534"></a><span class="lineno"> 534</span>&#160;<span class="comment"> in the first few blocks.</span></div><div class="line"><a name="l00535"></a><span class="lineno"> 535</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00536"></a><span class="lineno"> 536</span>&#160;<span class="comment"> If ReturnElement() is not used or AllocateElement() calls to</span></div><div class="line"><a name="l00537"></a><span class="lineno"> 537</span>&#160;<span class="comment"> are made after any use of ReturnElement(), then the i-th </span></div><div class="line"><a name="l00538"></a><span class="lineno"> 538</span>&#160;<span class="comment"> element is the one returned by the (i+1)-th call to </span></div><div class="line"><a name="l00539"></a><span class="lineno"> 539</span>&#160;<span class="comment"> AllocateElement().</span></div><div class="line"><a name="l00540"></a><span class="lineno"> 540</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00541"></a><span class="lineno"> 541</span>&#160; T* Element(<span class="keywordtype">size_t</span> element_index) <span class="keyword">const</span>;</div><div class="line"><a name="l00542"></a><span class="lineno"> 542</span>&#160;</div><div class="line"><a name="l00543"></a><span class="lineno"> 543</span>&#160; <span class="keywordtype">size_t</span> ElementIndex(</div><div class="line"><a name="l00544"></a><span class="lineno"> 544</span>&#160; T*</div><div class="line"><a name="l00545"></a><span class="lineno"> 545</span>&#160; ) <span class="keyword">const</span>;</div><div class="line"><a name="l00546"></a><span class="lineno"> 546</span>&#160;</div><div class="line"><a name="l00547"></a><span class="lineno"> 547</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00548"></a><span class="lineno"><a class="line" href="../../dd/d90/class_o_n___simple_fixed_size_pool_iterator.html"> 548</a></span>&#160; <span class="comment">// prohibit copy construction and operator=.</span></div><div class="line"><a name="l00549"></a><span class="lineno"> 549</span>&#160; <a class="code" href="../../d0/d41/class_o_n___simple_fixed_size_pool.html">ON_SimpleFixedSizePool</a>(<span class="keyword">const</span> <a class="code" href="../../d0/d41/class_o_n___simple_fixed_size_pool.html">ON_SimpleFixedSizePool&lt;T&gt;</a>&amp;);</div><div class="line"><a name="l00550"></a><span class="lineno"> 550</span>&#160; <a class="code" href="../../d0/d41/class_o_n___simple_fixed_size_pool.html">ON_SimpleFixedSizePool&lt;T&gt;</a>&amp; operator=(<span class="keyword">const</span> <a class="code" href="../../d0/d41/class_o_n___simple_fixed_size_pool.html">ON_SimpleFixedSizePool&lt;T&gt;</a>&amp;);</div><div class="line"><a name="l00551"></a><span class="lineno"> 551</span>&#160;};</div><div class="line"><a name="l00552"></a><span class="lineno"> 552</span>&#160;</div><div class="line"><a name="l00553"></a><span class="lineno"> 553</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt; <span class="keyword">class </span><a class="code" href="../../dd/d90/class_o_n___simple_fixed_size_pool_iterator.html">ON_SimpleFixedSizePoolIterator</a> : <span class="keyword">private</span> <a class="code" href="../../de/da1/class_o_n___fixed_size_pool_iterator.html">ON_FixedSizePoolIterator</a></div><div class="line"><a name="l00554"></a><span class="lineno"> 554</span>&#160;{</div><div class="line"><a name="l00555"></a><span class="lineno"> 555</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00556"></a><span class="lineno"> 556</span>&#160; <a class="code" href="../../dd/d90/class_o_n___simple_fixed_size_pool_iterator.html">ON_SimpleFixedSizePoolIterator</a>( <span class="keyword">const</span> <span class="keyword">class</span> <a class="code" href="../../d0/d41/class_o_n___simple_fixed_size_pool.html">ON_SimpleFixedSizePool&lt;T&gt;</a>&amp; fsp );</div><div class="line"><a name="l00557"></a><span class="lineno"> 557</span>&#160; <a class="code" href="../../dd/d90/class_o_n___simple_fixed_size_pool_iterator.html">ON_SimpleFixedSizePoolIterator</a>(<span class="keyword">const</span> <span class="keyword">class</span> <a class="code" href="../../dd/d90/class_o_n___simple_fixed_size_pool_iterator.html">ON_SimpleFixedSizePoolIterator&lt;T&gt;</a>&amp;);</div><div class="line"><a name="l00558"></a><span class="lineno"> 558</span>&#160;</div><div class="line"><a name="l00559"></a><span class="lineno"> 559</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00560"></a><span class="lineno"> 560</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00561"></a><span class="lineno"> 561</span>&#160;<span class="comment"> Get the first element when iterating through the list of elements.</span></div><div class="line"><a name="l00562"></a><span class="lineno"> 562</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00563"></a><span class="lineno"> 563</span>&#160;<span class="comment"> element_index - [in]</span></div><div class="line"><a name="l00564"></a><span class="lineno"> 564</span>&#160;<span class="comment"> If you use the version of FirstElement() that has an </span></div><div class="line"><a name="l00565"></a><span class="lineno"> 565</span>&#160;<span class="comment"> element_index parameter, then the iteration begins at</span></div><div class="line"><a name="l00566"></a><span class="lineno"> 566</span>&#160;<span class="comment"> that element.</span></div><div class="line"><a name="l00567"></a><span class="lineno"> 567</span>&#160;<span class="comment"> Example:</span></div><div class="line"><a name="l00568"></a><span class="lineno"> 568</span>&#160;<span class="comment"> The loop will iteratate through all the elements returned from</span></div><div class="line"><a name="l00569"></a><span class="lineno"> 569</span>&#160;<span class="comment"> AllocateElement(), including any that have be returned to the pool</span></div><div class="line"><a name="l00570"></a><span class="lineno"> 570</span>&#160;<span class="comment"> using ReturnElement().</span></div><div class="line"><a name="l00571"></a><span class="lineno"> 571</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00572"></a><span class="lineno"> 572</span>&#160;<span class="comment"> // iterate through all elements in the pool</span></div><div class="line"><a name="l00573"></a><span class="lineno"> 573</span>&#160;<span class="comment"> // This iteration will go through TotalElements() items.</span></div><div class="line"><a name="l00574"></a><span class="lineno"> 574</span>&#160;<span class="comment"> for ( void* p = FirstElement(); 0 != p; p = NextElement() )</span></div><div class="line"><a name="l00575"></a><span class="lineno"> 575</span>&#160;<span class="comment"> {</span></div><div class="line"><a name="l00576"></a><span class="lineno"> 576</span>&#160;<span class="comment"> // If you are not using ReturnElement(), then you may process</span></div><div class="line"><a name="l00577"></a><span class="lineno"> 577</span>&#160;<span class="comment"> // &quot;p&quot; immediately. If you have used ReturnElement(), then you</span></div><div class="line"><a name="l00578"></a><span class="lineno"> 578</span>&#160;<span class="comment"> // must check some value in p located after the first sizeof(void*)</span></div><div class="line"><a name="l00579"></a><span class="lineno"> 579</span>&#160;<span class="comment"> // bytes to see if p is active.</span></div><div class="line"><a name="l00580"></a><span class="lineno"> 580</span>&#160;<span class="comment"> if ( p is not active )</span></div><div class="line"><a name="l00581"></a><span class="lineno"> 581</span>&#160;<span class="comment"> continue;</span></div><div class="line"><a name="l00582"></a><span class="lineno"> 582</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00583"></a><span class="lineno"> 583</span>&#160;<span class="comment"> ... process p</span></div><div class="line"><a name="l00584"></a><span class="lineno"> 584</span>&#160;<span class="comment"> }</span></div><div class="line"><a name="l00585"></a><span class="lineno"> 585</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00586"></a><span class="lineno"> 586</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00587"></a><span class="lineno"> 587</span>&#160;<span class="comment"> The first element when iterating through the list of elements.</span></div><div class="line"><a name="l00588"></a><span class="lineno"> 588</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00589"></a><span class="lineno"> 589</span>&#160;<span class="comment"> FirstElement() and NextElement() will return elements that have </span></div><div class="line"><a name="l00590"></a><span class="lineno"> 590</span>&#160;<span class="comment"> been returned to the pool using ReturnElement(). If you use </span></div><div class="line"><a name="l00591"></a><span class="lineno"> 591</span>&#160;<span class="comment"> ReturnElement(), then be sure to mark the element so it can be</span></div><div class="line"><a name="l00592"></a><span class="lineno"> 592</span>&#160;<span class="comment"> identified and skipped.</span></div><div class="line"><a name="l00593"></a><span class="lineno"> 593</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00594"></a><span class="lineno"> 594</span>&#160;<span class="comment"> Do not make any calls to FirstBlock() or NextBlock() when using</span></div><div class="line"><a name="l00595"></a><span class="lineno"> 595</span>&#160;<span class="comment"> FirstElement() and NextElement() to iteratate through elements.</span></div><div class="line"><a name="l00596"></a><span class="lineno"> 596</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00597"></a><span class="lineno"> 597</span>&#160; T* FirstElement();</div><div class="line"><a name="l00598"></a><span class="lineno"> 598</span>&#160; T* FirstElement( <span class="keywordtype">size_t</span> element_index );</div><div class="line"><a name="l00599"></a><span class="lineno"> 599</span>&#160;</div><div class="line"><a name="l00600"></a><span class="lineno"> 600</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00601"></a><span class="lineno"> 601</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00602"></a><span class="lineno"> 602</span>&#160;<span class="comment"> Get the next element when iterating through the list of elements.</span></div><div class="line"><a name="l00603"></a><span class="lineno"> 603</span>&#160;<span class="comment"> If FirstElement() is not called, then the first call to</span></div><div class="line"><a name="l00604"></a><span class="lineno"> 604</span>&#160;<span class="comment"> NextElement() returns the first element.</span></div><div class="line"><a name="l00605"></a><span class="lineno"> 605</span>&#160;<span class="comment"> Example:</span></div><div class="line"><a name="l00606"></a><span class="lineno"> 606</span>&#160;<span class="comment"> See the FirstElement() documentation.</span></div><div class="line"><a name="l00607"></a><span class="lineno"> 607</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00608"></a><span class="lineno"> 608</span>&#160;<span class="comment"> The next element when iterating through the list of elements.</span></div><div class="line"><a name="l00609"></a><span class="lineno"> 609</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00610"></a><span class="lineno"> 610</span>&#160;<span class="comment"> FirstElement() and NextElement() will return elements that have </span></div><div class="line"><a name="l00611"></a><span class="lineno"> 611</span>&#160;<span class="comment"> been returned to the pool using ReturnElement(). If you use </span></div><div class="line"><a name="l00612"></a><span class="lineno"> 612</span>&#160;<span class="comment"> ReturnElement(), then be sure to mark the element so it can be</span></div><div class="line"><a name="l00613"></a><span class="lineno"> 613</span>&#160;<span class="comment"> identified and skipped.</span></div><div class="line"><a name="l00614"></a><span class="lineno"> 614</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00615"></a><span class="lineno"> 615</span>&#160;<span class="comment"> Do not make any calls to FirstBlock() or NextBlock() when using</span></div><div class="line"><a name="l00616"></a><span class="lineno"> 616</span>&#160;<span class="comment"> FirstElement() and NextElement() to iteratate through elements.</span></div><div class="line"><a name="l00617"></a><span class="lineno"> 617</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00618"></a><span class="lineno"> 618</span>&#160; T* NextElement();</div><div class="line"><a name="l00619"></a><span class="lineno"> 619</span>&#160;</div><div class="line"><a name="l00620"></a><span class="lineno"> 620</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00621"></a><span class="lineno"> 621</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00622"></a><span class="lineno"> 622</span>&#160;<span class="comment"> The most recently returned value from a call to FirstElement()</span></div><div class="line"><a name="l00623"></a><span class="lineno"> 623</span>&#160;<span class="comment"> or NextElement().</span></div><div class="line"><a name="l00624"></a><span class="lineno"> 624</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00625"></a><span class="lineno"> 625</span>&#160;<span class="comment"> Do not make any calls to FirstBlock() or NextBlock() when using</span></div><div class="line"><a name="l00626"></a><span class="lineno"> 626</span>&#160;<span class="comment"> FirstElement() and NextElement() to iteratate through elements.</span></div><div class="line"><a name="l00627"></a><span class="lineno"> 627</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00628"></a><span class="lineno"> 628</span>&#160; T* CurrentElement();</div><div class="line"><a name="l00629"></a><span class="lineno"> 629</span>&#160;</div><div class="line"><a name="l00630"></a><span class="lineno"> 630</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00631"></a><span class="lineno"> 631</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00632"></a><span class="lineno"> 632</span>&#160;<span class="comment"> Sets the state of the iterator to the initail state that</span></div><div class="line"><a name="l00633"></a><span class="lineno"> 633</span>&#160;<span class="comment"> exists after construction. This is useful if the iterator</span></div><div class="line"><a name="l00634"></a><span class="lineno"> 634</span>&#160;<span class="comment"> has been used the get one or more elements and then</span></div><div class="line"><a name="l00635"></a><span class="lineno"> 635</span>&#160;<span class="comment"> the referenced fixed size pool is modified or code wants</span></div><div class="line"><a name="l00636"></a><span class="lineno"> 636</span>&#160;<span class="comment"> to begin iteration again a used a call to NextElement()</span></div><div class="line"><a name="l00637"></a><span class="lineno"> 637</span>&#160;<span class="comment"> to return the first element.</span></div><div class="line"><a name="l00638"></a><span class="lineno"> 638</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00639"></a><span class="lineno"> 639</span>&#160; <span class="keywordtype">void</span> Reset();</div><div class="line"><a name="l00640"></a><span class="lineno"> 640</span>&#160;</div><div class="line"><a name="l00641"></a><span class="lineno"> 641</span>&#160;</div><div class="line"><a name="l00642"></a><span class="lineno"> 642</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00643"></a><span class="lineno"> 643</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00644"></a><span class="lineno"> 644</span>&#160;<span class="comment"> Get a pointer to the first element in the first block.</span></div><div class="line"><a name="l00645"></a><span class="lineno"> 645</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00646"></a><span class="lineno"> 646</span>&#160;<span class="comment"> block_element_count - [out] (can be null)</span></div><div class="line"><a name="l00647"></a><span class="lineno"> 647</span>&#160;<span class="comment"> If not null, the number of elements allocated from the</span></div><div class="line"><a name="l00648"></a><span class="lineno"> 648</span>&#160;<span class="comment"> first block is returned in block_element_count.</span></div><div class="line"><a name="l00649"></a><span class="lineno"> 649</span>&#160;<span class="comment"> Note that if you have used ReturnElement(), some</span></div><div class="line"><a name="l00650"></a><span class="lineno"> 650</span>&#160;<span class="comment"> of these elemements may have been returned.</span></div><div class="line"><a name="l00651"></a><span class="lineno"> 651</span>&#160;<span class="comment"> Example:</span></div><div class="line"><a name="l00652"></a><span class="lineno"> 652</span>&#160;<span class="comment"> The loop will iteratate through all the blocks.</span></div><div class="line"><a name="l00653"></a><span class="lineno"> 653</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00654"></a><span class="lineno"> 654</span>&#160;<span class="comment"> // iterate through all blocks in the pool</span></div><div class="line"><a name="l00655"></a><span class="lineno"> 655</span>&#160;<span class="comment"> size_t block_element_count = 0;</span></div><div class="line"><a name="l00656"></a><span class="lineno"> 656</span>&#160;<span class="comment"> for ( void* p = FirstBlock(&amp;block_element_count); </span></div><div class="line"><a name="l00657"></a><span class="lineno"> 657</span>&#160;<span class="comment"> 0 != p; </span></div><div class="line"><a name="l00658"></a><span class="lineno"> 658</span>&#160;<span class="comment"> p = NextBlock(&amp;block_element_count) </span></div><div class="line"><a name="l00659"></a><span class="lineno"> 659</span>&#160;<span class="comment"> )</span></div><div class="line"><a name="l00660"></a><span class="lineno"> 660</span>&#160;<span class="comment"> {</span></div><div class="line"><a name="l00661"></a><span class="lineno"> 661</span>&#160;<span class="comment"> ElementType* e = (ElementType*)p;</span></div><div class="line"><a name="l00662"></a><span class="lineno"> 662</span>&#160;<span class="comment"> for ( size_t i = 0; </span></div><div class="line"><a name="l00663"></a><span class="lineno"> 663</span>&#160;<span class="comment"> i &lt; block_element_count; </span></div><div class="line"><a name="l00664"></a><span class="lineno"> 664</span>&#160;<span class="comment"> i++, e = ((const char*)e) + SizeofElement() </span></div><div class="line"><a name="l00665"></a><span class="lineno"> 665</span>&#160;<span class="comment"> )</span></div><div class="line"><a name="l00666"></a><span class="lineno"> 666</span>&#160;<span class="comment"> {</span></div><div class="line"><a name="l00667"></a><span class="lineno"> 667</span>&#160;<span class="comment"> ...</span></div><div class="line"><a name="l00668"></a><span class="lineno"> 668</span>&#160;<span class="comment"> }</span></div><div class="line"><a name="l00669"></a><span class="lineno"> 669</span>&#160;<span class="comment"> }</span></div><div class="line"><a name="l00670"></a><span class="lineno"> 670</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00671"></a><span class="lineno"> 671</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00672"></a><span class="lineno"> 672</span>&#160;<span class="comment"> The first block when iterating the list of blocks.</span></div><div class="line"><a name="l00673"></a><span class="lineno"> 673</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00674"></a><span class="lineno"> 674</span>&#160;<span class="comment"> The heap for a fixed size memory pool is simply a linked</span></div><div class="line"><a name="l00675"></a><span class="lineno"> 675</span>&#160;<span class="comment"> list of blocks. FirstBlock() and NextBlock() can be used</span></div><div class="line"><a name="l00676"></a><span class="lineno"> 676</span>&#160;<span class="comment"> to iterate through the list of blocks.</span></div><div class="line"><a name="l00677"></a><span class="lineno"> 677</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00678"></a><span class="lineno"> 678</span>&#160;<span class="comment"> Do not make any calls to FirstElement() or NextElement() when using</span></div><div class="line"><a name="l00679"></a><span class="lineno"> 679</span>&#160;<span class="comment"> FirstBlock() and NextBlock() to iteratate through blocks.</span></div><div class="line"><a name="l00680"></a><span class="lineno"> 680</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00681"></a><span class="lineno"> 681</span>&#160; T* FirstBlock( <span class="keywordtype">size_t</span>* block_element_count );</div><div class="line"><a name="l00682"></a><span class="lineno"> 682</span>&#160;</div><div class="line"><a name="l00683"></a><span class="lineno"> 683</span>&#160; <span class="comment">/*</span></div><div class="line"><a name="l00684"></a><span class="lineno"> 684</span>&#160;<span class="comment"> Description:</span></div><div class="line"><a name="l00685"></a><span class="lineno"> 685</span>&#160;<span class="comment"> Get the next block when iterating through the blocks.</span></div><div class="line"><a name="l00686"></a><span class="lineno"> 686</span>&#160;<span class="comment"> Parameters:</span></div><div class="line"><a name="l00687"></a><span class="lineno"> 687</span>&#160;<span class="comment"> block_element_count - [out] (can be null)</span></div><div class="line"><a name="l00688"></a><span class="lineno"> 688</span>&#160;<span class="comment"> If not null, the number of elements allocated from the</span></div><div class="line"><a name="l00689"></a><span class="lineno"> 689</span>&#160;<span class="comment"> block is returned in block_element_count. Note that if</span></div><div class="line"><a name="l00690"></a><span class="lineno"> 690</span>&#160;<span class="comment"> you have used ReturnElement(), some of these elemements</span></div><div class="line"><a name="l00691"></a><span class="lineno"> 691</span>&#160;<span class="comment"> may have been returned.</span></div><div class="line"><a name="l00692"></a><span class="lineno"> 692</span>&#160;<span class="comment"> Example:</span></div><div class="line"><a name="l00693"></a><span class="lineno"> 693</span>&#160;<span class="comment"> See the FirstBlock() documentation.</span></div><div class="line"><a name="l00694"></a><span class="lineno"> 694</span>&#160;<span class="comment"> Returns:</span></div><div class="line"><a name="l00695"></a><span class="lineno"> 695</span>&#160;<span class="comment"> The next block when iterating through the blocks.</span></div><div class="line"><a name="l00696"></a><span class="lineno"> 696</span>&#160;<span class="comment"> Remarks:</span></div><div class="line"><a name="l00697"></a><span class="lineno"> 697</span>&#160;<span class="comment"> Do not make any calls to FirstElement() or NextElement() when using</span></div><div class="line"><a name="l00698"></a><span class="lineno"> 698</span>&#160;<span class="comment"> FirstBlock() and NextBlock() to iteratate through blocks.</span></div><div class="line"><a name="l00699"></a><span class="lineno"> 699</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00700"></a><span class="lineno"> 700</span>&#160; T* NextBlock( <span class="keywordtype">size_t</span>* block_element_count );</div><div class="line"><a name="l00701"></a><span class="lineno"> 701</span>&#160;</div><div class="line"><a name="l00702"></a><span class="lineno"> 702</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00703"></a><span class="lineno"> 703</span>&#160; <span class="comment">// no implementation (you can use a copy construtor)</span></div><div class="line"><a name="l00704"></a><span class="lineno"> 704</span>&#160; <span class="keyword">class </span><a class="code" href="../../dd/d90/class_o_n___simple_fixed_size_pool_iterator.html">ON_SimpleFixedSizePoolIterator</a>&lt;T&gt;&amp; operator=(<span class="keyword">const</span> <span class="keyword">class</span> <a class="code" href="../../dd/d90/class_o_n___simple_fixed_size_pool_iterator.html">ON_SimpleFixedSizePoolIterator&lt;T&gt;</a>&amp;);</div><div class="line"><a name="l00705"></a><span class="lineno"> 705</span>&#160;};</div><div class="line"><a name="l00706"></a><span class="lineno"> 706</span>&#160;</div><div class="line"><a name="l00707"></a><span class="lineno"> 707</span>&#160;<span class="comment">// definitions of the template functions are in a different file</span></div><div class="line"><a name="l00708"></a><span class="lineno"> 708</span>&#160;<span class="comment">// so that Microsoft&#39;s developer studio&#39;s autocomplete utility</span></div><div class="line"><a name="l00709"></a><span class="lineno"> 709</span>&#160;<span class="comment">// will work on the template functions.</span></div><div class="line"><a name="l00710"></a><span class="lineno"> 710</span>&#160;<span class="preprocessor">#include &quot;opennurbs_fsp_defs.h&quot;</span></div><div class="line"><a name="l00711"></a><span class="lineno"> 711</span>&#160;</div><div class="line"><a name="l00712"></a><span class="lineno"> 712</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00713"></a><span class="lineno"> 713</span>&#160;</div><div class="ttc" id="class_o_n___fixed_size_pool_html"><div class="ttname"><a href="../../d8/d75/class_o_n___fixed_size_pool.html">ON_FixedSizePool</a></div><div class="ttdef"><b>Definition:</b> opennurbs_fsp.h:19</div></div>
<div class="ttc" id="class_o_n___simple_fixed_size_pool_html"><div class="ttname"><a href="../../d0/d41/class_o_n___simple_fixed_size_pool.html">ON_SimpleFixedSizePool</a></div><div class="ttdef"><b>Definition:</b> opennurbs_fsp.h:411</div></div>
<div class="ttc" id="class_o_n___simple_fixed_size_pool_iterator_html"><div class="ttname"><a href="../../dd/d90/class_o_n___simple_fixed_size_pool_iterator.html">ON_SimpleFixedSizePoolIterator</a></div><div class="ttdef"><b>Definition:</b> opennurbs_fsp.h:548</div></div>
<div class="ttc" id="class_o_n___fixed_size_pool_iterator_html"><div class="ttname"><a href="../../de/da1/class_o_n___fixed_size_pool_iterator.html">ON_FixedSizePoolIterator</a></div><div class="ttdef"><b>Definition:</b> opennurbs_fsp.h:239</div></div>
<div class="ttc" id="class_o_n___fixed_size_pool_html_a0904463b277ba449081d8b2929c8ef26"><div class="ttname"><a href="../../d8/d75/class_o_n___fixed_size_pool.html#a0904463b277ba449081d8b2929c8ef26">ON_FixedSizePool::Create</a></div><div class="ttdeci">bool Create(size_t sizeof_element, size_t element_count_estimate, size_t block_element_capacity)</div><div class="ttdoc">Create a fixed size memory pool. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- HTML footer for doxygen 1.8.13-->
<!-- start footer part -->
</div> <!-- page-content -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Feb 3 2018 11:08:27 for openNURBS SDK Help by <a href="http://www.doxygen.org/index.html">
<!-- <img class="footer" src="../../doxygen.png" alt="doxygen"/> -->
Doxygen
</a> 1.8.13
</small></address>
</div> <!-- container -->
<!-- doxy-boot -->
<script type="text/javascript" src="../../doxy-boot.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink