<!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::EncoderBase 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"><a class="el" href="class_atlas_1_1_encoder_base.html">EncoderBase</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">Atlas::EncoderBase Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Atlas::EncoderBase" -->
<p>Base class forwarding to <a class="el" href="class_atlas_1_1_bridge.html" title="Atlas stream bridge.">Atlas::Bridge</a> as skeleton for other encoders.
<a href="class_atlas_1_1_encoder_base.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_encoder_base_8h_source.html">EncoderBase.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Atlas::EncoderBase:</div>
<div class="dyncontent">
<div class="center">
<img src="class_atlas_1_1_encoder_base.png" usemap="#Atlas::EncoderBase_map" alt=""/>
<map id="Atlas::EncoderBase_map" name="Atlas::EncoderBase_map">
<area href="class_atlas_1_1_message_1_1_encoder.html" title="Encoder that transmits Atlas::Message::Element." alt="Atlas::Message::Encoder" shape="rect" coords="0,56,186,80"/>
<area href="class_atlas_1_1_objects_1_1_objects_encoder.html" title="Objects hierarchy encoder." alt="Atlas::Objects::ObjectsEncoder" shape="rect" coords="196,56,382,80"/>
</map>
</div></div>
<p><a href="class_atlas_1_1_encoder_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="aea32c2f7158237d283f6513b2a31c736"></a><!-- doxytag: member="Atlas::EncoderBase::EncoderBase" ref="aea32c2f7158237d283f6513b2a31c736" args="(Atlas::Bridge &b)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_encoder_base.html#aea32c2f7158237d283f6513b2a31c736">EncoderBase</a> (<a class="el" href="class_atlas_1_1_bridge.html">Atlas::Bridge</a> &b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">You will need to implement this in subclasses. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad83f867ab4f72f86c11422daad5befe5"></a><!-- doxytag: member="Atlas::EncoderBase::streamBegin" ref="ad83f867ab4f72f86c11422daad5befe5" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>streamBegin</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a97d631747bd90a5cc779ec1565ffe31a"></a><!-- doxytag: member="Atlas::EncoderBase::streamMessage" ref="a97d631747bd90a5cc779ec1565ffe31a" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>streamMessage</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0354bdb7273d23c8b4bcbc5e4a0ad4ae"></a><!-- doxytag: member="Atlas::EncoderBase::streamEnd" ref="a0354bdb7273d23c8b4bcbc5e4a0ad4ae" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>streamEnd</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a728c1dd9ee3e2735a20cdd7c55cb34"></a><!-- doxytag: member="Atlas::EncoderBase::mapMapItem" ref="a7a728c1dd9ee3e2735a20cdd7c55cb34" args="(const std::string &name)" -->
void </td><td class="memItemRight" valign="bottom"><b>mapMapItem</b> (const std::string &name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af671a7a49db049dec4a7da7add656450"></a><!-- doxytag: member="Atlas::EncoderBase::mapListItem" ref="af671a7a49db049dec4a7da7add656450" args="(const std::string &name)" -->
void </td><td class="memItemRight" valign="bottom"><b>mapListItem</b> (const std::string &name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5635be6e35e7554b0bede11589775499"></a><!-- doxytag: member="Atlas::EncoderBase::mapIntItem" ref="a5635be6e35e7554b0bede11589775499" args="(const std::string &name, long i)" -->
void </td><td class="memItemRight" valign="bottom"><b>mapIntItem</b> (const std::string &name, long i)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1997964699d508107908dd0ef4e33b2d"></a><!-- doxytag: member="Atlas::EncoderBase::mapFloatItem" ref="a1997964699d508107908dd0ef4e33b2d" args="(const std::string &name, double d)" -->
void </td><td class="memItemRight" valign="bottom"><b>mapFloatItem</b> (const std::string &name, double d)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add19aade46f8260d8455bb5dd8b1650b"></a><!-- doxytag: member="Atlas::EncoderBase::mapStringItem" ref="add19aade46f8260d8455bb5dd8b1650b" args="(const std::string &name, const std::string &s)" -->
void </td><td class="memItemRight" valign="bottom"><b>mapStringItem</b> (const std::string &name, const std::string &s)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae00441d594c3c5ced0e25b0a2a294f70"></a><!-- doxytag: member="Atlas::EncoderBase::mapEnd" ref="ae00441d594c3c5ced0e25b0a2a294f70" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>mapEnd</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a00ac517d78aeebb086f89df199521858"></a><!-- doxytag: member="Atlas::EncoderBase::listMapItem" ref="a00ac517d78aeebb086f89df199521858" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>listMapItem</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef252e1690300adc0c207cea74caf80f"></a><!-- doxytag: member="Atlas::EncoderBase::listListItem" ref="aef252e1690300adc0c207cea74caf80f" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>listListItem</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae8f6f01490caf4a7391b6cc4adca5cf4"></a><!-- doxytag: member="Atlas::EncoderBase::listIntItem" ref="ae8f6f01490caf4a7391b6cc4adca5cf4" args="(long i)" -->
void </td><td class="memItemRight" valign="bottom"><b>listIntItem</b> (long i)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a501f9f61a5062d04c954bfe90ee1446e"></a><!-- doxytag: member="Atlas::EncoderBase::listFloatItem" ref="a501f9f61a5062d04c954bfe90ee1446e" args="(double d)" -->
void </td><td class="memItemRight" valign="bottom"><b>listFloatItem</b> (double d)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae4fa754893d3ba791326210d3908d335"></a><!-- doxytag: member="Atlas::EncoderBase::listStringItem" ref="ae4fa754893d3ba791326210d3908d335" args="(const std::string &s)" -->
void </td><td class="memItemRight" valign="bottom"><b>listStringItem</b> (const std::string &s)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75f6515c045004e36815519ecd812664"></a><!-- doxytag: member="Atlas::EncoderBase::listEnd" ref="a75f6515c045004e36815519ecd812664" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>listEnd</b> ()</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="a88aa918c922b5ffaf114c266445c5f9a"></a><!-- doxytag: member="Atlas::EncoderBase::m_b" ref="a88aa918c922b5ffaf114c266445c5f9a" args="" -->
<a class="el" href="class_atlas_1_1_bridge.html">Atlas::Bridge</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_encoder_base.html#a88aa918c922b5ffaf114c266445c5f9a">m_b</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The bridge that requests are forwarded to. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base class forwarding to <a class="el" href="class_atlas_1_1_bridge.html" title="Atlas stream bridge.">Atlas::Bridge</a> as skeleton for other encoders. </p>
<p>This class is useful when building your own encoders that work on top of <a class="el" href="class_atlas_1_1_bridge.html" title="Atlas stream bridge.">Bridge</a> (hence taking one as an argument).</p>
<p>It forwards all requests to a protected <a class="el" href="class_atlas_1_1_bridge.html" title="Atlas stream bridge.">Bridge</a> b, hence you can inherit from it and your encoder can be used as a <a class="el" href="class_atlas_1_1_bridge.html" title="Atlas stream bridge.">Bridge</a> (for instance, as argument to another encoder) without you needing to implement all these forwarding requests.</p>
<p>Of course your encoder does not have to inherit from <a class="el" href="class_atlas_1_1_encoder_base.html" title="Base class forwarding to Atlas::Bridge as skeleton for other encoders.">EncoderBase</a> - you could offer a completely different interface from that of bridge.</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.">Bridge</a> </dd></dl>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_encoder_base_8h_source.html">EncoderBase.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>
