Sophie

Sophie

distrib > Mandriva > 2010.1 > i586 > by-pkgid > 4f5f2dc0f55b453456458df885792b0b > files > 193

ucommon-doc-5.0.4-1mdv2010.2.i586.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>ucommon: ucommon::ObjectProtocol 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.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&nbsp;Structure&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="a00208.html">ucommon</a>::<a class="el" href="a00095.html">ObjectProtocol</a>
  </div>
</div>
<div class="contents">
<h1>ucommon::ObjectProtocol Class Reference</h1><!-- doxytag: class="ucommon::ObjectProtocol" -->
<p>A common base class for all managed objects.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00192_source.html">object.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ucommon::ObjectProtocol:</div>
<div class="dynsection">
<div class="center"><img src="a00456.png" border="0" usemap="#ucommon_1_1_object_protocol_inherit__map" alt="Inheritance graph"/></div>
<map name="ucommon_1_1_object_protocol_inherit__map" id="ucommon_1_1_object_protocol_inherit__map">
<area shape="rect" id="node3" href="a00039.html" title="A base class for reference counted objects." alt="" coords="307,81,549,108"/><area shape="rect" id="node9" href="a00067.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="312,157,544,184"/><area shape="rect" id="node52" href="a00148.html" title="A copy&#45;on&#45;write string class that operates by reference count." alt="" coords="343,340,513,367"/><area shape="rect" id="node5" href="a00104.html" title="This is a base class for objects that may be created in pager pools." alt="" coords="619,81,840,108"/><area shape="rect" id="node7" href="a00149.html" title="This is an internal class which contains the actual string data along with some control..." alt="" coords="599,31,860,57"/><area shape="rect" id="node11" href="a00033.html" title="A class to hold internet segment routing rules." alt="" coords="653,132,805,159"/><area shape="rect" id="node13" href="a00101.html" title="A linked object base class for ordered objects." alt="" coords="608,183,851,209"/><area shape="rect" id="node46" href="a00116.html" title="Reusable objects for forming private heaps." alt="" coords="604,271,855,297"/><area shape="rect" id="node15" href="a00047.html" title="A double&#45;linked Object, used for certain kinds of lists." alt="" coords="929,5,1172,32"/><area shape="rect" id="node17" href="a00055.html" title="Data keys parsed from a keyfile." alt="" coords="960,56,1141,83"/><area shape="rect" id="node19" href="a00056.html" title="A key value set is used for iterative access." alt="" coords="909,107,1192,133"/><area shape="rect" id="node21" href="a00066.html" title="A double linked list object." alt="" coords="945,157,1156,184"/><area shape="rect" id="node25" href="a00090.html" title="A linked object base class with members found by name." alt="" coords="940,208,1161,235"/><area shape="rect" id="node31" href="a00137.html" title="A base class used to create parsable shell options." alt="" coords="929,259,1172,285"/><area shape="rect" id="node23" href="a00164.html" title="A timer event object that lives on a timer queue." alt="" coords="1240,56,1523,83"/><area shape="rect" id="node27" href="a00091.html" title="The named tree class is used to form a tree oriented list of associated objects." alt="" coords="1280,107,1483,133"/><area shape="rect" id="node29" href="a00166.html" title="Embed data objects into a tree structured memory database." alt="" coords="1571,107,1803,133"/><area shape="rect" id="node33" href="a00130.html" title="Character option for shell parsing." alt="" coords="1256,157,1507,184"/><area shape="rect" id="node35" href="a00131.html" title="Counter option for shell parsing." alt="" coords="1240,208,1523,235"/><area shape="rect" id="node37" href="a00133.html" title="Flag option for shell parsing." alt="" coords="1256,259,1507,285"/><area shape="rect" id="node39" href="a00134.html" title="Grouping option." alt="" coords="1251,309,1512,336"/><area shape="rect" id="node41" href="a00136.html" title="Numeric option for shell parsing." alt="" coords="1240,360,1523,387"/><area shape="rect" id="node43" href="a00139.html" title="Text option for shell parsing." alt="" coords="1245,411,1517,437"/><area shape="rect" id="node48" href="a00084.html" title="A multipath linked list where membership is managed in multiple lists." alt="" coords="955,309,1147,336"/><area shape="rect" id="node50" href="a00085.html" title="Embed data objects into a multipap structured memory database." alt="" coords="1245,461,1517,488"/><area shape="rect" id="node54" href="a00082.html" title="A string class that uses a cstring buffer that is fixed in memory." alt="" coords="628,340,831,367"/><area shape="rect" id="node58" href="a00169.html" title="A copy&#45;on&#45;write utf8 string class that operates by reference count." alt="" coords="639,391,820,417"/><area shape="rect" id="node56" href="a00150.html" title="A string class that has a predefined string buffer." alt="" coords="925,360,1176,387"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4a4a4a1e33744f72e9da89576678f78c"></a><!-- doxytag: member="ucommon::ObjectProtocol::copy" ref="a4a4a4a1e33744f72e9da89576678f78c" args="(void)" -->
<a class="el" href="a00095.html">ObjectProtocol</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00095.html#a4a4a4a1e33744f72e9da89576678f78c">copy</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retain (increase retention of) object when copying. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e07dfd934ca36066e50436213070c49"></a><!-- doxytag: member="ucommon::ObjectProtocol::operator++" ref="a3e07dfd934ca36066e50436213070c49" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00095.html#a3e07dfd934ca36066e50436213070c49">operator++</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Increase retention operator. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a31215de8ea6f7e86e4dd4b19fd09000b"></a><!-- doxytag: member="ucommon::ObjectProtocol::operator&#45;&#45;" ref="a31215de8ea6f7e86e4dd4b19fd09000b" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00095.html#a31215de8ea6f7e86e4dd4b19fd09000b">operator--</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Decrease retention operator. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2eb0d4a0fb083b3b52e5a2e61d37c489"></a><!-- doxytag: member="ucommon::ObjectProtocol::release" ref="a2eb0d4a0fb083b3b52e5a2e61d37c489" args="(void)=0" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00095.html#a2eb0d4a0fb083b3b52e5a2e61d37c489">release</a> (void)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method to release (or decrease retention) of an object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac39b84806d069dafc90d666ac2de34af"></a><!-- doxytag: member="ucommon::ObjectProtocol::retain" ref="ac39b84806d069dafc90d666ac2de34af" args="(void)=0" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00095.html#ac39b84806d069dafc90d666ac2de34af">retain</a> (void)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method to retain (or increase retention) of an object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a83b713f295c64fbe40927fd958a0c65f"></a><!-- doxytag: member="ucommon::ObjectProtocol::~ObjectProtocol" ref="a83b713f295c64fbe40927fd958a0c65f" args="()" -->
virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00095.html#a83b713f295c64fbe40927fd958a0c65f">~ObjectProtocol</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Required virtual destructor. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A common base class for all managed objects. </p>
<p>This is used to manage objects that might be linked or reference counted. The base class defines only core virtuals some common public methods that should be used by all inherited object types. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar &lt;<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>&gt; </dd></dl>

<p>Definition at line <a class="el" href="a00192_source.html#l00051">51</a> of file <a class="el" href="a00192_source.html">object.h</a>.</p>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00192_source.html">object.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:39:48 2011 for ucommon by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>