mirror of
https://github.com/boostorg/property_map.git
synced 2026-01-27 07:02:14 +00:00
143 lines
3.7 KiB
HTML
143 lines
3.7 KiB
HTML
<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>ReadablePropertyMap</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:ReadablePropertyMap"></A>
|
|
ReadablePropertyMap
|
|
</H2>
|
|
|
|
A ReadablePropertyMap provides read-access to the value object
|
|
associted with a given key via a call to the <tt>get()</tt> function.
|
|
The <tt>get()</tt> function returns a copy of the value object.
|
|
|
|
<h3>Refinement of</h3>
|
|
|
|
<a href="../utility/CopyConstructible.html">CopyConstructible</a>
|
|
|
|
<h3>Notation</h3>
|
|
|
|
<Table>
|
|
<TR>
|
|
<TD><tt>PMap</tt></TD>
|
|
<TD>A type that is a model of LvaluePropertyMap.</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>
|
|
|
|
</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>readable_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>Get Property Value </td>
|
|
<TD><TT>get(pmap, key)</TT></TD>
|
|
<TD><TT>value_type</TT></TD>
|
|
<TD>Lookup the property of the object identified by <TT>key</TT>.</TD>
|
|
</TR>
|
|
|
|
</TABLE>
|
|
|
|
<h3>Concept Checking Class</h3>
|
|
|
|
<pre>
|
|
template <class PMap, class Key>
|
|
struct ReadablePropertyMapConcept
|
|
{
|
|
typedef typename property_traits<PMap>::key_type key_type;
|
|
typedef typename property_traits<PMap>::category Category;
|
|
typedef boost::readable_property_map_tag ReadableTag;
|
|
void constraints() {
|
|
function_requires< ConvertibleConcept<Category, ReadableTag> >();
|
|
|
|
val = get(pmap, k);
|
|
}
|
|
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>
|
|
|
|
<h3>Design Notes</h3>
|
|
|
|
At various times the name "read-only" was considered for
|
|
this concept. However, that name is inappropriate because concepts are
|
|
inherently positive, not negative. This becomes obvious when we define
|
|
the ReadWritePropertyMap, which refines both the ReadablePropertyMap
|
|
and the WritablePropertyMap concept. It would not make much sense to
|
|
combine "read-only" and "write-only" concepts!
|
|
|
|
<br>
|
|
<HR>
|
|
<TABLE>
|
|
<TR valign=top>
|
|
<TD nowrap>Copyright © 2000</TD><TD>
|
|
<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>)
|
|
</TD></TR></TABLE>
|
|
|
|
</BODY>
|
|
</HTML>
|