File: ref_property_map.html

package info (click to toggle)
boost1.35 1.35.0-5
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 203,856 kB
  • ctags: 337,867
  • sloc: cpp: 938,683; xml: 56,847; ansic: 41,589; python: 18,999; sh: 11,566; makefile: 664; perl: 494; yacc: 456; asm: 353; csh: 6
file content (114 lines) | stat: -rw-r--r-- 2,092 bytes parent folder | download
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
<HTML>
<!--
  -- Copyright 2006 The Trustees of Indiana University
  --
  -- Use, modification and distribution is subject to the Boost Software
  -- License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  -- http://www.boost.org/LICENSE_1_0.txt)
  --
  -->
<Head>
<Title>Reference Property Map</Title>
<BODY BGCOLOR="#ffffff" LINK="#0000ee" TEXT="#000000" VLINK="#551a8b" 
	ALINK="#ff0000"> 
<IMG SRC="../../boost.png" 
     ALT="C++ Boost" width="277" height="86"> 

<BR Clear>

<H2><A NAME="sec:identity-property-map"></A>
</h2>
<PRE>
template &lt;typename KeyType, typename ValueType&gt;
class ref_property_map
</PRE>

This property map wraps a reference to some particular object, and
returns that reference whenever a key object is input.

<H3>Where Defined</H3>

<P>
<a href="../../boost/property_map.hpp"><TT>boost/property_map.hpp</TT></a>

<h3>Model of</h3>

<a href="./LvaluePropertyMap.html">Lvalue Property Map</a>

<h3>Associated Types</h3>

<table border>
<tr>
<th>Type</th><th>Description</th>
</tr>

<tr>
<td><tt>
boost::property_traits&lt;ref_property_map&gt;::value_type
</tt></td>
<td>
This type is the <tt>ValueType</tt> with which the template instantiated.
</td>
</tr>

<tr>
<td><tt>
boost::property_traits&lt;ref_property_map&gt;::key_type
</tt></td>
<td>
This type is the <tt>KeyType</tt> with which the template instantiated.
</td>
</tr>

<tr>
<td><tt>
boost::property_traits&lt;ref_property_map&gt;::category
</tt></td>
<td>
This type is <tt>boost::lvalue_property_map_tag</tt>.
</td>
</tr>

</table>

<h3>Member Functions</h3>

<table border>
<tr>
<th>Member</th><th>Description</th>
</tr>


<tr>
<td><tt>
ref_property_map(ValueType&amp; v)
</tt></td>
<td>
The constructor for ref_property_map is provided the reference that
the property map will return when queried.
</td>
</tr>

<tr>
<td><tt>
ref_property_map(const ref_property_map&amp; x)
</tt></td>
<td>
Copy constructor.
</td>
</tr>

<tr>
<td><tt>
ValueType&amp; operator[](KeyType const&amp;) const
</tt></td>
<td>
Returns the contained reference.
</td>
</tr>

</table>


</BODY>
</HTML>