1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7    <style type="text/css"><!--
8      span.static_style
9      {
10        font-size			: 8pt;
11        color				: white;
12        font-weight			: bold;
13        background			: #44f;
14        border-left			: solid 1px #aaf;
15        border-top			: solid 1px #aaf;
16        border-right		: solid 1px #00c;
17        border-bottom		: solid 1px #00c;
18        padding-left		: 2px;
19        padding-right		: 2px;
20      }
21
22      span.virtual_style
23      {
24        font-size			 : 8pt;
25        color				 : white;
26        font-weight			: bold;
27        background			: #0a0;
28        border-left			: solid 1px #0f0;
29        border-top			: solid 1px #0f0;
30        border-right		: solid 1px #060;
31        border-bottom		: solid 1px #060;
32        padding-left		: 2px;
33        padding-right		: 2px;
34      }
35
36      span.protected_style
37      {
38        font-size			 : 8pt;
39        color				 : white;
40        font-weight			: bold;
41        background			: #444;
42        border-left			: solid 1px #ccc;
43        border-top			: solid 1px #ccc;
44        border-right		: solid 1px #222;
45        border-bottom		: solid 1px #222;
46        padding-left		: 2px;
47        padding-right		: 2px;
48      }
49        --></style>
50<title>nn::fnd::HeapBase</title>
51  </head>
52  <body>
53<h1><CODE>nn::fnd::HeapBase</CODE> Class</h1>
54<h2>Syntax</h2>
55    <div class="section">
56      <pre class="definition">class HeapBase : public nn::fnd::IntrusiveLinkedList<HeapBase>::Item</pre>
57    </div>
58<h2>Description</h2>
59    <div class="section">
60<p>Base class for heaps.</p><p>This class cannot be instantiated.</p><!-- write here --></div>
61    <a name="function" id="function">
62<h2>Member Functions</h2>
63      <div class="section">
64        <table class="members">
65          <tr>
66            <td width="100">
67<span class="static_style" title="static">S</span> </td>
68            <th>
69<a href="../../../nn/fnd/HeapBase/SetFillValue.html"><CODE>SetFillValue</CODE></a>
70            </th>
71<td>Sets the type of fill and the value used to fill the heap.</td>
72          </tr>
73          <tr>
74            <td width="100">
75<span class="static_style" title="static">S</span> </td>
76            <th>
77<a href="../../../nn/fnd/HeapBase/GetFillValue.html"><CODE>GetFillValue</CODE></a>
78            </th>
79<td>Gets the type of fill used to fill the heap.</td>
80          </tr>
81          <tr>
82<td width="100"> <span class="virtual_style" title="pure-virtual">PV</span>
83            </td>
84            <th>
85<a href="../../../nn/fnd/HeapBase/~HeapBase.html"><CODE>~HeapBase</CODE></a>
86            </th>
87<td>Destructor.</td>
88          </tr>
89          <tr>
90<td width="100"> <span class="virtual_style" title="pure-virtual">PV</span>
91            </td>
92            <th>
93<a href="../../../nn/fnd/HeapBase/FreeV.html"><CODE>FreeV</CODE></a>
94            </th>
95<td>Frees memory blocks that have been allocated.</td>
96          </tr>
97          <tr>
98<td width="100"> <span class="virtual_style" title="pure-virtual">PV</span>
99            </td>
100            <th>
101<a href="../../../nn/fnd/HeapBase/GetStartAddress.html"><CODE>GetStartAddress</CODE></a>
102            </th>
103<td>Returns the starting address of the memory region used by the calling heap.</td>
104          </tr>
105          <tr>
106<td width="100"> <span class="virtual_style" title="pure-virtual">PV</span>
107            </td>
108            <th>
109<a href="../../../nn/fnd/HeapBase/GetTotalSize.html"><CODE>GetTotalSize</CODE></a>
110            </th>
111<td>Returns the size of the memory region used by the calling heap.</td>
112          </tr>
113          <tr>
114<td width="100"> <span class="virtual_style" title="pure-virtual">PV</span>
115            </td>
116            <th>
117<a href="../../../nn/fnd/HeapBase/Dump.html"><CODE>Dump</CODE></a>
118            </th>
119<td>Dumps the content of the heap for debugging purposes.</td>
120          </tr>
121          <tr>
122<td width="100"> <span class="virtual_style" title="pure-virtual">PV</span>
123            </td>
124            <th>
125<a href="../../../nn/fnd/HeapBase/HasAddress.html"><CODE>HasAddress</CODE></a>
126            </th>
127<td>Determines whether the specified address is located within a heap.</td>
128          </tr>
129          <tr>
130            <td width="100">  </td>
131            <th>
132<a href="../../../nn/fnd/HeapBase/GetParent.html"><CODE>GetParent</CODE></a>
133            </th>
134<td>Gets the parent heap.</td>
135          </tr>
136          <tr>
137            <td width="100">  </td>
138            <th>
139<a href="../../../nn/fnd/HeapBase/GetRoot.html"><CODE>GetRoot</CODE></a>
140            </th>
141<td>Returns the root heap of the calling heap.</td>
142          </tr>
143          <tr>
144            <td width="100">  </td>
145            <th>
146<a href="../../../nn/fnd/HeapBase/FindHeap.html"><CODE>FindHeap</CODE></a>
147            </th>
148<td>Searches for the heap to which the specified address belongs.</td>
149          </tr>
150          <tr>
151            <td width="100">  </td>
152            <th>
153<a href="../../../nn/fnd/HeapBase/Destroy.html"><CODE>Destroy</CODE></a>
154            </th>
155<td>Destroys a heap that was created within a parent heap.</td>
156          </tr> </table>
157      </div>
158    </a>
159<h2>Class Hierarchy</h2>
160    <div class="section">
161<p class="hierarchy"><span>ADLFireWall::NonCopyable</span><br />  <span>nn::fnd::IntrusiveLinkedList</span><br />    <b>nn::fnd::HeapBase</b>
162      </p>
163    </div>
164<h2>Revision History</h2>
165    <div class="section">
166      <dl class="history">
167        <dt>2010/01/07</dt>
168<dd>Initial version.<br />
169        </dd>
170      </dl>
171    </div>
172  <hr><p>CONFIDENTIAL</p></body>
173</html>