named_parameter.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Struct template named_parameter</title>
  5. <link rel="stylesheet" href="../../boostbook.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
  7. <link rel="home" href="../../index.html" title="Boost.Test">
  8. <link rel="up" href="../../header/boost/test/utils/named_params_hpp.html" title="Header &lt;boost/test/utils/named_params.hpp&gt;">
  9. <link rel="prev" href="keyword.html" title="Struct template keyword">
  10. <link rel="next" href="named_parameter_combine.html" title="Struct template named_parameter_combine">
  11. </head>
  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13. <table cellpadding="2" width="100%"><tr>
  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15. <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16. <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19. <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20. </tr></table>
  21. <hr>
  22. <div class="spirit-nav">
  23. <a accesskey="p" href="keyword.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../header/boost/test/utils/named_params_hpp.html"><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="named_parameter_combine.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="refentry">
  26. <a name="boost.nfp.named_parameter"></a><div class="titlepage"></div>
  27. <div class="refnamediv">
  28. <h2><span class="refentrytitle">Struct template named_parameter</span></h2>
  29. <p>boost::nfp::named_parameter</p>
  30. </div>
  31. <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32. <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="../../header/boost/test/utils/named_params_hpp.html" title="Header &lt;boost/test/utils/named_params.hpp&gt;">boost/test/utils/named_params.hpp</a>&gt;
  33. </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> unique_id<span class="special">,</span> <span class="keyword">typename</span> RefType<span class="special">&gt;</span>
  34. <span class="keyword">struct</span> <a class="link" href="named_parameter.html" title="Struct template named_parameter">named_parameter</a> <span class="special">{</span>
  35. <span class="comment">// types</span>
  36. <span class="keyword">typedef</span> <span class="identifier">T</span> <a name="boost.nfp.named_parameter.data_type"></a><span class="identifier">data_type</span><span class="special">;</span>
  37. <span class="keyword">typedef</span> <span class="identifier">RefType</span> <a name="boost.nfp.named_parameter.ref_type"></a><span class="identifier">ref_type</span><span class="special">;</span>
  38. <span class="keyword">typedef</span> <span class="identifier">unique_id</span> <a name="boost.nfp.named_parameter.id"></a><span class="identifier">id</span><span class="special">;</span>
  39. <span class="comment">// <a class="link" href="named_parameter.html#boost.nfp.named_parameterconstruct-copy-destruct">construct/copy/destruct</a></span>
  40. <span class="keyword">explicit</span> <a class="link" href="named_parameter.html#idm46279112194992-bb"><span class="identifier">named_parameter</span></a><span class="special">(</span><span class="identifier">ref_type</span><span class="special">)</span><span class="special">;</span>
  41. <a class="link" href="named_parameter.html#idm46279112193744-bb"><span class="identifier">named_parameter</span></a><span class="special">(</span><a class="link" href="named_parameter.html" title="Struct template named_parameter">named_parameter</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  42. <span class="comment">// <a class="link" href="named_parameter.html#idm46279112218272-bb">public member functions</a></span>
  43. <span class="identifier">ref_type</span> <a class="link" href="named_parameter.html#idm46279112217712-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><a class="link" href="keyword.html" title="Struct template keyword">keyword</a><span class="special">&lt;</span> <span class="identifier">unique_id</span><span class="special">,</span> <span class="keyword">true</span> <span class="special">&gt;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  44. <span class="identifier">ref_type</span> <a class="link" href="named_parameter.html#idm46279112215616-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><a class="link" href="keyword.html" title="Struct template keyword">keyword</a><span class="special">&lt;</span> <span class="identifier">unique_id</span><span class="special">,</span> <span class="keyword">false</span> <span class="special">&gt;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  45. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> UnknownId<span class="special">&gt;</span>
  46. <a class="link" href="nil.html" title="Struct nil">nil</a> <a class="link" href="named_parameter.html#idm46279112213520-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><a class="link" href="keyword.html" title="Struct template keyword">keyword</a><span class="special">&lt;</span> <span class="identifier">UnknownId</span><span class="special">,</span> <span class="keyword">false</span> <span class="special">&gt;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  47. <span class="keyword">bool</span> <a class="link" href="named_parameter.html#idm46279112210448-bb"><span class="identifier">has</span></a><span class="special">(</span><a class="link" href="keyword.html" title="Struct template keyword">keyword</a><span class="special">&lt;</span> <span class="identifier">unique_id</span><span class="special">,</span> <span class="keyword">false</span> <span class="special">&gt;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  48. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> UnknownId<span class="special">&gt;</span> <span class="keyword">bool</span> <a class="link" href="named_parameter.html#idm46279112208352-bb"><span class="identifier">has</span></a><span class="special">(</span><a class="link" href="keyword.html" title="Struct template keyword">keyword</a><span class="special">&lt;</span> <span class="identifier">UnknownId</span><span class="special">,</span> <span class="keyword">false</span> <span class="special">&gt;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  49. <span class="keyword">void</span> <a class="link" href="named_parameter.html#idm46279112205408-bb"><span class="identifier">erase</span></a><span class="special">(</span><a class="link" href="keyword.html" title="Struct template keyword">keyword</a><span class="special">&lt;</span> <span class="identifier">unique_id</span><span class="special">,</span> <span class="keyword">false</span> <span class="special">&gt;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  50. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> UnknownId<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="named_parameter.html#idm46279112203312-bb"><span class="identifier">erase</span></a><span class="special">(</span><a class="link" href="keyword.html" title="Struct template keyword">keyword</a><span class="special">&lt;</span> <span class="identifier">UnknownId</span><span class="special">,</span> <span class="keyword">false</span> <span class="special">&gt;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  51. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Visitor<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="named_parameter.html#idm46279112200368-bb"><span class="identifier">apply_to</span></a><span class="special">(</span><span class="identifier">Visitor</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  52. <a class="link" href="named_parameter_combine.html" title="Struct template named_parameter_combine">named_parameter_combine</a><span class="special">&lt;</span> <span class="identifier">NP</span><span class="special">,</span> <a class="link" href="named_parameter.html" title="Struct template named_parameter">named_parameter</a><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">unique_id</span><span class="special">,</span> <span class="identifier">RefType</span> <span class="special">&gt;</span> <span class="special">&gt;</span>
  53. <a class="link" href="named_parameter.html#idm46279112197712-bb"><span class="keyword">operator</span><span class="special">,</span></a><span class="special">(</span><span class="identifier">NP</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  54. <span class="special">}</span><span class="special">;</span></pre></div>
  55. <div class="refsect1">
  56. <a name="idm45313881595232"></a><h2>Description</h2>
  57. <div class="refsect2">
  58. <a name="idm45313881594816"></a><h3>
  59. <a name="boost.nfp.named_parameterconstruct-copy-destruct"></a><code class="computeroutput">named_parameter</code>
  60. public
  61. construct/copy/destruct</h3>
  62. <div class="orderedlist"><ol class="orderedlist" type="1">
  63. <li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46279112194992-bb"></a><span class="identifier">named_parameter</span><span class="special">(</span><span class="identifier">ref_type</span> v<span class="special">)</span><span class="special">;</span></pre></li>
  64. <li class="listitem"><pre class="literallayout"><a name="idm46279112193744-bb"></a><span class="identifier">named_parameter</span><span class="special">(</span><a class="link" href="named_parameter.html" title="Struct template named_parameter">named_parameter</a> <span class="keyword">const</span> <span class="special">&amp;</span> np<span class="special">)</span><span class="special">;</span></pre></li>
  65. </ol></div>
  66. </div>
  67. <div class="refsect2">
  68. <a name="idm45313881581616"></a><h3>
  69. <a name="idm46279112218272-bb"></a><code class="computeroutput">named_parameter</code> public member functions</h3>
  70. <div class="orderedlist"><ol class="orderedlist" type="1">
  71. <li class="listitem"><pre class="literallayout"><span class="identifier">ref_type</span> <a name="idm46279112217712-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><a class="link" href="keyword.html" title="Struct template keyword">keyword</a><span class="special">&lt;</span> <span class="identifier">unique_id</span><span class="special">,</span> <span class="keyword">true</span> <span class="special">&gt;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  72. <li class="listitem"><pre class="literallayout"><span class="identifier">ref_type</span> <a name="idm46279112215616-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><a class="link" href="keyword.html" title="Struct template keyword">keyword</a><span class="special">&lt;</span> <span class="identifier">unique_id</span><span class="special">,</span> <span class="keyword">false</span> <span class="special">&gt;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  73. <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> UnknownId<span class="special">&gt;</span> <a class="link" href="nil.html" title="Struct nil">nil</a> <a name="idm46279112213520-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><a class="link" href="keyword.html" title="Struct template keyword">keyword</a><span class="special">&lt;</span> <span class="identifier">UnknownId</span><span class="special">,</span> <span class="keyword">false</span> <span class="special">&gt;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  74. <li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idm46279112210448-bb"></a><span class="identifier">has</span><span class="special">(</span><a class="link" href="keyword.html" title="Struct template keyword">keyword</a><span class="special">&lt;</span> <span class="identifier">unique_id</span><span class="special">,</span> <span class="keyword">false</span> <span class="special">&gt;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  75. <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> UnknownId<span class="special">&gt;</span> <span class="keyword">bool</span> <a name="idm46279112208352-bb"></a><span class="identifier">has</span><span class="special">(</span><a class="link" href="keyword.html" title="Struct template keyword">keyword</a><span class="special">&lt;</span> <span class="identifier">UnknownId</span><span class="special">,</span> <span class="keyword">false</span> <span class="special">&gt;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  76. <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idm46279112205408-bb"></a><span class="identifier">erase</span><span class="special">(</span><a class="link" href="keyword.html" title="Struct template keyword">keyword</a><span class="special">&lt;</span> <span class="identifier">unique_id</span><span class="special">,</span> <span class="keyword">false</span> <span class="special">&gt;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  77. <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> UnknownId<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm46279112203312-bb"></a><span class="identifier">erase</span><span class="special">(</span><a class="link" href="keyword.html" title="Struct template keyword">keyword</a><span class="special">&lt;</span> <span class="identifier">UnknownId</span><span class="special">,</span> <span class="keyword">false</span> <span class="special">&gt;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  78. <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Visitor<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idm46279112200368-bb"></a><span class="identifier">apply_to</span><span class="special">(</span><span class="identifier">Visitor</span> <span class="special">&amp;</span> V<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  79. <li class="listitem"><pre class="literallayout"><a class="link" href="named_parameter_combine.html" title="Struct template named_parameter_combine">named_parameter_combine</a><span class="special">&lt;</span> <span class="identifier">NP</span><span class="special">,</span> <a class="link" href="named_parameter.html" title="Struct template named_parameter">named_parameter</a><span class="special">&lt;</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">unique_id</span><span class="special">,</span> <span class="identifier">RefType</span> <span class="special">&gt;</span> <span class="special">&gt;</span>
  80. <a name="idm46279112197712-bb"></a><span class="keyword">operator</span><span class="special">,</span><span class="special">(</span><span class="identifier">NP</span> <span class="keyword">const</span> <span class="special">&amp;</span> np<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li>
  81. </ol></div>
  82. </div>
  83. </div>
  84. </div>
  85. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  86. <td align="left"></td>
  87. <td align="right"><div class="copyright-footer">Copyright &#169; 2001-2019 Boost.Test
  88. contributors<p>
  89. Distributed under the Boost Software License, Version 1.0. (See accompanying
  90. 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>)
  91. </p>
  92. </div></td>
  93. </tr></table>
  94. <hr>
  95. <div class="spirit-nav">
  96. <a accesskey="p" href="keyword.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../header/boost/test/utils/named_params_hpp.html"><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="named_parameter_combine.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  97. </div>
  98. </body>
  99. </html>