embeddedsw/lib/bsp/xilkernel/doc/html/api/queue_8c.html
Jagannadha Sutradharudu Teki 2c8f92039d embeddesw: Add initial code support
Added initial support Xilinx Embedded Software.

Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
2014-06-24 16:45:01 +05:30

551 lines
22 KiB
HTML
Executable file

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>2014.1_doc: queue.c File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="dir_U_3A_2Fdoxygen_5Fpublish_2Fsources_2Fbsp_2Fxilkernel_5Fv6_5F0_2Fsrc_2Fsrc_2F.html">src</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_U_3A_2Fdoxygen_5Fpublish_2Fsources_2Fbsp_2Fxilkernel_5Fv6_5F0_2Fsrc_2Fsrc_2Fsys_2F.html">sys</a></div>
<h1>queue.c File Reference</h1><code>#include &lt;stdio.h&gt;</code><br>
<code>#include &lt;string.h&gt;</code><br>
<code>#include &lt;<a class="el" href="os__config_8h.html">os_config.h</a>&gt;</code><br>
<code>#include &lt;<a class="el" href="config__param_8h.html">config/config_param.h</a>&gt;</code><br>
<code>#include &lt;<a class="el" href="config__cparam_8h.html">config/config_cparam.h</a>&gt;</code><br>
<code>#include &lt;<a class="el" href="queue_8h.html">sys/queue.h</a>&gt;</code><br>
<code>#include &lt;<a class="el" href="mem_8h.html">sys/mem.h</a>&gt;</code><br>
<code>#include &lt;<a class="el" href="process_8h.html">sys/process.h</a>&gt;</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="queue_8c.html#85b2b717345035d2c2aeca6b1900adcb">alloc_q</a> (queuep queue, unsigned char max_items, unsigned char qtype, unsigned short size, unsigned char qno)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="queue_8c.html#447a05eef6ae6ae28bd864e441f245d9">qinit</a> (queuep queue)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="queue_8c.html#5fa90abb1bad7df3e16b729eec043f22">enq</a> (queuep queue, const void *item, unsigned short key)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="queue_8c.html#ce9ee801e66ff3eaa679d7e6fe93768b">deq</a> (queuep queue, void *item, unsigned short key)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="queue_8c.html#bc81bd01154705330c045710b82564c2">penq</a> (queuep queue, pid_t item, unsigned short key)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="queue_8c.html#ce7781e7b0b3c5722df849ed9e8bca38">pdeq</a> (queuep queue, pid_t *item, unsigned short key)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="queue_8c.html#1546951af92d518a34fc15e66c715276">pdelq</a> (queuep queue, pid_t item)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="queue_8c.html#a875e4560580d7aa00e79c22bc1a283d">prio_penq</a> (queuep queue, pid_t item, unsigned short key)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="queue_8c.html#e35dbad0448ab82405210a1a1c968bcc">prio_pdeq</a> (queuep queue, pid_t *item, unsigned short key)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This file contains the Queue Handling routines. <hr><h2>Function Documentation</h2>
<a class="anchor" name="85b2b717345035d2c2aeca6b1900adcb"></a><!-- doxytag: member="queue.c::alloc_q" ref="85b2b717345035d2c2aeca6b1900adcb" args="(queuep queue, unsigned char max_items, unsigned char qtype, unsigned short size, unsigned char qno)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void alloc_q </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">queuep&nbsp;</td>
<td class="mdname" nowrap> <em>queue</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned char&nbsp;</td>
<td class="mdname" nowrap> <em>max_items</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned char&nbsp;</td>
<td class="mdname" nowrap> <em>qtype</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned short&nbsp;</td>
<td class="mdname" nowrap> <em>size</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned char&nbsp;</td>
<td class="mdname" nowrap> <em>qno</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Initialize a Queue - Allocate array of memory to the Queue. Called during system initialization. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>queue</em>&nbsp;</td><td>is the queue of items.<ul>
<li>max_items is the maximum queue length.</li><li>size is size of the elements in the queue.</li><li>qtype is the type of Q. Each Q is allocated a static memory</li><li>qno is the queue number, In case of multiple queue's of the same type. </li></ul>
</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul>
<li>Nothing </li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd><ul>
<li>None </li></ul>
</dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ce9ee801e66ff3eaa679d7e6fe93768b"></a><!-- doxytag: member="queue.c::deq" ref="ce9ee801e66ff3eaa679d7e6fe93768b" args="(queuep queue, void *item, unsigned short key)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void deq </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">queuep&nbsp;</td>
<td class="mdname" nowrap> <em>queue</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>void *&nbsp;</td>
<td class="mdname" nowrap> <em>item</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned short&nbsp;</td>
<td class="mdname" nowrap> <em>key</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Dequeue the process from the Queue, based on the schemes. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>queue</em>&nbsp;</td><td>is the queue of items.<ul>
<li>item is buffer where queue element is returned. If queue is empty then NULL is returned.</li><li>key for removing from the Queue. </li></ul>
</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul>
<li>Queue element is returned in item.</li><li>Null is assigned to item if Error. </li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd><ul>
<li>No error is flagged on queue being empty </li></ul>
</dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="5fa90abb1bad7df3e16b729eec043f22"></a><!-- doxytag: member="queue.c::enq" ref="5fa90abb1bad7df3e16b729eec043f22" args="(queuep queue, const void *item, unsigned short key)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void enq </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">queuep&nbsp;</td>
<td class="mdname" nowrap> <em>queue</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const void *&nbsp;</td>
<td class="mdname" nowrap> <em>item</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned short&nbsp;</td>
<td class="mdname" nowrap> <em>key</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
enqueue the item in the Queue. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>queue</em>&nbsp;</td><td>is the queue of items.<ul>
<li>item is the queue element.</li><li>key for insertion into the Queue. Can be priority. </li></ul>
</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul>
<li>Nothing </li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd><ul>
<li>key is not used currently</li><li>No error is flagged if queue is full </li></ul>
</dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="1546951af92d518a34fc15e66c715276"></a><!-- doxytag: member="queue.c::pdelq" ref="1546951af92d518a34fc15e66c715276" args="(queuep queue, pid_t item)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int pdelq </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">queuep&nbsp;</td>
<td class="mdname" nowrap> <em>queue</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>pid_t&nbsp;</td>
<td class="mdname" nowrap> <em>item</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Delete a pid from the Queue. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>queue</em>&nbsp;</td><td>is the queue of items.<ul>
<li>item is the element to delete. If queue is empty then -1 is returned. </li></ul>
</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul>
<li>Return 0 on success and -1 on errors </li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd><ul>
<li>Since the Queue implementation is array, this operation is very expensive as other entries needs to be copied. </li></ul>
</dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ce7781e7b0b3c5722df849ed9e8bca38"></a><!-- doxytag: member="queue.c::pdeq" ref="ce7781e7b0b3c5722df849ed9e8bca38" args="(queuep queue, pid_t *item, unsigned short key)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void pdeq </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">queuep&nbsp;</td>
<td class="mdname" nowrap> <em>queue</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>pid_t *&nbsp;</td>
<td class="mdname" nowrap> <em>item</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned short&nbsp;</td>
<td class="mdname" nowrap> <em>key</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Dequeue the process from the Queue, based on the schemes. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>queue</em>&nbsp;</td><td>is the queue of items.<ul>
<li>item is buffer where queue element is returned. If queue is empty then 255 is returned.</li><li>key for removing from the Queue. </li></ul>
</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul>
<li>Queue element is returned in item.</li><li>255 (-1) is assigned to item if Error. </li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd><ul>
<li>No error is flagged if queue is empty </li></ul>
</dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="bc81bd01154705330c045710b82564c2"></a><!-- doxytag: member="queue.c::penq" ref="bc81bd01154705330c045710b82564c2" args="(queuep queue, pid_t item, unsigned short key)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void penq </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">queuep&nbsp;</td>
<td class="mdname" nowrap> <em>queue</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>pid_t&nbsp;</td>
<td class="mdname" nowrap> <em>item</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned short&nbsp;</td>
<td class="mdname" nowrap> <em>key</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Enqueue a process id in the Queue. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>queue</em>&nbsp;</td><td>is the queue of items.<ul>
<li>item is the queue element.</li><li>key for insertion into the Queue. Can be priority. </li></ul>
</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul>
<li>Nothing </li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd><ul>
<li>key is not used currently</li><li>No error is flagged if queue is full. </li></ul>
</dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="e35dbad0448ab82405210a1a1c968bcc"></a><!-- doxytag: member="queue.c::prio_pdeq" ref="e35dbad0448ab82405210a1a1c968bcc" args="(queuep queue, pid_t *item, unsigned short key)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void prio_pdeq </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">queuep&nbsp;</td>
<td class="mdname" nowrap> <em>queue</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>pid_t *&nbsp;</td>
<td class="mdname" nowrap> <em>item</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned short&nbsp;</td>
<td class="mdname" nowrap> <em>key</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Dequeue the highest priority process from the Queue. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>queue</em>&nbsp;</td><td>is the queue of items.<ul>
<li>item is buffer where queue element is returned. If queue is empty then 255 is returned.</li><li>Key for removing from the Queue (priority) </li></ul>
</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul>
<li>Queue element is returned in item.</li><li>255 (-1) is assigned to item if Error. </li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd><ul>
<li>Uses queue array structure as a binary heap for implementing priority queue. 0 is highest priority</li><li>The priority key is not used currently. Instead the value is obtained from the ptable directly. </li></ul>
</dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a875e4560580d7aa00e79c22bc1a283d"></a><!-- doxytag: member="queue.c::prio_penq" ref="a875e4560580d7aa00e79c22bc1a283d" args="(queuep queue, pid_t item, unsigned short key)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void prio_penq </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">queuep&nbsp;</td>
<td class="mdname" nowrap> <em>queue</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>pid_t&nbsp;</td>
<td class="mdname" nowrap> <em>item</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned short&nbsp;</td>
<td class="mdname" nowrap> <em>key</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Enqueue a process in the Priority Queue. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>queue</em>&nbsp;</td><td>is the queue of items.<ul>
<li>item is the queue element.</li><li>Key for insertion (priority). </li></ul>
</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul>
<li>Nothing </li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd><ul>
<li>No error is flagged if queue is full.</li><li>Uses queue array structure as a binary heap for implementing priority queue. 0 is highest priority</li><li>The priority key is not used. Instead the value is obtained directly from the ptable. </li></ul>
</dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="447a05eef6ae6ae28bd864e441f245d9"></a><!-- doxytag: member="queue.c::qinit" ref="447a05eef6ae6ae28bd864e441f245d9" args="(queuep queue)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void qinit </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">queuep&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>queue</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Intialize the Queue. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>queue</em>&nbsp;</td><td>is the queue of items. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><ul>
<li>Nothing </li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd><ul>
<li>None </li></ul>
</dd></dl>
</td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Thu Feb 13 14:46:24 2014 for 2014.1_doc by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.5 </small></address>
</body>
</html>