| <HTML> |
| <!-- |
| Copyright (c) Jeremy Siek, Lie-Quan Lee, and Andrew Lumsdaine 2000 |
| |
| Distributed under 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>Associative Property Map Adaptor</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:associative-property-map"></A> |
| </h2> |
| <PRE> |
| associative_property_map<UniquePairAssociativeContainer> |
| </PRE> |
| |
| <P> |
| This property map is an adaptor that converts any type that is a model |
| of both <a |
| href="http://www.sgi.com/tech/stl/PairAssociativeContainer.html">Pair |
| Associative Container</a> and <a |
| href="http://www.sgi.com/tech/stl/UniqueAssociativeContainer.html">Unique |
| Associative Container</a> such as <a |
| href="http://www.sgi.com/tech/stl/Map.html"><tt>std::map</tt></a> into |
| a mutable <a href="./LvaluePropertyMap.html">Lvalue Property Map</a>. |
| Note that the adaptor only retains a reference to the container, so |
| the lifetime of the container must encompass the use of the adaptor. |
| </P> |
| |
| <h3>Example</h3> |
| |
| <a href="../example/example1.cpp">example1.cpp</a>: |
| <pre>#include <iostream> |
| #include <map> |
| #include <string> |
| #include <boost/property_map/property_map.hpp> |
| |
| |
| template <typename AddressMap> |
| void foo(AddressMap address) |
| { |
| typedef typename boost::property_traits<AddressMap>::value_type value_type; |
| typedef typename boost::property_traits<AddressMap>::key_type key_type; |
| |
| value_type old_address, new_address; |
| key_type fred = "Fred"; |
| old_address = get(address, fred); |
| new_address = "384 Fitzpatrick Street"; |
| put(address, fred, new_address); |
| |
| key_type joe = "Joe"; |
| value_type& joes_address = address[joe]; |
| joes_address = "325 Cushing Avenue"; |
| } |
| |
| int |
| main() |
| { |
| std::map<std::string, std::string> name2address; |
| boost::associative_property_map< std::map<std::string, std::string> > |
| address_map(name2address); |
| |
| name2address.insert(make_pair(std::string("Fred"), |
| std::string("710 West 13th Street"))); |
| name2address.insert(make_pair(std::string("Joe"), |
| std::string("710 West 13th Street"))); |
| |
| foo(address_map); |
| |
| for (std::map<std::string, std::string>::iterator i = name2address.begin(); |
| i != name2address.end(); ++i) |
| std::cout << i->first << ": " << i->second << "\n"; |
| |
| return EXIT_SUCCESS; |
| }</pre> |
| |
| <H3>Where Defined</H3> |
| |
| <P> |
| <a href="../../../boost/property_map/property_map.hpp"><TT>boost/property_map/property_map.hpp</TT></a> |
| |
| <p> |
| <H3>Model Of</H3> |
| |
| <a href="./LvaluePropertyMap.html">Lvalue Property Map</a> |
| |
| <P> |
| |
| <H3>Template Parameters</H3> |
| |
| <P> |
| |
| <TABLE border> |
| <TR> |
| <th>Parameter</th><th>Description</th><th>Default</th> |
| </tr> |
| |
| |
| <TR> |
| <TD><TT>UniquePairAssociativeContainer</TT></TD> |
| <TD>Must be a model of both <a |
| href="http://www.sgi.com/tech/stl/PairAssociativeContainer.html">Pair |
| Associative Container</a> and <a |
| href="http://www.sgi.com/tech/stl/UniqueAssociativeContainer.html">Unique |
| Associative Container</a> .</TD> |
| <TD> </td> |
| </tr> |
| |
| </TABLE> |
| <P> |
| |
| <H3>Members</H3> |
| |
| <P> |
| In addition to the methods and functions required by <a |
| href="./LvaluePropertyMap.html">Lvalue Property Map</a>, this |
| class has the following members. |
| |
| <hr> |
| |
| <pre> |
| property_traits<associative_property_map>::value_type |
| </pre> |
| This is the same type as |
| <TT>UniquePairAssociativeContainer::data_type</TT>. |
| |
| <hr> |
| |
| <pre> |
| associative_property_map() |
| </pre> |
| Default Constructor. |
| |
| <pre> |
| associative_property_map(UniquePairAssociativeContainer& c) |
| </pre> |
| Constructor. |
| |
| <hr> |
| |
| <pre> |
| data_type& operator[](const key_type& k) const |
| </pre> |
| The operator bracket for property access. |
| The <TT>key_type</TT> and |
| <TT>data_type</TT> types are from the typedefs inside of |
| <TT>UniquePairAssociativeContainer</TT>. |
| |
| <hr> |
| |
| <h3>Non-Member functions</h3> |
| |
| <hr> |
| |
| <pre> |
| template <typename UniquePairAssociativeContainer> |
| associative_property_map<UniquePairAssociativeContainer> |
| make_assoc_property_map(UniquePairAssociativeContainer& c); |
| </pre> |
| A function for conveniently creating an associative property map. |
| |
| |
| |
| <hr> |
| |
| |
| <br> |
| <HR> |
| <TABLE> |
| <TR valign=top> |
| <TD nowrap>Copyright © 2002</TD><TD> |
| <a HREF="http://www.boost.org/people/jeremy_siek.htm">Jeremy Siek</a>, |
| Indiana University (<A |
| HREF="mailto:jsiek@osl.iu.edu">jsiek@osl.iu.edu</A>)<br> |
| <A HREF="http://www.boost.org/people/liequan_lee.htm">Lie-Quan Lee</A>, Indiana University (<A HREF="mailto:llee1@osl.iu.edu">llee1@osl.iu.edu</A>)<br> |
| <A HREF="http://www.osl.iu.edu/~lums">Andrew Lumsdaine</A>, |
| Indiana University (<A |
| HREF="mailto:lums@osl.iu.edu">lums@osl.iu.edu</A>) |
| </TD></TR></TABLE> |
| |
| </BODY> |
| </HTML> |