<!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>Atlas-C++: Atlas::Message::QueuedDecoder 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.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Atlas-C++</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_atlas.html">Atlas</a> </li>
<li class="navelem"><b>Message</b> </li>
<li class="navelem"><a class="el" href="class_atlas_1_1_message_1_1_queued_decoder.html">QueuedDecoder</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">Atlas::Message::QueuedDecoder Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Atlas::Message::QueuedDecoder" --><!-- doxytag: inherits="Atlas::Message::DecoderBase" -->
<p>Decoder that presents a queue of <a class="el" href="class_atlas_1_1_message_1_1_element.html" title="Multi-type container.">Atlas::Message::Element</a>.
<a href="class_atlas_1_1_message_1_1_queued_decoder.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_queued_decoder_8h_source.html">QueuedDecoder.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Atlas::Message::QueuedDecoder:</div>
<div class="dyncontent">
<div class="center">
<img src="class_atlas_1_1_message_1_1_queued_decoder.png" usemap="#Atlas::Message::QueuedDecoder_map" alt=""/>
<map id="Atlas::Message::QueuedDecoder_map" name="Atlas::Message::QueuedDecoder_map">
<area href="class_atlas_1_1_message_1_1_decoder_base.html" title="Base class for decoders that take Atlas::Message::Object." alt="Atlas::Message::DecoderBase" shape="rect" coords="0,56,197,80"/>
<area href="class_atlas_1_1_bridge.html" title="Atlas stream bridge." alt="Atlas::Bridge" shape="rect" coords="0,0,197,24"/>
</map>
</div></div>
<p><a href="class_atlas_1_1_message_1_1_queued_decoder-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa186b748c8354f352f0a4f2e5e183730"></a><!-- doxytag: member="Atlas::Message::QueuedDecoder::queueSize" ref="aa186b748c8354f352f0a4f2e5e183730" args="()" -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_queued_decoder.html#aa186b748c8354f352f0a4f2e5e183730">queueSize</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the current size of the message queue. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a69a25e892d37ac2b1d54df5897fc73c5"></a><!-- doxytag: member="Atlas::Message::QueuedDecoder::popMessage" ref="a69a25e892d37ac2b1d54df5897fc73c5" args="()" -->
const MapType </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_queued_decoder.html#a69a25e892d37ac2b1d54df5897fc73c5">popMessage</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pop an object from the front of the message queue. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ea51b410b4c70cccbcc3485a4050889"></a><!-- doxytag: member="Atlas::Message::QueuedDecoder::frontMessage" ref="a4ea51b410b4c70cccbcc3485a4050889" args="()" -->
const MapType </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_queued_decoder.html#a4ea51b410b4c70cccbcc3485a4050889">frontMessage</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Peek at the object at the front of the queue. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6f0f82ddb6aaa8cd3e18e709f8a8e48"></a><!-- doxytag: member="Atlas::Message::QueuedDecoder::clearQueue" ref="ab6f0f82ddb6aaa8cd3e18e709f8a8e48" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_queued_decoder.html#ab6f0f82ddb6aaa8cd3e18e709f8a8e48">clearQueue</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear the message queue. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abac6b4693dfd60303a870fdf4aab2430"></a><!-- doxytag: member="Atlas::Message::QueuedDecoder::messageArrived" ref="abac6b4693dfd60303a870fdf4aab2430" args="(const MapType &obj)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_queued_decoder.html#abac6b4693dfd60303a870fdf4aab2430">messageArrived</a> (const MapType &obj)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This adds a message to the queue. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Decoder that presents a queue of <a class="el" href="class_atlas_1_1_message_1_1_element.html" title="Multi-type container.">Atlas::Message::Element</a>. </p>
<p>This message decoder puts arrived objects into a queue and allows the application to pop them off the front of the queue, peek at the front of the queue, as well as checking to see how many objects are currently in the queue.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html" title="Base class for decoders that take Atlas::Message::Object.">DecoderBase</a> </dd>
<dd>
<a class="el" href="class_atlas_1_1_message_1_1_element.html" title="Multi-type container.">Element</a> </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Stefanus Du Toit <<a href="mailto:sdt@gmx.net">sdt@gmx.net</a>> </dd></dl>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_queued_decoder_8h_source.html">QueuedDecoder.h</a></li>
</ul>
</div>
<HR>
<P>Copyright 2000-2004 the respective authors.</P>
<P>This document can be licensed under the terms of the GNU Free Documentation
License or the GNU General Public License and may be freely distributed under
the terms given by one of these licenses.</P>
