Google Git
Sign in
apache / xalan-site / 0d2033dc971d6434bfdd3e0960f79af3b185abac / . / docs / xalan / xalan-c / apiDocs / classXNumberAllocator.html
blob: 246940f5d46bb9f03a6971f5670de3c87b72e00a [file] [log] [blame]
<!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"/>
<title>Xalan-C++ API : Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<!-- The head section is copied from Doxygen 1.7.1 generated default output -->
<body>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center"><a href="../index.html">The Xalan C++ XSLT Processor Version 1.11</a></h3>
<hr/>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>XNumberAllocator Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="XNumberAllocator" -->
<p><code>#include &lt;<a class="el" href="XNumberAllocator_8hpp_source.html">XNumberAllocator.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for XNumberAllocator:</div>
<div class="dyncontent">
<div class="center"><img src="classXNumberAllocator__coll__graph.png" border="0" usemap="#XNumberAllocator_coll__map" alt="Collaboration graph"/></div>
<map name="XNumberAllocator_coll__map" id="XNumberAllocator_coll__map">
<area shape="rect" id="node2" href="classReusableArenaAllocator.html" title="ReusableArenaAllocator\&lt; number_type \&gt;" alt="" coords="3132,248,3420,277"/><area shape="rect" id="node4" href="classArenaAllocator.html" title="ArenaAllocator\&lt; number_type, ReusableArenaBlock\&lt; number_type \&gt; \&gt;" alt="" coords="2596,248,3079,277"/><area shape="rect" id="node6" href="classXalanList.html" title="XalanList\&lt; ReusableArenaBlock\&lt; number_type \&gt; * \&gt;" alt="" coords="2097,221,2463,250"/><area shape="rect" id="node8" href="structXalanList_1_1Node.html" title="XalanList\&lt; Type \&gt;::Node" alt="" coords="1665,221,1847,250"/><area shape="rect" id="node11" href="classReusableArenaBlock.html" title="ReusableArenaBlock\&lt; number_type \&gt;" alt="" coords="2147,274,2413,304"/><area shape="rect" id="node13" href="classArenaBlockBase.html" title="ArenaBlockBase\&lt; number_type, unsigned short \&gt;" alt="" coords="1584,274,1928,304"/><area shape="rect" id="node15" href="classXNumber.html" title="XNumber" alt="" coords="1285,246,1368,276"/><area shape="rect" id="node17" href="classXNumberBase.html" title="XNumberBase" alt="" coords="1044,221,1159,250"/><area shape="rect" id="node19" href="classXObject.html" title="Class to hold XPath return types." alt="" coords="780,141,852,170"/><area shape="rect" id="node21" href="classXalanReferenceCountedObject.html" title="Class to hold reference count information." alt="" coords="333,6,552,36"/><area shape="rect" id="node23" href="classXObjectFactory.html" title="This class handles the creation of XObjects and manages their lifetime." alt="" coords="384,60,501,89"/><area shape="rect" id="node25" href="classXalanDOMString.html" title="XalanDOMString" alt="" coords="379,250,507,280"/><area shape="rect" id="node27" href="classXalanVector.html" title="XalanVector\&lt; XalanDOMChar \&gt;" alt="" coords="7,250,233,280"/><area shape="rect" id="node30" href="classXalanAllocator.html" title="XalanAllocator\&lt; number_type \&gt;" alt="" coords="1212,300,1441,329"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classXNumberAllocator-members.html">List of all members.</a></p>
<h2><a name="pub-types"></a>
Public Types</h2>
<ul>
<li>typedef <a class="el" href="classXNumber.html">XNumber</a> <a class="el" href="classXNumberAllocator.html#afb2be3b0f8af749e72d941bf77669289">number_type</a>
<li>typedef <a class="el" href="classReusableArenaAllocator.html">ReusableArenaAllocator</a><br class="typebreak"/>
&lt; <a class="el" href="classXNumber.html">number_type</a> &gt; <a class="el" href="classXNumberAllocator.html#afe3ab6203925005ab5c49fdd67bc7b8c">ArenaAllocatorType</a>
<li>typedef <br class="typebreak"/>
<a class="el" href="classReusableArenaAllocator.html#acf80af42a3e56e0f51dfc8b490944b8b">ArenaAllocatorType::size_type</a> <a class="el" href="classXNumberAllocator.html#af3330583e4a23f13f12f2501ecd1462f">size_type</a>
</ul>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classXNumberAllocator.html#a8a74c1ab5b12203630fd923db7c41413">XNumberAllocator</a> (MemoryManager &amp;theManager, <a class="el" href="classXNumberAllocator.html#af3330583e4a23f13f12f2501ecd1462f">size_type</a> theBlockCount)
<dl class="el"><dd class="mdescRight">Construct an instance that will allocate blocks of the specified size. <a href="#a8a74c1ab5b12203630fd923db7c41413"></a><br/></dl><li><a class="el" href="classXNumberAllocator.html#a693c3efdc9821113eed347c45e254901">~XNumberAllocator</a> ()
<li><a class="el" href="classXNumber.html">number_type</a> * <a class="el" href="classXNumberAllocator.html#a88bf52d42acd37a5d59cc8999813f2ec">createNumber</a> (double theNumber)
<dl class="el"><dd class="mdescRight">Create an <a class="el" href="classXNumber.html">XNumber</a> object using allocator from a string. <a href="#a88bf52d42acd37a5d59cc8999813f2ec"></a><br/></dl><li>bool <a class="el" href="classXNumberAllocator.html#adeffdc6949138672a667b667d546ff16">destroy</a> (<a class="el" href="classXNumber.html">number_type</a> *theNumber)
<dl class="el"><dd class="mdescRight">Delete an <a class="el" href="classXNumber.html">XNumber</a> object from allocator. <a href="#adeffdc6949138672a667b667d546ff16"></a><br/></dl><li>bool <a class="el" href="classXNumberAllocator.html#addff789e2fa71fa8188b17033328b1b1">ownsObject</a> (const <a class="el" href="classXNumber.html">number_type</a> *theObject)
<dl class="el"><dd class="mdescRight">Determine if an object is owned by the allocator... <a href="#addff789e2fa71fa8188b17033328b1b1"></a><br/></dl><li>void <a class="el" href="classXNumberAllocator.html#a9bece5fa2011c16f89dc29c7f7067969">reset</a> ()
<dl class="el"><dd class="mdescRight">Delete all <a class="el" href="classXNumber.html">XNumber</a> objects from allocator. <a href="#a9bece5fa2011c16f89dc29c7f7067969"></a><br/></dl><li><a class="el" href="classXNumberAllocator.html#af3330583e4a23f13f12f2501ecd1462f">size_type</a> <a class="el" href="classXNumberAllocator.html#ab332a09789c3b52961ad79d7252f9cb4">getBlockCount</a> () const
<dl class="el"><dd class="mdescRight">Get size of an <a class="el" href="classArenaBlock.html">ArenaBlock</a>, that is, the number of objects in each block. <a href="#ab332a09789c3b52961ad79d7252f9cb4"></a><br/></dl><li><a class="el" href="classXNumberAllocator.html#af3330583e4a23f13f12f2501ecd1462f">size_type</a> <a class="el" href="classXNumberAllocator.html#a9edb4ac829cb6f53cec0b138194359b8">getBlockSize</a> () const
<dl class="el"><dd class="mdescRight">Get the number of ArenaBlocks currently allocated. <a href="#a9edb4ac829cb6f53cec0b138194359b8"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="XNumberAllocator_8hpp_source.html#l00041">41</a> of file <a class="el" href="XNumberAllocator_8hpp_source.html">XNumberAllocator.hpp</a>.</p>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="afe3ab6203925005ab5c49fdd67bc7b8c"></a><!-- doxytag: member="XNumberAllocator::ArenaAllocatorType" ref="afe3ab6203925005ab5c49fdd67bc7b8c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classReusableArenaAllocator.html">ReusableArenaAllocator</a>&lt;<a class="el" href="classXNumber.html">number_type</a>&gt; <a class="el" href="classReusableArenaAllocator.html">XNumberAllocator::ArenaAllocatorType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XNumberAllocator_8hpp_source.html#l00047">47</a> of file <a class="el" href="XNumberAllocator_8hpp_source.html">XNumberAllocator.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="afb2be3b0f8af749e72d941bf77669289"></a><!-- doxytag: member="XNumberAllocator::number_type" ref="afb2be3b0f8af749e72d941bf77669289" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classXNumber.html">XNumber</a> <a class="el" href="classXNumber.html">XNumberAllocator::number_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XNumberAllocator_8hpp_source.html#l00045">45</a> of file <a class="el" href="XNumberAllocator_8hpp_source.html">XNumberAllocator.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="af3330583e4a23f13f12f2501ecd1462f"></a><!-- doxytag: member="XNumberAllocator::size_type" ref="af3330583e4a23f13f12f2501ecd1462f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classReusableArenaAllocator.html#acf80af42a3e56e0f51dfc8b490944b8b">ArenaAllocatorType::size_type</a> <a class="el" href="classXNumberAllocator.html#af3330583e4a23f13f12f2501ecd1462f">XNumberAllocator::size_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="XNumberAllocator_8hpp_source.html#l00048">48</a> of file <a class="el" href="XNumberAllocator_8hpp_source.html">XNumberAllocator.hpp</a>.</p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a8a74c1ab5b12203630fd923db7c41413"></a><!-- doxytag: member="XNumberAllocator::XNumberAllocator" ref="a8a74c1ab5b12203630fd923db7c41413" args="(MemoryManager &amp;theManager, size_type theBlockCount)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XNumberAllocator::XNumberAllocator </td>
<td>(</td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theManager</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXNumberAllocator.html#af3330583e4a23f13f12f2501ecd1462f">size_type</a>&nbsp;</td>
<td class="paramname"> <em>theBlockCount</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct an instance that will allocate blocks of the specified size. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theBlockSize</em>&nbsp;</td><td>The block size. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a693c3efdc9821113eed347c45e254901"></a><!-- doxytag: member="XNumberAllocator::~XNumberAllocator" ref="a693c3efdc9821113eed347c45e254901" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XNumberAllocator::~XNumberAllocator </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a88bf52d42acd37a5d59cc8999813f2ec"></a><!-- doxytag: member="XNumberAllocator::createNumber" ref="a88bf52d42acd37a5d59cc8999813f2ec" args="(double theNumber)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXNumber.html">number_type</a>* XNumberAllocator::createNumber </td>
<td>(</td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>theNumber</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an <a class="el" href="classXNumber.html">XNumber</a> object using allocator from a string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>theString</em>&nbsp;</td><td>source number</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to a number </dd></dl>
</div>
</div>
<a class="anchor" id="adeffdc6949138672a667b667d546ff16"></a><!-- doxytag: member="XNumberAllocator::destroy" ref="adeffdc6949138672a667b667d546ff16" args="(number_type *theNumber)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool XNumberAllocator::destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXNumber.html">number_type</a> *&nbsp;</td>
<td class="paramname"> <em>theNumber</em></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete an <a class="el" href="classXNumber.html">XNumber</a> object from allocator. </p>
</div>
</div>
<a class="anchor" id="ab332a09789c3b52961ad79d7252f9cb4"></a><!-- doxytag: member="XNumberAllocator::getBlockCount" ref="ab332a09789c3b52961ad79d7252f9cb4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXNumberAllocator.html#af3330583e4a23f13f12f2501ecd1462f">size_type</a> XNumberAllocator::getBlockCount </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get size of an <a class="el" href="classArenaBlock.html">ArenaBlock</a>, that is, the number of objects in each block. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The size of the block </dd></dl>
<p>Definition at line <a class="el" href="XNumberAllocator_8hpp_source.html#l00098">98</a> of file <a class="el" href="XNumberAllocator_8hpp_source.html">XNumberAllocator.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9edb4ac829cb6f53cec0b138194359b8"></a><!-- doxytag: member="XNumberAllocator::getBlockSize" ref="a9edb4ac829cb6f53cec0b138194359b8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXNumberAllocator.html#af3330583e4a23f13f12f2501ecd1462f">size_type</a> XNumberAllocator::getBlockSize </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of ArenaBlocks currently allocated. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of blocks. </dd></dl>
<p>Definition at line <a class="el" href="XNumberAllocator_8hpp_source.html#l00109">109</a> of file <a class="el" href="XNumberAllocator_8hpp_source.html">XNumberAllocator.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="addff789e2fa71fa8188b17033328b1b1"></a><!-- doxytag: member="XNumberAllocator::ownsObject" ref="addff789e2fa71fa8188b17033328b1b1" args="(const number_type *theObject)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool XNumberAllocator::ownsObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXNumber.html">number_type</a> *&nbsp;</td>
<td class="paramname"> <em>theObject</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determine if an object is owned by the allocator... </p>
<p>Definition at line <a class="el" href="XNumberAllocator_8hpp_source.html#l00080">80</a> of file <a class="el" href="XNumberAllocator_8hpp_source.html">XNumberAllocator.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9bece5fa2011c16f89dc29c7f7067969"></a><!-- doxytag: member="XNumberAllocator::reset" ref="a9bece5fa2011c16f89dc29c7f7067969" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void XNumberAllocator::reset </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete all <a class="el" href="classXNumber.html">XNumber</a> objects from allocator. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XNumberAllocator_8hpp_source.html">XNumberAllocator.hpp</a></li>
</ul>
</div>
<p align="center"><a href="graph_legend.html">Interpreting class diagrams</a></p>
<p><font color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><a href="http://www.doxygen.org/">Doxygen</a> and
<a href="http://www.graphviz.org/">GraphViz</a> are
used to generate this API documentation from the Xalan-C header files.</i></font></p>
<table border="0" cellpadding="0" cellspacing="0" width="80%">
<tr>
<td width="80%" valign="top">
<p align="center"><b>Xalan-C++ XSLT Processor Version 1.11</b><br/>
Copyright &copy; 1999-2012 The Apache Software Foundation.<br/>
All Rights Reserved.</p>
</td>
</tr>
<tr>
<td width="100%">
<p align="center"><img src="asf_logo_wide.gif" width="268" height="25" align="bottom" border="0" alt="Apache Logo">
</td>
</tr>
</table>
</body>
</html>