1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
<HTML>
<!--
-- Copyright (c) Jeremy Siek 2000
--
-- Permission to use, copy, modify, distribute and sell this software
-- and its documentation for any purpose is hereby granted without fee,
-- provided that the above copyright notice appears in all copies and
-- that both that copyright notice and this permission notice appear
-- in supporting documentation. Silicon Graphics makes no
-- representations about the suitability of this software for any
-- purpose. It is provided "as is" without express or implied warranty.
-->
<Head>
<Title>WritablePropertyMap</Title>
<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b"
ALINK="#ff0000">
<IMG SRC="../../c++boost.gif"
ALT="C++ Boost" width="277" height="86">
<BR Clear>
<H2><A NAME="concept:WritablePropertyMap"></A>
Writable Property Map
</H2>
A Writable Property Map has the capability of setting the value
object associated with the given key object via the <tt>put()</tt>
function.
<h3>Refinement of</h3>
<a href="../utility/CopyConstructible.html">Copy Constructible</a>
<h3>Notation</h3>
<Table>
<TR>
<TD><tt>PMap</tt></TD>
<TD>A type that is a model of Writable Property Map.</TD>
</TR>
<TR>
<TD><tt>pmap</tt></TD>
<TD>An object of type <tt>PMap</tt>.</td>
</TR>
<TR>
<TD><tt>key</tt></TD>
<TD>An object of type <tt>boost::property_traits<PMap>::key_type</tt>.</td>
</TR>
<TR>
<TD><tt>val</tt></TD>
<TD>An object of type <tt>boost::property_traits<PMap>::value_type</tt>.</td>
</TR>
</table>
<h3>Associated Types</h3>
<table border>
<tr>
<td>Value Type</td>
<td><TT>boost::property_traits<PMap>::value_type</TT></td>
<td>
The type of the property.
</td>
</tr>
<tr>
<td>Key Type</td>
<td><TT>boost::property_traits<PMap>::key_type</TT></td>
<td>
The type of the key object used to look up the property. The property
map may be templated on the key type, in which case this typedef
can be <TT>void</TT>.
</td>
</tr>
<tr>
<td>Property Map Category </td>
<td><TT>boost::property_traits<PMap>::category</TT></td>
<td>
The category of the property: a type convertible to
<TT>writable_property_map_tag</TT>.
</td>
</tr>
</table>
<h3>Valid Expressions</h3>
<table border>
<tr>
<th>Name</th><th>Expression</th><th>Return Type</th><th>Description</th>
</tr>
<tr>
<td>Put Property Value<a href="#1">[1]</a></td>
<TD><TT>put(pmap, key, val)</TT></TD>
<TD><TT>void</TT></TD>
<TD>
Assign <TT>val</TT> to the property associated with <TT>k</TT>.
</TD>
</TR>
</TABLE>
<h3>Notes</h3>
<a name="1">[1]</a> The function <tt>put()</tt> was originally named
<tt>set()</tt>, but was changed to avoid name conflicts with the
<tt>std::set</tt> class when using a compiler (Microsoft Visual C++)
with non-standard name lookup rules. The following example demonstrates
the problem.
<pre>#include <set>
using namespace std;
namespace boost {
void set() { }
}</pre>
<h3>Concept Checking Class</h3>
<pre> template <class PMap, class Key>
struct WritablePropertyMapConcept
{
typedef typename property_traits<PMap>::key_type key_type;
typedef typename property_traits<PMap>::category Category;
typedef boost::writable_property_map_tag WritableTag;
void constraints() {
function_requires< ConvertibleConcept<Category, WritableTag> >();
put(pmap, k, val);
}
PMap pmap;
Key k;
typename property_traits<PMap>::value_type val;
};</pre>
<h3>See Also</h3>
<a href="./property_map.html">Property map concepts</a>
<br>
<HR>
<TABLE>
<TR valign=top>
<TD nowrap>Copyright © 2000</TD><TD>
<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>)
</TD></TR></TABLE>
</BODY>
</HTML>
|
