Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 626e7b9df2c26f4a1ac4abc5819592a1 > files > 99

atlascpp-devel-0.6.2-1.fc15.i686.rpm

<!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::Bridge 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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;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_bridge.html">Bridge</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">Atlas::Bridge Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="Atlas::Bridge" -->
<p><a class="el" href="namespace_atlas.html" title="The Atlas namespace.">Atlas</a> stream bridge.  
 <a href="class_atlas_1_1_bridge.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_bridge_8h_source.html">Bridge.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Atlas::Bridge:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_atlas_1_1_bridge.png" usemap="#Atlas::Bridge_map" alt=""/>
  <map id="Atlas::Bridge_map" name="Atlas::Bridge_map">
<area href="class_atlas_1_1_codec.html" title="Atlas stream codec." alt="Atlas::Codec" shape="rect" coords="207,56,404,80"/>
<area href="class_atlas_1_1_formatter.html" title="Atlas stream formatter." alt="Atlas::Formatter" shape="rect" coords="414,56,611,80"/>
<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="724,56,921,80"/>
<area href="class_debug_bridge.html" alt="DebugBridge" shape="rect" coords="931,56,1128,80"/>
<area href="class_debug_bridge.html" alt="DebugBridge" shape="rect" coords="1138,56,1335,80"/>
<area href="class_atlas_1_1_codecs_1_1_bach.html" alt="Atlas::Codecs::Bach" shape="rect" coords="0,112,197,136"/>
<area href="class_atlas_1_1_codecs_1_1_packed.html" alt="Atlas::Codecs::Packed" shape="rect" coords="207,112,404,136"/>
<area href="class_atlas_1_1_codecs_1_1_x_m_l.html" alt="Atlas::Codecs::XML" shape="rect" coords="414,112,611,136"/>
<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="621,112,818,136"/>
<area href="class_atlas_1_1_objects_1_1_objects_decoder.html" title="Objects hierarchy decoder." alt="Atlas::Objects::ObjectsDecoder" shape="rect" coords="828,112,1025,136"/>
<area href="class_atlas_1_1_objects_1_1_dispatcher.html" title="Objects hierarchy dispatcher." alt="Atlas::Objects::Dispatcher" shape="rect" coords="828,168,1025,192"/>
</map>
 </div></div>

