| 1 | <HTML> |
|---|
| 2 | <!-- |
|---|
| 3 | -- Copyright (c) Jeremy Siek 2000 |
|---|
| 4 | -- |
|---|
| 5 | -- Permission to use, copy, modify, distribute and sell this software |
|---|
| 6 | -- and its documentation for any purpose is hereby granted without fee, |
|---|
| 7 | -- provided that the above copyright notice appears in all copies and |
|---|
| 8 | -- that both that copyright notice and this permission notice appear |
|---|
| 9 | -- in supporting documentation. Silicon Graphics makes no |
|---|
| 10 | -- representations about the suitability of this software for any |
|---|
| 11 | -- purpose. It is provided "as is" without express or implied warranty. |
|---|
| 12 | --> |
|---|
| 13 | <Head> |
|---|
| 14 | <Title>Read Write Property Map</Title> |
|---|
| 15 | <BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b" |
|---|
| 16 | ALINK="#ff0000"> |
|---|
| 17 | <IMG SRC="../../boost.png" |
|---|
| 18 | ALT="C++ Boost" width="277" height="86"> |
|---|
| 19 | |
|---|
| 20 | <BR Clear> |
|---|
| 21 | |
|---|
| 22 | <H2> |
|---|
| 23 | <A NAME="concept:ReadWritePropertyMap"></A> |
|---|
| 24 | <BR> |
|---|
| 25 | Read/Write Property Map |
|---|
| 26 | </H2> |
|---|
| 27 | |
|---|
| 28 | A Read/Write Property Map can be used to read property values via |
|---|
| 29 | the <tt>get()</tt> function and can be used to write property values |
|---|
| 30 | via the <tt>put()</tt> function. |
|---|
| 31 | |
|---|
| 32 | <H3>Refinement of</H3> |
|---|
| 33 | |
|---|
| 34 | <a href="./ReadablePropertyMap.html">Readable Property Map</a> |
|---|
| 35 | and |
|---|
| 36 | <a href="./WritablePropertyMap.html">Writable Property Map</a> |
|---|
| 37 | |
|---|
| 38 | |
|---|
| 39 | |
|---|
| 40 | <h3>Notation</h3> |
|---|
| 41 | |
|---|
| 42 | <Table> |
|---|
| 43 | <TR> |
|---|
| 44 | <TD><tt>PMap</tt></TD> |
|---|
| 45 | <TD>A type that is a model of Read/Write Property Map.</TD> |
|---|
| 46 | </TR> |
|---|
| 47 | |
|---|
| 48 | </table> |
|---|
| 49 | |
|---|
| 50 | <h2>Associated Types</h2> |
|---|
| 51 | |
|---|
| 52 | <table border> |
|---|
| 53 | |
|---|
| 54 | <tr> |
|---|
| 55 | <td>Property Map Category |
|---|
| 56 | <td><TT>boost::property_traits<PMap>::category</TT></td> |
|---|
| 57 | <td> |
|---|
| 58 | The category of the property map must be a type convertible to |
|---|
| 59 | <TT>read_write_property_map_tag</TT>. |
|---|
| 60 | </td> |
|---|
| 61 | </tr> |
|---|
| 62 | |
|---|
| 63 | </table> |
|---|
| 64 | |
|---|
| 65 | |
|---|
| 66 | <h3>Concept Checking Class</h3> |
|---|
| 67 | |
|---|
| 68 | <pre> |
|---|
| 69 | template <class PMap, class Key> |
|---|
| 70 | struct ReadWritePropertyMapConcept |
|---|
| 71 | { |
|---|
| 72 | typedef typename property_traits<PMap>::category Category; |
|---|
| 73 | typedef boost::read_write_property_map_tag ReadWriteTag; |
|---|
| 74 | void constraints() { |
|---|
| 75 | function_requires< ReadablePropertyMapConcept<PMap, Key> >(); |
|---|
| 76 | function_requires< WritablePropertyMapConcept<PMap, Key> >(); |
|---|
| 77 | function_requires< ConvertibleConcept<Category, ReadWriteTag> >(); |
|---|
| 78 | } |
|---|
| 79 | }; |
|---|
| 80 | </pre> |
|---|
| 81 | |
|---|
| 82 | <h3>See Also</h3> |
|---|
| 83 | |
|---|
| 84 | <a href="./property_map.html">Property map concepts</a> |
|---|
| 85 | |
|---|
| 86 | |
|---|
| 87 | <br> |
|---|
| 88 | <HR> |
|---|
| 89 | <TABLE> |
|---|
| 90 | <TR valign=top> |
|---|
| 91 | <TD nowrap>Copyright © 2000</TD><TD> |
|---|
| 92 | <a HREF="../../people/jeremy_siek.htm">Jeremy Siek</a>, Univ.of Notre Dame (<A HREF="mailto:jsiek@lsc.nd.edu">jsiek@lsc.nd.edu</A>) |
|---|
| 93 | </TD></TR></TABLE> |
|---|
| 94 | |
|---|
| 95 | </BODY> |
|---|
| 96 | </HTML> |
|---|
