ceph/src/boost/libs/property_map/doc/ref_property_map.html

   1 <HTML>
   2 <!--
   3      Copyright 2006 The Trustees of Indiana University
   4
   5      Use, modification and distribution is subject to the Boost Software
   6      License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
   7      http://www.boost.org/LICENSE_1_0.txt)
   8
   9   -->
  10 <Head>
  11 <Title>Reference Property Map</Title>
  12 <BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b"
  13         ALINK="#ff0000">
  14 <IMG SRC="../../../boost.png"
  15      ALT="C++ Boost" width="277" height="86">
  16
  17 <BR Clear>
  18
  19 <H2><A NAME="sec:identity-property-map"></A>
  20 </h2>
  21 <PRE>
  22 template &lt;typename KeyType, typename ValueType&gt;
  23 class ref_property_map
  24 </PRE>
  25
  26 This property map wraps a reference to some particular object, and
  27 returns that reference whenever a key object is input.
  28
  29 <H3>Where Defined</H3>
  30
  31 <P>
  32 <a href="../../../boost/property_map/property_map.hpp"><TT>boost/property_map/property_map.hpp</TT></a>
  33
  34 <h3>Model of</h3>
  35
  36 <a href="./LvaluePropertyMap.html">Lvalue Property Map</a>
  37
  38 <h3>Associated Types</h3>
  39
  40 <table border>
  41 <tr>
  42 <th>Type</th><th>Description</th>
  43 </tr>
  44
  45 <tr>
  46 <td><tt>
  47 boost::property_traits&lt;ref_property_map&gt;::value_type
  48 </tt></td>
  49 <td>
  50 This type is the <tt>ValueType</tt> with which the template was instantiated.
  51 </td>
  52 </tr>
  53
  54 <tr>
  55 <td><tt>
  56 boost::property_traits&lt;ref_property_map&gt;::key_type
  57 </tt></td>
  58 <td>
  59 This type is the <tt>KeyType</tt> with which the template was instantiated.
  60 </td>
  61 </tr>
  62
  63 <tr>
  64 <td><tt>
  65 boost::property_traits&lt;ref_property_map&gt;::category
  66 </tt></td>
  67 <td>
  68 This type is <tt>boost::lvalue_property_map_tag</tt>.
  69 </td>
  70 </tr>
  71
  72 </table>
  73
  74 <h3>Member Functions</h3>
  75
  76 <table border>
  77 <tr>
  78 <th>Member</th><th>Description</th>
  79 </tr>
  80
  81
  82 <tr>
  83 <td><tt>
  84 ref_property_map(ValueType&amp; v)
  85 </tt></td>
  86 <td>
  87 The constructor for ref_property_map is provided the reference that
  88 the property map will return when queried.
  89 </td>
  90 </tr>
  91
  92 <tr>
  93 <td><tt>
  94 ref_property_map(const ref_property_map&amp; x)
  95 </tt></td>
  96 <td>
  97 Copy constructor.
  98 </td>
  99 </tr>
 100
 101 <tr>
 102 <td><tt>
 103 ValueType&amp; operator[](KeyType const&amp;) const
 104 </tt></td>
 105 <td>
 106 Returns the contained reference.
 107 </td>
 108 </tr>
 109
 110 </table>
 111
 112
 113 </BODY>
 114 </HTML>