Sophie

Sophie

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

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::Operation::TouchData 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"><b>Operation</b>      </li>
      <li class="navelem"><a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_touch_data.html">TouchData</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">Atlas::Objects::Operation::TouchData Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="Atlas::Objects::Operation::TouchData" --><!-- doxytag: inherits="Atlas::Objects::Operation::PerceiveData" -->
<p>Touch something.  
 <a href="class_atlas_1_1_objects_1_1_operation_1_1_touch_data.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_operation_8h_source.html">Operation.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Atlas::Objects::Operation::TouchData:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_atlas_1_1_objects_1_1_operation_1_1_touch_data.png" usemap="#Atlas::Objects::Operation::TouchData_map" alt=""/>
  <map id="Atlas::Objects::Operation::TouchData_map" name="Atlas::Objects::Operation::TouchData_map">
<area href="class_atlas_1_1_objects_1_1_operation_1_1_perceive_data.html" title="Generic base operation for perceiving things by eyes, ears, etc...." alt="Atlas::Objects::Operation::PerceiveData" shape="rect" coords="0,280,264,304"/>
<area href="class_atlas_1_1_objects_1_1_operation_1_1_get_data.html" title="Generic operation for getting info about things." alt="Atlas::Objects::Operation::GetData" 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"/>
</map>
 </div></div>

<p><a href="class_atlas_1_1_objects_1_1_operation_1_1_touch_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="a34ede32db06101ea6fabe4351e0e9cac"></a><!-- doxytag: member="Atlas::Objects::Operation::TouchData::copy" ref="a34ede32db06101ea6fabe4351e0e9cac" args="() const " -->
virtual <a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_touch_data.html">TouchData</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_touch_data.html#a34ede32db06101ea6fabe4351e0e9cac">copy</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy this object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee85f60996da2afed9c80d997728a9db"></a><!-- doxytag: member="Atlas::Objects::Operation::TouchData::instanceOf" ref="aee85f60996da2afed9c80d997728a9db" args="(int classNo) const " -->
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_touch_data.html#aee85f60996da2afed9c80d997728a9db">instanceOf</a> (int classNo) const </td></tr>
<tr><td class="mdescLeft">&#160;</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="ae42c9495e43a848e1b0014cb80bb605b"></a><!-- doxytag: member="Atlas::Objects::Operation::TouchData::iterate" ref="ae42c9495e43a848e1b0014cb80bb605b" args="(int &amp;current_class, std::string &amp;attr) const " -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_touch_data.html#ae42c9495e43a848e1b0014cb80bb605b">iterate</a> (int &amp;current_class, std::string &amp;attr) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterate over the attributes of this instance. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_touch_data.html#a617fa5e939d219b43229a935a35e7aef">free</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Free an instance of this class, returning it to the memory pool.  <a href="#a617fa5e939d219b43229a935a35e7aef"></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_touch_data.html">TouchData</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_touch_data.html#ab4a8977215087abceeed840c6e366e49">getDefaultObject</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</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="#ab4a8977215087abceeed840c6e366e49"></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_touch_data.html">TouchData</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_touch_data.html#afcb9fbb9facb046a59a8838df7c98563">alloc</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate a new instance of this class, using an existing instance if available.  <a href="#afcb9fbb9facb046a59a8838df7c98563"></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_touch_data.html">TouchData</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_touch_data.html#a36d1604f67c17427c47151eb4732344a">getDefaultObjectInstance</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the reference object that contains the default values for attributes of instances of this class.  <a href="#a36d1604f67c17427c47151eb4732344a"></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="a0291f964a004cbac44aaa9359b58c620"></a><!-- doxytag: member="Atlas::Objects::Operation::TouchData::TouchData" ref="a0291f964a004cbac44aaa9359b58c620" args="(TouchData *defaults=NULL)" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_touch_data.html#a0291f964a004cbac44aaa9359b58c620">TouchData</a> (<a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_touch_data.html">TouchData</a> *defaults=NULL)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a <a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_touch_data.html" title="Touch something.">TouchData</a> class definition. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9dcbf9307290a895ab3e167a45a20a80"></a><!-- doxytag: member="Atlas::Objects::Operation::TouchData::~TouchData" ref="a9dcbf9307290a895ab3e167a45a20a80" args="()" -->
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_atlas_1_1_objects_1_1_operation_1_1_touch_data.html#a9dcbf9307290a895ab3e167a45a20a80">~TouchData</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</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>Touch something. </p>
<p>This is base operation for all other operations and defines basic attributes. You can use this as starting point for browsing whole operation hiearchy. refno refers to operation this is reply for. In examples all attributes that are just as examples (and thus world specific) are started with 'e_'. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afcb9fbb9facb046a59a8838df7c98563"></a><!-- doxytag: member="Atlas::Objects::Operation::TouchData::alloc" ref="afcb9fbb9facb046a59a8838df7c98563" 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_touch_data.html">TouchData</a>* Atlas::Objects::Operation::TouchData::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_perceive_data.html#ab319414fb42363be456af24eed65e4a9">Atlas::Objects::Operation::PerceiveData</a>.</p>

</div>
</div>
<a class="anchor" id="a617fa5e939d219b43229a935a35e7aef"></a><!-- doxytag: member="Atlas::Objects::Operation::TouchData::free" ref="a617fa5e939d219b43229a935a35e7aef" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void Atlas::Objects::Operation::TouchData::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_touch_data.html#afcb9fbb9facb046a59a8838df7c98563" 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_perceive_data.html#a4946f1e83e5ebfce4d6716134da04c55">Atlas::Objects::Operation::PerceiveData</a>.</p>

</div>
</div>
<a class="anchor" id="ab4a8977215087abceeed840c6e366e49"></a><!-- doxytag: member="Atlas::Objects::Operation::TouchData::getDefaultObject" ref="ab4a8977215087abceeed840c6e366e49" 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_touch_data.html">TouchData</a>* Atlas::Objects::Operation::TouchData::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_perceive_data.html#a412d667a78a7d59a1939b511a8ad3190">Atlas::Objects::Operation::PerceiveData</a>.</p>

</div>
</div>
<a class="anchor" id="a36d1604f67c17427c47151eb4732344a"></a><!-- doxytag: member="Atlas::Objects::Operation::TouchData::getDefaultObjectInstance" ref="a36d1604f67c17427c47151eb4732344a" 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_touch_data.html">TouchData</a>* Atlas::Objects::Operation::TouchData::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_perceive_data.html#aed06dbccf703dbe916dfb01e13c77a8e">Atlas::Objects::Operation::PerceiveData</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>