<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Atlas-C++: Atlas::Message::DecoderBase 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.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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 class="tabs">
<ul>
<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 class="navpath"><a class="el" href="namespace_atlas.html">Atlas</a>::<b>Message</b>::<a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html">DecoderBase</a>
</div>
</div>
<div class="contents">
<h1>Atlas::Message::DecoderBase Class Reference</h1><!-- doxytag: class="Atlas::Message::DecoderBase" --><!-- doxytag: inherits="Atlas::Bridge" -->Base class for decoders that take Atlas::Message::Object.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="_decoder_base_8h_source.html">DecoderBase.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for Atlas::Message::DecoderBase:</div>
<div class="dynsection">
<p><center><img src="class_atlas_1_1_message_1_1_decoder_base.png" usemap="#Atlas::Message::DecoderBase_map" border="0" alt=""></center>
<map name="Atlas::Message::DecoderBase_map">
<area href="class_atlas_1_1_bridge.html" alt="Atlas::Bridge" shape="rect" coords="103,0,300,24">
<area href="class_atlas_1_1_message_1_1_queued_decoder.html" alt="Atlas::Message::QueuedDecoder" shape="rect" coords="0,112,197,136">
<area href="class_atlas_1_1_objects_1_1_objects_decoder.html" alt="Atlas::Objects::ObjectsDecoder" shape="rect" coords="207,112,404,136">
<area href="class_atlas_1_1_objects_1_1_dispatcher.html" alt="Atlas::Objects::Dispatcher" shape="rect" coords="207,168,404,192">
</map>
</div>
<p>
<a href="class_atlas_1_1_message_1_1_decoder_base-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f1d7f241afe867d3412f0141b63904f2"></a><!-- doxytag: member="Atlas::Message::DecoderBase::streamBegin" ref="f1d7f241afe867d3412f0141b63904f2" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#f1d7f241afe867d3412f0141b63904f2">streamBegin</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Begin an <a class="el" href="namespace_atlas.html" title="The Atlas namespace.">Atlas</a> stream. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="71d2993e472cb449a0237f263d49e9ef"></a><!-- doxytag: member="Atlas::Message::DecoderBase::streamMessage" ref="71d2993e472cb449a0237f263d49e9ef" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#71d2993e472cb449a0237f263d49e9ef">streamMessage</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a message in an <a class="el" href="namespace_atlas.html" title="The Atlas namespace.">Atlas</a> stream. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5a5f94b58ac18e7c263267199feb7171"></a><!-- doxytag: member="Atlas::Message::DecoderBase::streamEnd" ref="5a5f94b58ac18e7c263267199feb7171" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#5a5f94b58ac18e7c263267199feb7171">streamEnd</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ends the <a class="el" href="namespace_atlas.html" title="The Atlas namespace.">Atlas</a> stream. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cd83c2781d460c7706a92775b719cd43"></a><!-- doxytag: member="Atlas::Message::DecoderBase::mapMapItem" ref="cd83c2781d460c7706a92775b719cd43" args="(const std::string &name)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#cd83c2781d460c7706a92775b719cd43">mapMapItem</a> (const std::string &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts a map object to the currently streamed map. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="563efa0e01da70e0d5f77b0318daae9f"></a><!-- doxytag: member="Atlas::Message::DecoderBase::mapListItem" ref="563efa0e01da70e0d5f77b0318daae9f" args="(const std::string &name)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#563efa0e01da70e0d5f77b0318daae9f">mapListItem</a> (const std::string &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts a list object to the currently streamed map. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="13e9d0c5a134fc66140619f2cbec51fd"></a><!-- doxytag: member="Atlas::Message::DecoderBase::mapIntItem" ref="13e9d0c5a134fc66140619f2cbec51fd" args="(const std::string &name, long)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#13e9d0c5a134fc66140619f2cbec51fd">mapIntItem</a> (const std::string &name, long)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an integer to the currently streames map. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0376a076852ab8ef00a8e015d66f5a40"></a><!-- doxytag: member="Atlas::Message::DecoderBase::mapFloatItem" ref="0376a076852ab8ef00a8e015d66f5a40" args="(const std::string &name, double)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#0376a076852ab8ef00a8e015d66f5a40">mapFloatItem</a> (const std::string &name, double)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a float to the currently streamed map. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0471141e9e1508168021d8b7b10af0ee"></a><!-- doxytag: member="Atlas::Message::DecoderBase::mapStringItem" ref="0471141e9e1508168021d8b7b10af0ee" args="(const std::string &name, const std::string &)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#0471141e9e1508168021d8b7b10af0ee">mapStringItem</a> (const std::string &name, const std::string &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a string to the currently streamed map. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4c9748fabb19f4a30088c731c3769b88"></a><!-- doxytag: member="Atlas::Message::DecoderBase::mapEnd" ref="4c9748fabb19f4a30088c731c3769b88" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#4c9748fabb19f4a30088c731c3769b88">mapEnd</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ends the currently streamed map. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="659d65eae17f402f47cab0f6fbe12494"></a><!-- doxytag: member="Atlas::Message::DecoderBase::listMapItem" ref="659d65eae17f402f47cab0f6fbe12494" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#659d65eae17f402f47cab0f6fbe12494">listMapItem</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts a map object in the currently streamed list. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="504425697f1e292251c6388665083493"></a><!-- doxytag: member="Atlas::Message::DecoderBase::listListItem" ref="504425697f1e292251c6388665083493" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#504425697f1e292251c6388665083493">listListItem</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts a list object in the currently streamed list. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a088de0dab0af7abc3f202590a6770da"></a><!-- doxytag: member="Atlas::Message::DecoderBase::listIntItem" ref="a088de0dab0af7abc3f202590a6770da" args="(long)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#a088de0dab0af7abc3f202590a6770da">listIntItem</a> (long)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds an integer to the currently streames list. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c03684da91d91f4a2698af75701f9df1"></a><!-- doxytag: member="Atlas::Message::DecoderBase::listFloatItem" ref="c03684da91d91f4a2698af75701f9df1" args="(double)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#c03684da91d91f4a2698af75701f9df1">listFloatItem</a> (double)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a float to the currently streamed list. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9b1030476ae7e1088d1201bdcc0db0cb"></a><!-- doxytag: member="Atlas::Message::DecoderBase::listStringItem" ref="9b1030476ae7e1088d1201bdcc0db0cb" args="(const std::string &)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#9b1030476ae7e1088d1201bdcc0db0cb">listStringItem</a> (const std::string &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a string to the currently streamed list. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dfc757c364b1562a0a650c1051869f29"></a><!-- doxytag: member="Atlas::Message::DecoderBase::listEnd" ref="dfc757c364b1562a0a650c1051869f29" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#dfc757c364b1562a0a650c1051869f29">listEnd</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ends the currently streamed list. <br></td></tr>
<tr><td colspan="2"><br><h2>Protected Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#3c05ee539ce0b3c26818115d4b3bebcb">State</a> { <b>STATE_STREAM</b>,
<b>STATE_MAP</b>,
<b>STATE_LIST</b>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Our current decoding state. <br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="df02eaea95eb140be685d3d228727de1"></a><!-- doxytag: member="Atlas::Message::DecoderBase::messageArrived" ref="df02eaea95eb140be685d3d228727de1" args="(const MapType &obj)=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#df02eaea95eb140be685d3d228727de1">messageArrived</a> (const MapType &obj)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Override this - called when an object was received. <br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9641490ce4411d8ec1f9ef7f78fc77c2"></a><!-- doxytag: member="Atlas::Message::DecoderBase::m_state" ref="9641490ce4411d8ec1f9ef7f78fc77c2" args="" -->
std::stack< <a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#3c05ee539ce0b3c26818115d4b3bebcb">State</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#9641490ce4411d8ec1f9ef7f78fc77c2">m_state</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The state stack. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ffb57a15fce40de3bcccc999398347c1"></a><!-- doxytag: member="Atlas::Message::DecoderBase::m_maps" ref="ffb57a15fce40de3bcccc999398347c1" args="" -->
std::stack< MapType > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#ffb57a15fce40de3bcccc999398347c1">m_maps</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The map stack. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8a08e85c2a4cce503aafbd1590249adf"></a><!-- doxytag: member="Atlas::Message::DecoderBase::m_lists" ref="8a08e85c2a4cce503aafbd1590249adf" args="" -->
std::stack< ListType > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#8a08e85c2a4cce503aafbd1590249adf">m_lists</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The list stack. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="655670d438beceb34bbaa0042fa81947"></a><!-- doxytag: member="Atlas::Message::DecoderBase::m_names" ref="655670d438beceb34bbaa0042fa81947" args="" -->
std::stack< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#655670d438beceb34bbaa0042fa81947">m_names</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Names for maps and lists. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Base class for decoders that take Atlas::Message::Object.
<p>
This class is passed to a codec as receiver bridge. It decodes a stream into Message::Object objects, and after completion calls the abstract <a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#df02eaea95eb140be685d3d228727de1" title="Override this - called when an object was received.">messageArrived()</a> method. This is to be overridden by base classes, which might, for instance, provide an object queue or a callback method for arrived messages.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="class_atlas_1_1_bridge.html" title="Atlas stream bridge.">Atlas::Bridge</a> <p>
<a class="el" href="class_atlas_1_1_codec.html" title="Atlas stream codec.">Atlas::Codec</a> <p>
Object </dd></dl>
<dl class="author" compact><dt><b>Author:</b></dt><dd>Stefanus Du Toit <<a href="mailto:sdt@gmx.net">sdt@gmx.net</a>> </dd></dl>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_decoder_base_8h_source.html">DecoderBase.h</a></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>
