Sophie

Sophie

distrib > Fedora > 18 > x86_64 > media > updates > by-pkgid > 749e483016bbc41594aeb77eb13e3491 > files > 541

xrootd-doc-3.3.5-1.fc18.noarch.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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>xrootd: XrdCl::AnyObject Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">xrootd
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</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="inherits.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="namespaceXrdCl.html">XrdCl</a></li><li class="navelem"><a class="el" href="classXrdCl_1_1AnyObject.html">AnyObject</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classXrdCl_1_1AnyObject-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">XrdCl::AnyObject Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="XrdClAnyObject_8hh_source.html">XrdClAnyObject.hh</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for XrdCl::AnyObject:</div>
<div class="dyncontent">
<div class="center"><img src="classXrdCl_1_1AnyObject__coll__graph.png" border="0" usemap="#XrdCl_1_1AnyObject_coll__map" alt="Collaboration graph"/></div>
<map name="XrdCl_1_1AnyObject_coll__map" id="XrdCl_1_1AnyObject_coll__map">
<area shape="rect" id="node2" href="classXrdCl_1_1AnyObject_1_1Holder.html" title="XrdCl::AnyObject::Holder" alt="" coords="5,5,176,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1AnyObject_1_1ConcreteHolder.html">ConcreteHolder</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1AnyObject_1_1Holder.html">Holder</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9dad2221fd5150a212bf3e3a41dede17"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1AnyObject.html#a9dad2221fd5150a212bf3e3a41dede17">AnyObject</a> ()</td></tr>
<tr class="memdesc:a9dad2221fd5150a212bf3e3a41dede17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a9dad2221fd5150a212bf3e3a41dede17">More...</a><br/></td></tr>
<tr class="separator:a9dad2221fd5150a212bf3e3a41dede17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a677f151c86ece66eb59001684df5af07"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1AnyObject.html#a677f151c86ece66eb59001684df5af07">~AnyObject</a> ()</td></tr>
<tr class="memdesc:a677f151c86ece66eb59001684df5af07"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a677f151c86ece66eb59001684df5af07">More...</a><br/></td></tr>
<tr class="separator:a677f151c86ece66eb59001684df5af07"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a713c4723d49557f2a15295b02af4abde"><td class="memTemplParams" colspan="2">template&lt;class Type &gt; </td></tr>
<tr class="memitem:a713c4723d49557f2a15295b02af4abde"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1AnyObject.html#a713c4723d49557f2a15295b02af4abde">Set</a> (Type object, bool own=true)</td></tr>
<tr class="separator:a713c4723d49557f2a15295b02af4abde"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86fbcedbf164ca4a2fe4ebd7a99754b7"><td class="memTemplParams" colspan="2">template&lt;class Type &gt; </td></tr>
<tr class="memitem:a86fbcedbf164ca4a2fe4ebd7a99754b7"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1AnyObject.html#a86fbcedbf164ca4a2fe4ebd7a99754b7">Get</a> (Type &amp;object)</td></tr>
<tr class="memdesc:a86fbcedbf164ca4a2fe4ebd7a99754b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the object being held.  <a href="#a86fbcedbf164ca4a2fe4ebd7a99754b7">More...</a><br/></td></tr>
<tr class="separator:a86fbcedbf164ca4a2fe4ebd7a99754b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08bee0bc9360c1ff4c1b04bc7ddcf2b4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1AnyObject.html#a08bee0bc9360c1ff4c1b04bc7ddcf2b4">HasOwnership</a> () const </td></tr>
<tr class="memdesc:a08bee0bc9360c1ff4c1b04bc7ddcf2b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if we own the object being stored.  <a href="#a08bee0bc9360c1ff4c1b04bc7ddcf2b4">More...</a><br/></td></tr>
<tr class="separator:a08bee0bc9360c1ff4c1b04bc7ddcf2b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:adc00089f76612bfe5b46d05b14018e8e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXrdCl_1_1AnyObject_1_1Holder.html">Holder</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1AnyObject.html#adc00089f76612bfe5b46d05b14018e8e">pHolder</a></td></tr>
<tr class="separator:adc00089f76612bfe5b46d05b14018e8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35c211c0f8ddc51d6c52a5df805b4c5c"><td class="memItemLeft" align="right" valign="top">const std::type_info *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1AnyObject.html#a35c211c0f8ddc51d6c52a5df805b4c5c">pTypeInfo</a></td></tr>
<tr class="separator:a35c211c0f8ddc51d6c52a5df805b4c5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af62c8aa1893aa493154e034c3a9263ea"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXrdCl_1_1AnyObject.html#af62c8aa1893aa493154e034c3a9263ea">pOwn</a></td></tr>
<tr class="separator:af62c8aa1893aa493154e034c3a9263ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Simple implementation of a type safe holder for any object pointer It would have been a better idea to use boost::any here but we don't want to depend on boost </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a9dad2221fd5150a212bf3e3a41dede17"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">XrdCl::AnyObject::AnyObject </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Constructor. </p>