<p><a href="class_atlas_1_1_bridge-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="a9823fb38a7411ede964a953edc9c5603"></a><!-- doxytag: member="Atlas::Bridge::streamBegin" ref="a9823fb38a7411ede964a953edc9c5603" args="()=0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_bridge.html#a9823fb38a7411ede964a953edc9c5603">streamBegin</a> ()=0</td></tr>
<tr><td class="mdescLeft">&#160;</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="a2cc3d759306b4b8e95af66e20e80b191"></a><!-- doxytag: member="Atlas::Bridge::streamMessage" ref="a2cc3d759306b4b8e95af66e20e80b191" args="()=0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_bridge.html#a2cc3d759306b4b8e95af66e20e80b191">streamMessage</a> ()=0</td></tr>
<tr><td class="mdescLeft">&#160;</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="a78e2440ce7bbcec8a382f47b71c0a1c7"></a><!-- doxytag: member="Atlas::Bridge::streamEnd" ref="a78e2440ce7bbcec8a382f47b71c0a1c7" args="()=0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_bridge.html#a78e2440ce7bbcec8a382f47b71c0a1c7">streamEnd</a> ()=0</td></tr>
<tr><td class="mdescLeft">&#160;</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="a948e2db78952c71cd71caada16207258"></a><!-- doxytag: member="Atlas::Bridge::mapMapItem" ref="a948e2db78952c71cd71caada16207258" args="(const std::string &amp;name)=0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_bridge.html#a948e2db78952c71cd71caada16207258">mapMapItem</a> (const std::string &amp;name)=0</td></tr>
<tr><td class="mdescLeft">&#160;</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="ac09685b3883f892e33d9ff627b9ea0e3"></a><!-- doxytag: member="Atlas::Bridge::mapListItem" ref="ac09685b3883f892e33d9ff627b9ea0e3" args="(const std::string &amp;name)=0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_bridge.html#ac09685b3883f892e33d9ff627b9ea0e3">mapListItem</a> (const std::string &amp;name)=0</td></tr>
<tr><td class="mdescLeft">&#160;</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="a90d8aa77ab88b6773a37e9d5a664beb4"></a><!-- doxytag: member="Atlas::Bridge::mapIntItem" ref="a90d8aa77ab88b6773a37e9d5a664beb4" args="(const std::string &amp;name, long)=0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_bridge.html#a90d8aa77ab88b6773a37e9d5a664beb4">mapIntItem</a> (const std::string &amp;name, long)=0</td></tr>
<tr><td class="mdescLeft">&#160;</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="a642d98aeb82886b7101a76c041764613"></a><!-- doxytag: member="Atlas::Bridge::mapFloatItem" ref="a642d98aeb82886b7101a76c041764613" args="(const std::string &amp;name, double)=0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_bridge.html#a642d98aeb82886b7101a76c041764613">mapFloatItem</a> (const std::string &amp;name, double)=0</td></tr>
<tr><td class="mdescLeft">&#160;</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="a4b73868d34b31811ef34b1234711feb6"></a><!-- doxytag: member="Atlas::Bridge::mapStringItem" ref="a4b73868d34b31811ef34b1234711feb6" args="(const std::string &amp;name, const std::string &amp;)=0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_bridge.html#a4b73868d34b31811ef34b1234711feb6">mapStringItem</a> (const std::string &amp;name, const std::string &amp;)=0</td></tr>
<tr><td class="mdescLeft">&#160;</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="a21dc1620fe2fe13718fc71043fc8bc81"></a><!-- doxytag: member="Atlas::Bridge::mapEnd" ref="a21dc1620fe2fe13718fc71043fc8bc81" args="()=0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_bridge.html#a21dc1620fe2fe13718fc71043fc8bc81">mapEnd</a> ()=0</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Ends the currently streamed map. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a52521f434577cd0a046acc67f8047f4a"></a><!-- doxytag: member="Atlas::Bridge::listMapItem" ref="a52521f434577cd0a046acc67f8047f4a" args="()=0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_bridge.html#a52521f434577cd0a046acc67f8047f4a">listMapItem</a> ()=0</td></tr>
<tr><td class="mdescLeft">&#160;</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="a3de836e82b00fae448b5e9a9835b5bc8"></a><!-- doxytag: member="Atlas::Bridge::listListItem" ref="a3de836e82b00fae448b5e9a9835b5bc8" args="()=0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_bridge.html#a3de836e82b00fae448b5e9a9835b5bc8">listListItem</a> ()=0</td></tr>
<tr><td class="mdescLeft">&#160;</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="a5d87d79f312b9ba669d385737a29fb9d"></a><!-- doxytag: member="Atlas::Bridge::listIntItem" ref="a5d87d79f312b9ba669d385737a29fb9d" args="(long)=0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_bridge.html#a5d87d79f312b9ba669d385737a29fb9d">listIntItem</a> (long)=0</td></tr>
<tr><td class="mdescLeft">&#160;</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="aab8864fecdfc53b060982a1c24e974b1"></a><!-- doxytag: member="Atlas::Bridge::listFloatItem" ref="aab8864fecdfc53b060982a1c24e974b1" args="(double)=0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_bridge.html#aab8864fecdfc53b060982a1c24e974b1">listFloatItem</a> (double)=0</td></tr>
<tr><td class="mdescLeft">&#160;</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="a1b72e453ab8b1d5b48dfcd5ae061a235"></a><!-- doxytag: member="Atlas::Bridge::listStringItem" ref="a1b72e453ab8b1d5b48dfcd5ae061a235" args="(const std::string &amp;)=0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_bridge.html#a1b72e453ab8b1d5b48dfcd5ae061a235">listStringItem</a> (const std::string &amp;)=0</td></tr>
<tr><td class="mdescLeft">&#160;</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="a266970241439a2e9cd761040aa77726d"></a><!-- doxytag: member="Atlas::Bridge::listEnd" ref="a266970241439a2e9cd761040aa77726d" args="()=0" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_bridge.html#a266970241439a2e9cd761040aa77726d">listEnd</a> ()=0</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Ends the currently streamed list. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="namespace_atlas.html" title="The Atlas namespace.">Atlas</a> stream bridge. </p>
<p>This class presents an interface that accepts an <a class="el" href="namespace_atlas.html" title="The Atlas namespace.">Atlas</a> stream. The stream begins with a call to <a class="el" href="class_atlas_1_1_bridge.html#a9823fb38a7411ede964a953edc9c5603" title="Begin an Atlas stream.">streamBegin()</a> and finishes with <a class="el" href="class_atlas_1_1_bridge.html#a78e2440ce7bbcec8a382f47b71c0a1c7" title="Ends the Atlas stream.">streamEnd()</a>. While the <a class="el" href="class_atlas_1_1_bridge.html" title="Atlas stream bridge.">Bridge</a> is in this stream context, a message can be sent using <a class="el" href="class_atlas_1_1_bridge.html#a2cc3d759306b4b8e95af66e20e80b191" title="Start a message in an Atlas stream.">streamMessage()</a>. This puts the <a class="el" href="class_atlas_1_1_bridge.html" title="Atlas stream bridge.">Bridge</a> into a map context, allowing various map*Item() calls.</p>
<p>Several classes are derived from <a class="el" href="class_atlas_1_1_bridge.html" title="Atlas stream bridge.">Bridge</a>, the most notable of which is <a class="el" href="class_atlas_1_1_codec.html" title="Atlas stream codec.">Codec</a>, which accepts an <a class="el" href="namespace_atlas.html" title="The Atlas namespace.">Atlas</a> stream for encoding and transmission.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_atlas_1_1_codec.html" title="Atlas stream codec.">Codec</a> </dd></dl>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_bridge_8h_source.html">Bridge.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>