doc/html/boost/intrusive/pack_options.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Struct template pack_options</title>
   6 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   8 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   9 <link rel="up" href="../../intrusive/reference.html#header.boost.intrusive.pack_options_hpp" title="Header &lt;boost/intrusive/pack_options.hpp&gt;">
  10 <link rel="prev" href="void_pointer.html" title="Struct template void_pointer">
  11 <link rel="next" href="../../BOOST_IN_idm45581297846512.html" title="Macro BOOST_INTRUSIVE_OPTION_TYPE">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  16 <td align="center"><a href="../../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <a accesskey="p" href="void_pointer.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../intrusive/reference.html#header.boost.intrusive.pack_options_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../BOOST_IN_idm45581297846512.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.intrusive.pack_options"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Struct template pack_options</span></h2>
  30 <p>boost::intrusive::pack_options</p>
  31 </div>
  32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  33 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../intrusive/reference.html#header.boost.intrusive.pack_options_hpp" title="Header &lt;boost/intrusive/pack_options.hpp&gt;">boost/intrusive/pack_options.hpp</a>&gt;
  34
  35 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> DefaultOptions<span class="special">,</span> <span class="keyword">class</span> <span class="special">...</span> Options<span class="special">&gt;</span>
  36 <span class="keyword">struct</span> <a class="link" href="pack_options.html" title="Struct template pack_options">pack_options</a> <span class="special">{</span>
  37   <span class="comment">// types</span>
  38   <span class="keyword">typedef</span> <span class="identifier">unspecified_type</span> <a name="boost.intrusive.pack_options.type"></a><span class="identifier">type</span><span class="special">;</span>
  39 <span class="special">}</span><span class="special">;</span></pre></div>
  40 <div class="refsect1">
  41 <a name="id-1.3.20.42.22.4.4"></a><h2>Description</h2>
  42 <p>This class is a utility that takes:</p>
  43 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  44 <li class="listitem"><p>a default options class defining initial static constant and typedefs</p></li>
  45 <li class="listitem"><p>several options defined with BOOST_INTRUSIVE_OPTION_CONSTANT and BOOST_INTRUSIVE_OPTION_TYPE</p></li>
  46 </ul></div>
  47 <p>
  48 </p>
  49 <p>and packs them together in a new type that defines all options as member typedefs or static constant values. Given options of form:</p>
  50 <pre class="programlisting"><span class="identifier">BOOST_INTRUSIVE_OPTION_TYPE</span><span class="special">(</span><span class="identifier">my_pointer</span><span class="special">,</span> <span class="identifier">VoidPointer</span><span class="special">,</span> <span class="identifier">VoidPointer</span><span class="special">,</span> <span class="identifier">my_pointer_type</span><span class="special">)</span>
  51 <span class="identifier">BOOST_INTRUSIVE_OPTION_CONSTANT</span><span class="special">(</span><span class="identifier">incremental</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">,</span> <span class="identifier">Enabled</span><span class="special">,</span> <span class="identifier">is_incremental</span><span class="special">)</span>
  52 </pre>
  53 <p>the following expression</p>
  54 <pre class="programlisting"><span class="keyword">struct</span> <span class="identifier">default_options</span>
  55 <span class="special">{</span>
  56   <span class="keyword">typedef</span> <span class="keyword">long</span>      <span class="identifier">int_type</span><span class="special">;</span>
  57   <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">int</span>  <span class="identifier">int_constant</span> <span class="special">=</span> <span class="special">-</span><span class="number">1</span><span class="special">;</span>
  58 <span class="special">}</span><span class="special">;</span>
  59
  60 <span class="identifier">pack_options</span><span class="special">&lt;</span> <span class="identifier">default_options</span><span class="special">,</span> <span class="identifier">my_pointer</span><span class="special">&lt;</span><span class="keyword">void</span><span class="special">*</span><span class="special">&gt;</span><span class="special">,</span> <span class="identifier">incremental</span><span class="special">&lt;</span><span class="keyword">true</span><span class="special">&gt;</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>
  61 </pre>
  62 <p>will create a type that will contain the following typedefs/constants</p>
  63 <pre class="programlisting"><span class="keyword">struct</span> <span class="identifier">unspecified_type</span>
  64 <span class="special">{</span>
  65    <span class="comment">//Default options</span>
  66    <span class="keyword">typedef</span> <span class="keyword">long</span>      <span class="identifier">int_type</span><span class="special">;</span>
  67    <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">int</span>  <span class="identifier">int_constant</span>  <span class="special">=</span> <span class="special">-</span><span class="number">1</span><span class="special">;</span>
  68
  69    <span class="comment">//Packed options (will ovewrite any default option)</span>
  70    <span class="keyword">typedef</span> <span class="keyword">void</span><span class="special">*</span>     <span class="identifier">my_pointer_type</span><span class="special">;</span>
  71    <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">bool</span> <span class="identifier">is_incremental</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">;</span>
  72 <span class="special">}</span><span class="special">;</span>
  73 </pre>
  74 <p>If an option is specified in the default options argument and later redefined as an option, the last definition will prevail. </p>
  75 </div>
  76 </div>
  77 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  78 <td align="left"></td>
  79 <td align="right"><div class="copyright-footer">Copyright &#169; 2005 Olaf Krzikalla<br>Copyright &#169; 2006-2015 Ion Gaztanaga<p>
  80         Distributed under the Boost Software License, Version 1.0. (See accompanying
  81         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  82       </p>
  83 </div></td>
  84 </tr></table>
  85 <hr>
  86 <div class="spirit-nav">
  87 <a accesskey="p" href="void_pointer.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../intrusive/reference.html#header.boost.intrusive.pack_options_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../BOOST_IN_idm45581297846512.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  88 </div>
  89 </body>
  90 </html>