</div>
</div>
<a class="anchor" id="a677f151c86ece66eb59001684df5af07"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">XrdCl::AnyObject::~AnyObject </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Destructor. </p>

<p>References <a class="el" href="classXrdCl_1_1AnyObject_1_1Holder.html#a748e9c47ef413f459a06f48bbafc28e4">XrdCl::AnyObject::Holder::Delete()</a>, <a class="el" href="classXrdCl_1_1AnyObject.html#adc00089f76612bfe5b46d05b14018e8e">pHolder</a>, and <a class="el" href="classXrdCl_1_1AnyObject.html#af62c8aa1893aa493154e034c3a9263ea">pOwn</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a86fbcedbf164ca4a2fe4ebd7a99754b7"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void XrdCl::AnyObject::Get </td>
          <td>(</td>
          <td class="paramtype">Type &amp;&#160;</td>
          <td class="paramname"><em>object</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Retrieve the object being held. </p>

<p>References <a class="el" href="classXrdCl_1_1AnyObject_1_1Holder.html#a981b33912d56e32597c1898ca8151dab">XrdCl::AnyObject::Holder::Get()</a>, <a class="el" href="classXrdCl_1_1AnyObject.html#adc00089f76612bfe5b46d05b14018e8e">pHolder</a>, and <a class="el" href="classXrdCl_1_1AnyObject.html#a35c211c0f8ddc51d6c52a5df805b4c5c">pTypeInfo</a>.</p>

</div>
</div>
<a class="anchor" id="a08bee0bc9360c1ff4c1b04bc7ddcf2b4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool XrdCl::AnyObject::HasOwnership </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Check if we own the object being stored. </p>

<p>References <a class="el" href="classXrdCl_1_1AnyObject.html#af62c8aa1893aa493154e034c3a9263ea">pOwn</a>.</p>

</div>
</div>
<a class="anchor" id="a713c4723d49557f2a15295b02af4abde"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void XrdCl::AnyObject::Set </td>
          <td>(</td>
          <td class="paramtype">Type&#160;</td>
          <td class="paramname"><em>object</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>own</em> = <code>true</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Grab an object By default the ownership of the object is taken as well, ie. the object will be deleted when the <a class="el" href="classXrdCl_1_1AnyObject.html">AnyObject</a> holding it is deleted. To release an object grab a zero pointer, ie. (int *)0</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">object</td><td>object pointer </td></tr>
    <tr><td class="paramname">own</td><td>take the ownership or not </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="classXrdCl_1_1AnyObject.html#adc00089f76612bfe5b46d05b14018e8e">pHolder</a>, <a class="el" href="classXrdCl_1_1AnyObject.html#af62c8aa1893aa493154e034c3a9263ea">pOwn</a>, and <a class="el" href="classXrdCl_1_1AnyObject.html#a35c211c0f8ddc51d6c52a5df805b4c5c">pTypeInfo</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="adc00089f76612bfe5b46d05b14018e8e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classXrdCl_1_1AnyObject_1_1Holder.html">Holder</a>* XrdCl::AnyObject::pHolder</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Referenced by <a class="el" href="classXrdCl_1_1AnyObject.html#a86fbcedbf164ca4a2fe4ebd7a99754b7">Get()</a>, <a class="el" href="classXrdCl_1_1AnyObject.html#a713c4723d49557f2a15295b02af4abde">Set()</a>, and <a class="el" href="classXrdCl_1_1AnyObject.html#a677f151c86ece66eb59001684df5af07">~AnyObject()</a>.</p>

</div>
</div>
<a class="anchor" id="af62c8aa1893aa493154e034c3a9263ea"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool XrdCl::AnyObject::pOwn</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Referenced by <a class="el" href="classXrdCl_1_1AnyObject.html#a08bee0bc9360c1ff4c1b04bc7ddcf2b4">HasOwnership()</a>, <a class="el" href="classXrdCl_1_1AnyObject.html#a713c4723d49557f2a15295b02af4abde">Set()</a>, and <a class="el" href="classXrdCl_1_1AnyObject.html#a677f151c86ece66eb59001684df5af07">~AnyObject()</a>.</p>

</div>
</div>
<a class="anchor" id="a35c211c0f8ddc51d6c52a5df805b4c5c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const std::type_info* XrdCl::AnyObject::pTypeInfo</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Referenced by <a class="el" href="classXrdCl_1_1AnyObject.html#a86fbcedbf164ca4a2fe4ebd7a99754b7">Get()</a>, and <a class="el" href="classXrdCl_1_1AnyObject.html#a713c4723d49557f2a15295b02af4abde">Set()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XrdClAnyObject_8hh_source.html">XrdClAnyObject.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional