Sophie

Sophie

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

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::Objects::ObjectsEncoder 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="namespace_atlas_1_1_objects.html">Objects</a>      </li>
      <li class="navelem"><a class="el" href="class_atlas_1_1_objects_1_1_objects_encoder.html">ObjectsEncoder</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::Objects::ObjectsEncoder Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="Atlas::Objects::ObjectsEncoder" --><!-- doxytag: inherits="Atlas::EncoderBase" -->
<p><a class="el" href="namespace_atlas_1_1_objects.html" title="The Atlas high level Objects namespace.">Objects</a> hierarchy encoder.  
 <a href="class_atlas_1_1_objects_1_1_objects_encoder.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_encoder_8h_source.html">Encoder.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Atlas::Objects::ObjectsEncoder:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_atlas_1_1_objects_1_1_objects_encoder.png" usemap="#Atlas::Objects::ObjectsEncoder_map" alt=""/>
  <map id="Atlas::Objects::ObjectsEncoder_map" name="Atlas::Objects::ObjectsEncoder_map">
<area href="class_atlas_1_1_encoder_base.html" title="Base class forwarding to Atlas::Bridge as skeleton for other encoders." alt="Atlas::EncoderBase" shape="rect" coords="0,0,186,24"/>
</map>
 </div></div>

<p><a href="class_atlas_1_1_objects_1_1_objects_encoder-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">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_objects_encoder.html#ae28c02b3654f17d4888b1e23eb03bd45">ObjectsEncoder</a> (<a class="el" href="class_atlas_1_1_bridge.html">Atlas::Bridge</a> &amp;b)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The default constructor.  <a href="#ae28c02b3654f17d4888b1e23eb03bd45"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a370bc08db6a2a224e589051a23a18992"></a><!-- doxytag: member="Atlas::Objects::ObjectsEncoder::~ObjectsEncoder" ref="a370bc08db6a2a224e589051a23a18992" args="()" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_objects_encoder.html#a370bc08db6a2a224e589051a23a18992">~ObjectsEncoder</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The default destructor. <br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;class ObjectData &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_objects_encoder.html#a6c3c1917d404a5a793b20f64011a0ccc">streamObjectsMessage</a> (const <a class="el" href="class_atlas_1_1_objects_1_1_smart_ptr.html">Atlas::Objects::SmartPtr</a>&lt; ObjectData &gt; &amp;o)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Send an object to the bridge.  <a href="#a6c3c1917d404a5a793b20f64011a0ccc"></a><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_1_1_objects.html" title="The Atlas high level Objects namespace.">Objects</a> hierarchy encoder. </p>
<p>This Encoder can be used to send objects in the <a class="el" href="namespace_atlas_1_1_objects.html" title="The Atlas high level Objects namespace.">Atlas::Objects</a> hierarchy to a certain <a class="el" href="class_atlas_1_1_bridge.html" title="Atlas stream bridge.">Bridge</a> (e.g. a codec).</p>
<p>Simply call the streamMessage member with a pointer to the object to be sent.</p>
<dl class="see"><dt><b>See also:</b></dt><dd>Atlas::Objects::Decoder </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Stefanus Du Toit &lt;<a href="mailto:sdt@gmx.net">sdt@gmx.net</a>&gt; </dd></dl>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ae28c02b3654f17d4888b1e23eb03bd45"></a><!-- doxytag: member="Atlas::Objects::ObjectsEncoder::ObjectsEncoder" ref="ae28c02b3654f17d4888b1e23eb03bd45" args="(Atlas::Bridge &amp;b)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Atlas::Objects::ObjectsEncoder::ObjectsEncoder </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_atlas_1_1_bridge.html">Atlas::Bridge</a> &amp;&#160;</td>
          <td class="paramname"><em>b</em></td><td>)</td>
          <td><code> [inline, explicit]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The default constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">b</td><td>The <a class="el" href="class_atlas_1_1_bridge.html" title="Atlas stream bridge.">Bridge</a> to which objects are to be sent. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6c3c1917d404a5a793b20f64011a0ccc"></a><!-- doxytag: member="Atlas::Objects::ObjectsEncoder::streamObjectsMessage" ref="a6c3c1917d404a5a793b20f64011a0ccc" args="(const Atlas::Objects::SmartPtr&lt; ObjectData &gt; &amp;o)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class ObjectData &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void Atlas::Objects::ObjectsEncoder::streamObjectsMessage </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_atlas_1_1_objects_1_1_smart_ptr.html">Atlas::Objects::SmartPtr</a>&lt; ObjectData &gt; &amp;&#160;</td>
          <td class="paramname"><em>o</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Send an object to the bridge. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">o</td><td>The object that is to be sent. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_encoder_8h_source.html">Encoder.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>