<!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::Operation::CommunicateData 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="namespace_atlas_1_1_objects.html">Objects</a> </li>
<li class="navelem"><b>Operation</b> </li>
<li class="navelem"><a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html">CommunicateData</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">Atlas::Objects::Operation::CommunicateData Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Atlas::Objects::Operation::CommunicateData" --><!-- doxytag: inherits="Atlas::Objects::Operation::CreateData" -->
<p>Base operator for all kind of communication.
<a href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_operation_8h_source.html">Operation.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Atlas::Objects::Operation::CommunicateData:</div>
<div class="dyncontent">
<div class="center">
<img src="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.png" usemap="#Atlas::Objects::Operation::CommunicateData_map" alt=""/>
<map id="Atlas::Objects::Operation::CommunicateData_map" name="Atlas::Objects::Operation::CommunicateData_map">
<area href="class_atlas_1_1_objects_1_1_operation_1_1_create_data.html" title="Create new things from nothing using this operator." alt="Atlas::Objects::Operation::CreateData" shape="rect" coords="0,224,264,248"/>
<area href="class_atlas_1_1_objects_1_1_operation_1_1_action_data.html" title="This is base operator for operations that might have effects." alt="Atlas::Objects::Operation::ActionData" shape="rect" coords="0,168,264,192"/>
<area href="class_atlas_1_1_objects_1_1_operation_1_1_root_operation_data.html" title="Base operation for all operators." alt="Atlas::Objects::Operation::RootOperationData" shape="rect" coords="0,112,264,136"/>
<area href="class_atlas_1_1_objects_1_1_root_data.html" title="All objects inherit from this." alt="Atlas::Objects::RootData" shape="rect" coords="0,56,264,80"/>
<area href="class_atlas_1_1_objects_1_1_base_object_data.html" title="Atlas base object class." alt="Atlas::Objects::BaseObjectData" shape="rect" coords="0,0,264,24"/>
<area href="class_atlas_1_1_objects_1_1_operation_1_1_talk_data.html" title="used for talking." alt="Atlas::Objects::Operation::TalkData" shape="rect" coords="0,336,264,360"/>
</map>
</div></div>
<p><a href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data-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="a820145ebdcbea67856f261d5be6ee5e8"></a><!-- doxytag: member="Atlas::Objects::Operation::CommunicateData::copy" ref="a820145ebdcbea67856f261d5be6ee5e8" args="() const " -->
virtual <a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html">CommunicateData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html#a820145ebdcbea67856f261d5be6ee5e8">copy</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy this object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7598a2022625c64548faca2be3cb20aa"></a><!-- doxytag: member="Atlas::Objects::Operation::CommunicateData::instanceOf" ref="a7598a2022625c64548faca2be3cb20aa" args="(int classNo) const " -->
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html#a7598a2022625c64548faca2be3cb20aa">instanceOf</a> (int classNo) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Is this instance of some class? <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6196a18c8262c1968d502a1a8b0311d9"></a><!-- doxytag: member="Atlas::Objects::Operation::CommunicateData::iterate" ref="a6196a18c8262c1968d502a1a8b0311d9" args="(int &current_class, std::string &attr) const " -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html#a6196a18c8262c1968d502a1a8b0311d9">iterate</a> (int &current_class, std::string &attr) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate over the attributes of this instance. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html#a755f5e6030fb683c6e8cd37159566989">free</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free an instance of this class, returning it to the memory pool. <a href="#a755f5e6030fb683c6e8cd37159566989"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html">CommunicateData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html#a3ad0e668912a1eb7dc3b223148009eb1">getDefaultObject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the reference object that contains the default values for attributes of instances of the same class as this object. <a href="#a3ad0e668912a1eb7dc3b223148009eb1"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html">CommunicateData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html#a3a39609ebdd9e07e78511eac11185ae2">alloc</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate a new instance of this class, using an existing instance if available. <a href="#a3a39609ebdd9e07e78511eac11185ae2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html">CommunicateData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html#a09d382fac7567a16850aac69f1348a92">getDefaultObjectInstance</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the reference object that contains the default values for attributes of instances of this class. <a href="#a09d382fac7567a16850aac69f1348a92"></a><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="ac2f340fc9b42be67776b6e1592697a1d"></a><!-- doxytag: member="Atlas::Objects::Operation::CommunicateData::CommunicateData" ref="ac2f340fc9b42be67776b6e1592697a1d" args="(CommunicateData *defaults=NULL)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html#ac2f340fc9b42be67776b6e1592697a1d">CommunicateData</a> (<a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html">CommunicateData</a> *defaults=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html" title="Base operator for all kind of communication.">CommunicateData</a> class definition. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a114707b7a197d87b568c503b194406ff"></a><!-- doxytag: member="Atlas::Objects::Operation::CommunicateData::~CommunicateData" ref="a114707b7a197d87b568c503b194406ff" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html#a114707b7a197d87b568c503b194406ff">~CommunicateData</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base operator for all kind of communication. </p>
<p>. Map editor is main user for this in client side. Server uses this inside "info" operation to tell client about new things. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3a39609ebdd9e07e78511eac11185ae2"></a><!-- doxytag: member="Atlas::Objects::Operation::CommunicateData::alloc" ref="a3a39609ebdd9e07e78511eac11185ae2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html">CommunicateData</a>* Atlas::Objects::Operation::CommunicateData::alloc </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Allocate a new instance of this class, using an existing instance if available. </p>
<p>This is the key function for implementing the memory pool for the <a class="el" href="namespace_atlas_1_1_objects.html" title="The Atlas high level Objects namespace.">Atlas::Objects</a> API. </p>
<p>Reimplemented from <a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_create_data.html#a4bd7e008381499cbab300c7e17c0553c">Atlas::Objects::Operation::CreateData</a>.</p>
<p>Reimplemented in <a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_talk_data.html#a910dfc529704014304d88390cfeed3fb">Atlas::Objects::Operation::TalkData</a>.</p>
</div>
</div>
<a class="anchor" id="a755f5e6030fb683c6e8cd37159566989"></a><!-- doxytag: member="Atlas::Objects::Operation::CommunicateData::free" ref="a755f5e6030fb683c6e8cd37159566989" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Atlas::Objects::Operation::CommunicateData::free </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Free an instance of this class, returning it to the memory pool. </p>
<p>This function in combination with <a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html#a3a39609ebdd9e07e78511eac11185ae2" title="Allocate a new instance of this class, using an existing instance if available.">alloc()</a> handle the memory pool. </p>
<p>Reimplemented from <a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_create_data.html#aa927c89e09e723c92a31e3182767b673">Atlas::Objects::Operation::CreateData</a>.</p>
<p>Reimplemented in <a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_talk_data.html#ade4b5a27910e019eabf439d6ed4e3bfe">Atlas::Objects::Operation::TalkData</a>.</p>
</div>
</div>
<a class="anchor" id="a3ad0e668912a1eb7dc3b223148009eb1"></a><!-- doxytag: member="Atlas::Objects::Operation::CommunicateData::getDefaultObject" ref="a3ad0e668912a1eb7dc3b223148009eb1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html">CommunicateData</a>* Atlas::Objects::Operation::CommunicateData::getDefaultObject </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the reference object that contains the default values for attributes of instances of the same class as this object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the default object. </dd></dl>
<p>Reimplemented from <a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_create_data.html#a5c93f6265352729563b4504f1ec3f6ca">Atlas::Objects::Operation::CreateData</a>.</p>
<p>Reimplemented in <a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_talk_data.html#a2c849dd8b608448a908d3d095ad6528d">Atlas::Objects::Operation::TalkData</a>.</p>
</div>
</div>
<a class="anchor" id="a09d382fac7567a16850aac69f1348a92"></a><!-- doxytag: member="Atlas::Objects::Operation::CommunicateData::getDefaultObjectInstance" ref="a09d382fac7567a16850aac69f1348a92" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_communicate_data.html">CommunicateData</a>* Atlas::Objects::Operation::CommunicateData::getDefaultObjectInstance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the reference object that contains the default values for attributes of instances of this class. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the default object. </dd></dl>
<p>Reimplemented from <a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_create_data.html#a2d284758fcb7921c5fde6512b873c897">Atlas::Objects::Operation::CreateData</a>.</p>
<p>Reimplemented in <a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_talk_data.html#a81921d94151dfbf09d2a274f1ff0da86">Atlas::Objects::Operation::TalkData</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_operation_8h_source.html">Operation.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>
