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

   1 <HTML>
   2 <!--
   3      Copyright (c) Jeremy Siek 2000
   4
   5      Distributed under the Boost Software License, Version 1.0.
   6      (See accompanying file LICENSE_1_0.txt or copy at
   7      http://www.boost.org/LICENSE_1_0.txt)
   8   -->
   9 <Head>
  10 <Title>Read Write Property Map</Title>
  11 <BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b"
  12         ALINK="#ff0000">
  13 <IMG SRC="../../../boost.png"
  14      ALT="C++ Boost" width="277" height="86">
  15
  16 <BR Clear>
  17
  18 <H2>
  19 <A NAME="concept:ReadWritePropertyMap"></A>
  20 <BR>
  21 Read/Write Property Map
  22 </H2>
  23
  24 A Read/Write Property Map can be used to read property values via
  25 the <tt>get()</tt> function and can be used to write property values
  26 via the <tt>put()</tt> function.
  27
  28 <H3>Refinement of</H3>
  29
  30 <a href="./ReadablePropertyMap.html">Readable Property Map</a>
  31 and
  32 <a href="./WritablePropertyMap.html">Writable Property Map</a>
  33
  34
  35
  36 <h3>Notation</h3>
  37
  38 <Table>
  39 <TR>
  40 <TD><tt>PMap</tt></TD>
  41 <TD>A type that is a model of Read/Write Property Map.</TD>
  42 </TR>
  43
  44 </table>
  45
  46 <h2>Associated Types</h2>
  47
  48 <table border>
  49
  50 <tr>
  51 <td>Property Map Category
  52 <td><TT>boost::property_traits&lt;PMap&gt;::category</TT></td>
  53 <td>
  54 The category of the property map must be a type convertible to
  55 <TT>read_write_property_map_tag</TT>.
  56 </td>
  57 </tr>
  58
  59 </table>
  60
  61
  62 <h3>Concept Checking Class</h3>
  63
  64 <pre>
  65   template &lt;class PMap, class Key&gt;
  66   struct ReadWritePropertyMapConcept
  67   {
  68     typedef typename property_traits&lt;PMap&gt;::category Category;
  69     typedef boost::read_write_property_map_tag ReadWriteTag;
  70     void constraints() {
  71       function_requires&lt; ReadablePropertyMapConcept&lt;PMap, Key&gt; &gt;();
  72       function_requires&lt; WritablePropertyMapConcept&lt;PMap, Key&gt; &gt;();
  73       function_requires&lt; ConvertibleConcept&lt;Category, ReadWriteTag&gt; &gt;();
  74     }
  75   };
  76 </pre>
  77
  78 <h3>See Also</h3>
  79
  80 <a href="./property_map.html">Property map concepts</a>
  81
  82
  83 <br>
  84 <HR>
  85 <TABLE>
  86 <TR valign=top>
  87 <TD nowrap>Copyright &copy 2000</TD><TD>
  88 <a HREF="http://www.boost.org/people/jeremy_siek.htm">Jeremy Siek</a>, Univ.of Notre Dame (<A HREF="mailto:jsiek@lsc.nd.edu">jsiek@lsc.nd.edu</A>)
  89 </TD></TR></TABLE>
  90
  91 </BODY>
  92 </HTML>