Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582
<!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>TB9.2 Example Applications: Stack 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.2 -->
<div class="contents">
<h1>Stack Class Reference</h1><!-- doxytag: class="Stack" -->
<p><a href="class_stack-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<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="class_stack.html#a40bd5dff912f0e5290777c4b46d17809">~Stack</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stack.html#a15effcd021a0a8ef515e543140a70a6e">Push</a> (<a class="el" href="struct_produced_item.html">ProducedItem</a> *aItem)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_produced_item.html">ProducedItem</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_stack.html#afcc483f12294ea49bcacb6cc528ece5a">Pop</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="stack_8h_source.html#l00026">26</a> of file <a class="el" href="stack_8h_source.html">stack.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a40bd5dff912f0e5290777c4b46d17809"></a><!-- doxytag: member="Stack::~Stack" ref="a40bd5dff912f0e5290777c4b46d17809" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Stack::~Stack </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor Delete all the items those are not yet consumed by the consumers </p>
<p>Definition at line <a class="el" href="stack_8h_source.html#l00037">37</a> of file <a class="el" href="stack_8h_source.html">stack.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a15effcd021a0a8ef515e543140a70a6e"></a><!-- doxytag: member="Stack::Push" ref="a15effcd021a0a8ef515e543140a70a6e" args="(ProducedItem *aItem)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Stack::Push </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_produced_item.html">ProducedItem</a> * </td>
<td class="paramname"> <em>aItem</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Push New Item is created on <a class="el" href="class_stack.html">Stack</a> for every push operation</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aItem</em> </td><td>- Item to be Pushed</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Nothing </dd></dl>
<p>Definition at line <a class="el" href="stack_8h_source.html#l00055">55</a> of file <a class="el" href="stack_8h_source.html">stack.h</a>.</p>
</div>
</div>
<a class="anchor" id="afcc483f12294ea49bcacb6cc528ece5a"></a><!-- doxytag: member="Stack::Pop" ref="afcc483f12294ea49bcacb6cc528ece5a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_produced_item.html">ProducedItem</a>* Stack::Pop </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pop Item is sent to the Consumer who is doing the Pop. Ownership will also ne given. So, this item has to be deleted by the Consumer.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Nothing</em> </td><td></td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>- Item Poped </dd></dl>
<p>Definition at line <a class="el" href="stack_8h_source.html#l00077">77</a> of file <a class="el" href="stack_8h_source.html">stack.h</a>.</p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>