<!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::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.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_decoder_base.html">DecoderBase</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-types">Protected Types</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">Atlas::Message::DecoderBase Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Atlas::Message::DecoderBase" --><!-- doxytag: inherits="Atlas::Bridge" -->
<p>Base class for decoders that take Atlas::Message::Object.
<a href="class_atlas_1_1_message_1_1_decoder_base.html#details">More...</a></p>
<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="dyncontent">
<div class="center">
<img src="class_atlas_1_1_message_1_1_decoder_base.png" usemap="#Atlas::Message::DecoderBase_map" alt=""/>
<map id="Atlas::Message::DecoderBase_map" name="Atlas::Message::DecoderBase_map">
<area href="class_atlas_1_1_bridge.html" title="Atlas stream bridge." alt="Atlas::Bridge" shape="rect" coords="103,0,300,24"/>
<area href="class_atlas_1_1_message_1_1_queued_decoder.html" title="Decoder that presents a queue of Atlas::Message::Element." alt="Atlas::Message::QueuedDecoder" shape="rect" coords="0,112,197,136"/>
<area href="class_atlas_1_1_objects_1_1_objects_decoder.html" title="Objects hierarchy decoder." alt="Atlas::Objects::ObjectsDecoder" shape="rect" coords="207,112,404,136"/>
<area href="class_atlas_1_1_objects_1_1_dispatcher.html" title="Objects hierarchy dispatcher." alt="Atlas::Objects::Dispatcher" shape="rect" coords="207,168,404,192"/>
</map>
</div></div>
<p><a href="class_atlas_1_1_message_1_1_decoder_base-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="af1d7f241afe867d3412f0141b63904f2"></a><!-- doxytag: member="Atlas::Message::DecoderBase::streamBegin" ref="af1d7f241afe867d3412f0141b63904f2" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#af1d7f241afe867d3412f0141b63904f2">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" align="right" valign="top"><a class="anchor" id="a71d2993e472cb449a0237f263d49e9ef"></a><!-- doxytag: member="Atlas::Message::DecoderBase::streamMessage" ref="a71d2993e472cb449a0237f263d49e9ef" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#a71d2993e472cb449a0237f263d49e9ef">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" align="right" valign="top"><a class="anchor" id="a5a5f94b58ac18e7c263267199feb7171"></a><!-- doxytag: member="Atlas::Message::DecoderBase::streamEnd" ref="a5a5f94b58ac18e7c263267199feb7171" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#a5a5f94b58ac18e7c263267199feb7171">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" align="right" valign="top"><a class="anchor" id="acd83c2781d460c7706a92775b719cd43"></a><!-- doxytag: member="Atlas::Message::DecoderBase::mapMapItem" ref="acd83c2781d460c7706a92775b719cd43" 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#acd83c2781d460c7706a92775b719cd43">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" align="right" valign="top"><a class="anchor" id="a563efa0e01da70e0d5f77b0318daae9f"></a><!-- doxytag: member="Atlas::Message::DecoderBase::mapListItem" ref="a563efa0e01da70e0d5f77b0318daae9f" 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#a563efa0e01da70e0d5f77b0318daae9f">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" align="right" valign="top"><a class="anchor" id="a13e9d0c5a134fc66140619f2cbec51fd"></a><!-- doxytag: member="Atlas::Message::DecoderBase::mapIntItem" ref="a13e9d0c5a134fc66140619f2cbec51fd" 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#a13e9d0c5a134fc66140619f2cbec51fd">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" align="right" valign="top"><a class="anchor" id="a0376a076852ab8ef00a8e015d66f5a40"></a><!-- doxytag: member="Atlas::Message::DecoderBase::mapFloatItem" ref="a0376a076852ab8ef00a8e015d66f5a40" 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#a0376a076852ab8ef00a8e015d66f5a40">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" align="right" valign="top"><a class="anchor" id="a0471141e9e1508168021d8b7b10af0ee"></a><!-- doxytag: member="Atlas::Message::DecoderBase::mapStringItem" ref="a0471141e9e1508168021d8b7b10af0ee" 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#a0471141e9e1508168021d8b7b10af0ee">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" align="right" valign="top"><a class="anchor" id="a4c9748fabb19f4a30088c731c3769b88"></a><!-- doxytag: member="Atlas::Message::DecoderBase::mapEnd" ref="a4c9748fabb19f4a30088c731c3769b88" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#a4c9748fabb19f4a30088c731c3769b88">mapEnd</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ends the currently streamed map. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a659d65eae17f402f47cab0f6fbe12494"></a><!-- doxytag: member="Atlas::Message::DecoderBase::listMapItem" ref="a659d65eae17f402f47cab0f6fbe12494" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#a659d65eae17f402f47cab0f6fbe12494">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" align="right" valign="top"><a class="anchor" id="a504425697f1e292251c6388665083493"></a><!-- doxytag: member="Atlas::Message::DecoderBase::listListItem" ref="a504425697f1e292251c6388665083493" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#a504425697f1e292251c6388665083493">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" align="right" valign="top"><a class="anchor" id="aa088de0dab0af7abc3f202590a6770da"></a><!-- doxytag: member="Atlas::Message::DecoderBase::listIntItem" ref="aa088de0dab0af7abc3f202590a6770da" args="(long)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#aa088de0dab0af7abc3f202590a6770da">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" align="right" valign="top"><a class="anchor" id="ac03684da91d91f4a2698af75701f9df1"></a><!-- doxytag: member="Atlas::Message::DecoderBase::listFloatItem" ref="ac03684da91d91f4a2698af75701f9df1" args="(double)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#ac03684da91d91f4a2698af75701f9df1">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" align="right" valign="top"><a class="anchor" id="a9b1030476ae7e1088d1201bdcc0db0cb"></a><!-- doxytag: member="Atlas::Message::DecoderBase::listStringItem" ref="a9b1030476ae7e1088d1201bdcc0db0cb" 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#a9b1030476ae7e1088d1201bdcc0db0cb">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" align="right" valign="top"><a class="anchor" id="adfc757c364b1562a0a650c1051869f29"></a><!-- doxytag: member="Atlas::Message::DecoderBase::listEnd" ref="adfc757c364b1562a0a650c1051869f29" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#adfc757c364b1562a0a650c1051869f29">listEnd</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ends the currently streamed list. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-types"></a>
Protected Types</h2></td></tr>
<tr><td class="memItemLeft" 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#a3c05ee539ce0b3c26818115d4b3bebcb">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"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf02eaea95eb140be685d3d228727de1"></a><!-- doxytag: member="Atlas::Message::DecoderBase::messageArrived" ref="adf02eaea95eb140be685d3d228727de1" 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#adf02eaea95eb140be685d3d228727de1">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"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9641490ce4411d8ec1f9ef7f78fc77c2"></a><!-- doxytag: member="Atlas::Message::DecoderBase::m_state" ref="a9641490ce4411d8ec1f9ef7f78fc77c2" args="" -->
std::stack< <a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#a3c05ee539ce0b3c26818115d4b3bebcb">State</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#a9641490ce4411d8ec1f9ef7f78fc77c2">m_state</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The state stack. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="affb57a15fce40de3bcccc999398347c1"></a><!-- doxytag: member="Atlas::Message::DecoderBase::m_maps" ref="affb57a15fce40de3bcccc999398347c1" args="" -->
std::stack< MapType > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#affb57a15fce40de3bcccc999398347c1">m_maps</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The map stack. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8a08e85c2a4cce503aafbd1590249adf"></a><!-- doxytag: member="Atlas::Message::DecoderBase::m_lists" ref="a8a08e85c2a4cce503aafbd1590249adf" args="" -->
std::stack< ListType > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_message_1_1_decoder_base.html#a8a08e85c2a4cce503aafbd1590249adf">m_lists</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The list stack. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a655670d438beceb34bbaa0042fa81947"></a><!-- doxytag: member="Atlas::Message::DecoderBase::m_names" ref="a655670d438beceb34bbaa0042fa81947" 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#a655670d438beceb34bbaa0042fa81947">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" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base class for decoders that take Atlas::Message::Object. </p>
<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#adf02eaea95eb140be685d3d228727de1" 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"><dt><b>See also:</b></dt><dd><a class="el" href="class_atlas_1_1_bridge.html" title="Atlas stream bridge.">Atlas::Bridge</a> </dd>
<dd>
<a class="el" href="class_atlas_1_1_codec.html" title="Atlas stream codec.">Atlas::Codec</a> </dd>
<dd>
Object </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="_decoder_base_8h_source.html">DecoderBase.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>
