libdb/docs/api_reference/STL/ElementHolder.html

331 lines
11 KiB
HTML
Raw Normal View History

2011-09-13 17:44:24 +00:00
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!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/html; charset=UTF-8" />
<title>Chapter 23.  ElementHolder</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C++ Standard Template Library API Reference" />
<link rel="up" href="index.html" title="Berkeley DB C++ Standard Template Library API Reference" />
<link rel="prev" href="Element_wrappers.html" title="Chapter 22.  ElementRef and ElementHolder Wappers" />
<link rel="next" href="stlElementHolderdstr_ElementHolder.html" title="~ElementHolder" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.2</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">Chapter 23.  ElementHolder </th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="Element_wrappers.html">Prev</a> </td>
<th width="60%" align="center"> </th>
<td width="20%" align="right"> <a accesskey="n" href="stlElementHolderdstr_ElementHolder.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="chapter" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title"><a id="ElementHolder"></a>Chapter 23.  ElementHolder </h2>
</div>
</div>
</div>
<p>A wrapper class for primitive types. </p>
<p>It has identical usage and public interface to the <a class="link" href="ElementRef.html" title="Chapter 24.  ElementRef">ElementRef</a>
class. </p>
<h4><a id="id3538341"></a>
See Also
</h4>
<p> </p>
<p><a class="link" href="ElementRef.html" title="Chapter 24.  ElementRef">ElementRef</a>
. </p>
<p>
</p>
<h4><a id="id3538569"></a> Public Members </h4>
<div class="informaltable">
<table border="1" width="80%">
<colgroup>
<col />
<col />
</colgroup>
<thead>
<tr>
<th>Member</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a class="xref" href="ElementHolder.html#stlElementHolderElementHolder" title="ElementHolder">ElementHolder</a>
</td>
<td>
<p>Constructor. </p>
</td>
</tr>
<tr>
<td>
<a class="xref" href="stlElementHolderdstr_ElementHolder.html" title="~ElementHolder">~ElementHolder</a>
</td>
<td>
<p>Destructor. </p>
</td>
</tr>
<tr>
<td>
<a class="xref" href="stlElementHolderoperator_ia.html" title="operator+=">operator+=</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a class="xref" href="stlElementHolderoperator_sa.html" title="operator-=">operator-=</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a class="xref" href="stlElementHolderoperator__ma.html" title="operator *=">operator *=</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a class="xref" href="stlElementHolderoperator_da.html" title="operator/=">operator/=</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a class="xref" href="stlElementHolderoperator_modasg.html" title="operator%=">operator%=</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a class="xref" href="stlElementHolderoperator__aa.html" title="operator &amp;=">operator &amp;=</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a class="xref" href="stlElementHolderoperator_oa.html" title="operator|=">operator|=</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a class="xref" href="stlElementHolderoperator_xa.html" title="operator^=">operator^=</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a class="xref" href="stlElementHolderoperator_gt_ge.html" title="operator&gt;&gt;=">operator&gt;&gt;=</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a class="xref" href="stlElementHolderoperator_lt_le.html" title="operator&lt;&lt;=">operator&lt;&lt;=</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a class="xref" href="stlElementHolderoperator_incr.html" title="operator++">operator++</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a class="xref" href="stlElementHolderoperator_decr.html" title="operator--">operator--</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a class="xref" href="stlElementHolderoperator_assign.html" title="operator=">operator=</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
<a class="xref" href="stlElementHolderoperator_ptype.html" title="operator ptype">operator ptype</a>
</td>
<td>
<p>This operator is a type converter. </p>
</td>
</tr>
<tr>
<td>
<a class="xref" href="stlElementHolder_DB_STL_value.html" title="_DB_STL_value">_DB_STL_value</a>
</td>
<td>
<p>Returns the data element this wrapper object wraps;. </p>
</td>
</tr>
<tr>
<td>
<a class="xref" href="stlElementHolder_DB_STL_StoreElement.html" title="_DB_STL_StoreElement">_DB_STL_StoreElement</a>
</td>
<td>
<p>Function to store the data element. </p>
</td>
</tr>
</tbody>
</table>
</div>
<h4><a id="id3538745"></a>
Group</h4>
<p>
<a class="xref" href="Element_wrappers.html" title="Chapter 22.  ElementRef and ElementHolder Wappers">
ElementRef and ElementHolder Wappers </a>
</p>
<p>
</p>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="stlElementHolderElementHolder"></a>ElementHolder</h2>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="stlElementHolderElementHolder_details"></a>Function Details</h3>
</div>
</div>
</div>
<pre class="programlisting">
ElementHolder(iterator_type *pitr=NULL)
</pre>
<p>Constructor. </p>
<p>If the pitr parameter is NULL or the default value is used, the object created is a simple wrapper and not connected to a container. If a valid iterator parameter is passed in, the wrapped element will be associated with the matching key/data pair in the underlying container. </p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3538530"></a>Parameters</h4>
</div>
</div>
</div>
<div class="sect4" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h5 class="title"><a id="id3539030"></a>pitr</h5>
</div>
</div>
</div>
<p>The iterator owning this object. </p>
</div>
</div>
<pre class="programlisting">
ElementHolder(const ptype &amp;dt)
</pre>
<p>Constructor. </p>
<p>Initializes an <a class="link" href="ElementRef.html" title="Chapter 24.  ElementRef">ElementRef</a>
wrapper without an iterator. It can only be used to wrap a data element in memory, it can't access an unerlying database. </p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3539068"></a>Parameters</h4>
</div>
</div>
</div>
<div class="sect4" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h5 class="title"><a id="id3539071"></a>dt</h5>
</div>
</div>
</div>
<p>The base class object to initialize this object. </p>
</div>
</div>
<pre class="programlisting">
ElementHolder(const self &amp;other)
</pre>
<p>Copy constructor. </p>
<p>The constructor takes a "deep" copy. The created object will be identical to, but independent from the original object. </p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3539087"></a>Parameters</h4>
</div>
</div>
</div>
<div class="sect4" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h5 class="title"><a id="id3539091"></a>other</h5>
</div>
</div>
</div>
<p>The object to clone from. </p>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3538573"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="ElementHolder.html" title="Chapter 23.  ElementHolder">
ElementHolder</a>
</p>
</div>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="Element_wrappers.html">Prev</a> </td>
<td width="20%" align="center"> </td>
<td width="40%" align="right"> <a accesskey="n" href="stlElementHolderdstr_ElementHolder.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">Chapter 22. 
ElementRef and ElementHolder Wappers  </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> ~ElementHolder</td>
</tr>
</table>
</div>
</body>
</html>