<!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>GNU CommonC++: ost::StackPager Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.3 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</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> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_stack_pager.html">StackPager</a> </div> </div> <div class="contents"> <h1>ost::StackPager Class Reference</h1><!-- doxytag: class="ost::StackPager" --><!-- doxytag: inherits="ost::MemPager" --> <p>The <a class="el" href="classost_1_1_stack_pager.html" title="The StackPager provides a repository to stash and retrieve working data in last-in-first-out...">StackPager</a> provides a repository to stash and retrieve working data in last-in-first-out order. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="misc_8h_source.html">misc.h</a>></code></p> <div class="dynheader"> Inheritance diagram for ost::StackPager:</div> <div class="dynsection"> <div class="center"> <img src="classost_1_1_stack_pager.png" usemap="#ost::StackPager_map" alt=""/> <map id="ost::StackPager_map" name="ost::StackPager_map"> <area href="classost_1_1_mem_pager.html" alt="ost::MemPager" shape="rect" coords="0,0,99,24"/> </map> </div> </div> <p><a href="classost_1_1_stack_pager-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Classes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>frame</b></td></tr> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_stack_pager.html#a9082f804e418179370e78a9d29da39e5">StackPager</a> (size_t pagesize)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a lifo pager as a mempager. <a href="#a9082f804e418179370e78a9d29da39e5"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_stack_pager.html#a89f60f5bb478d10354268a06f1441778">push</a> (const void *object, size_t size)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Push an arbitrary object onto the stack. <a href="#a89f60f5bb478d10354268a06f1441778"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_stack_pager.html#ae8993b8e8287ceeb1e9fe46f8e3670c6">push</a> (const char *string)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Push a string onto the stack. <a href="#ae8993b8e8287ceeb1e9fe46f8e3670c6"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_stack_pager.html#a4b840ef28c1c408d69d9b04729cd44a0">pull</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve next object from stack. <a href="#a4b840ef28c1c408d69d9b04729cd44a0"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_stack_pager.html#ac903c181770651ee8f42717892dd9fa4">purge</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Purge the stack of all objects and memory allocations. <a href="#ac903c181770651ee8f42717892dd9fa4"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>The <a class="el" href="classost_1_1_stack_pager.html" title="The StackPager provides a repository to stash and retrieve working data in last-in-first-out...">StackPager</a> provides a repository to stash and retrieve working data in last-in-first-out order. </p> <p>The use of a mempager to support it's operation allows storage of arbitrary sized objects with no fixed limit.</p> <dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> last in first out object pager. </dd></dl> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a9082f804e418179370e78a9d29da39e5"></a><!-- doxytag: member="ost::StackPager::StackPager" ref="a9082f804e418179370e78a9d29da39e5" args="(size_t pagesize)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::StackPager::StackPager </td> <td>(</td> <td class="paramtype">size_t </td> <td class="paramname"> <em>pagesize</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Create a lifo pager as a mempager. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>pagesize</em> </td><td>for memory allocation </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a4b840ef28c1c408d69d9b04729cd44a0"></a><!-- doxytag: member="ost::StackPager::pull" ref="a4b840ef28c1c408d69d9b04729cd44a0" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void* ost::StackPager::pull </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Retrieve next object from stack. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>object. </dd></dl> </div> </div> <a class="anchor" id="ac903c181770651ee8f42717892dd9fa4"></a><!-- doxytag: member="ost::StackPager::purge" ref="ac903c181770651ee8f42717892dd9fa4" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ost::StackPager::purge </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Purge the stack of all objects and memory allocations. </p> <p>Reimplemented from <a class="el" href="classost_1_1_mem_pager.html#a5bfdb6f2d6f569ba08c32c59efb3a012">ost::MemPager</a>.</p> </div> </div> <a class="anchor" id="ae8993b8e8287ceeb1e9fe46f8e3670c6"></a><!-- doxytag: member="ost::StackPager::push" ref="ae8993b8e8287ceeb1e9fe46f8e3670c6" args="(const char *string)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void* ost::StackPager::push </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>string</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Push a string onto the stack. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>stack memory location. </dd></dl> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>pointer. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a89f60f5bb478d10354268a06f1441778"></a><!-- doxytag: member="ost::StackPager::push" ref="a89f60f5bb478d10354268a06f1441778" args="(const void *object, size_t size)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void* ost::StackPager::push </td> <td>(</td> <td class="paramtype">const void * </td> <td class="paramname"> <em>object</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"> <em>size</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Push an arbitrary object onto the stack. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>stack memory location. </dd></dl> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>pointer to data </td></tr> <tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of data. </td></tr> </table> </dd> </dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="misc_8h_source.html">misc.h</a></li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Mar 12 10:07:40 2010 for GNU CommonC++ by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>