property_map/doc/static_property_map.html

128 lines
2.5 KiB
HTML

<HTML>
<!--
Copyright 2006, 2013 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>Static 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:static-property-map"></A>
</h2>
<PRE>
template &lt;typename ValueType, typename KeyType = void&gt;
class static_property_map
</PRE>
This property map wraps a copy of some particular object, and
returns a copy of that object whenever a key object is input.
<H3>Where Defined</H3>
<P>
<a href="../../../boost/property_map/property_map.hpp"><TT>boost/property_map/property_map.hpp</TT></a>
<h3>Model of</h3>
<a href="./ReadablePropertyMap.html">Readable Property Map</a>
<h3>Associated Types</h3>
<table border>
<tr>
<th>Type</th><th>Description</th>
</tr>
<tr>
<td><tt>
boost::property_traits&lt;static_property_map&gt;::value_type
</tt></td>
<td>
This type is the <tt>ValueType</tt> with which the template was instantiated.
</td>
</tr>
<tr>
<td><tt>
boost::property_traits&lt;static_property_map&gt;::key_type
</tt></td>
<td>
This type is the <tt>KeyType</tt> with which the template was instantiated.
</td>
</tr>
<tr>
<td><tt>
boost::property_traits&lt;static_property_map&gt;::category
</tt></td>
<td>
This type is <tt>boost::readable_property_map_tag</tt>.
</td>
</tr>
</table>
<h3>Member Functions</h3>
<table border>
<tr>
<th>Member</th><th>Description</th>
</tr>
<tr>
<td><tt>
static_property_map(ValueType v)
</tt></td>
<td>
The constructor for static_property_map is provided the value that
the property map will return when queried.
</td>
</tr>
<tr>
<td><tt>
static_property_map(const static_property_map&amp; x)
</tt></td>
<td>
Copy constructor.
</td>
</tr>
<tr>
<td><pre>
template &lt;typename T&gt;
ValueType&amp; operator[](T) const
</pre></td>
<td>
Returns the contained value by copy.
</td>
</tr>
</table>
<h3>Non-Member Functions</h3>
<table border>
<tr><td><pre>
template &lt;typename KeyType, typename ValueType&gt;
static_property_map&lt;KeyType, ValueType&gt;
make_static_property_map(const ValueType&amp; value);
</pre></td>
<td>Returns a <tt>static_property_map</tt> with the given key type initialized to the given value.</td>
</tr>
</table>
</BODY>
</HTML>