BOOST_TTI_TRAIT_HAS_TYPE.html 6.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Macro BOOST_TTI_TRAIT_HAS_TYPE</title>
  5. <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
  7. <link rel="home" href="index.html" title="Chapter&#160;1.&#160;The Type Traits Introspection Library">
  8. <link rel="up" href="header/boost/tti/has_type_hpp.html" title="Header &lt;boost/tti/has_type.hpp&gt;">
  9. <link rel="prev" href="header/boost/tti/has_type_hpp.html" title="Header &lt;boost/tti/has_type.hpp&gt;">
  10. <link rel="next" href="BOOST_TTI_HAS_TYPE.html" title="Macro BOOST_TTI_HAS_TYPE">
  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="header/boost/tti/has_type_hpp.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/tti/has_type_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="BOOST_TTI_HAS_TYPE.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="refentry">
  26. <a name="BOOST_TTI_TRAIT_HAS_TYPE"></a><div class="titlepage"></div>
  27. <div class="refnamediv">
  28. <h2><span class="refentrytitle">Macro BOOST_TTI_TRAIT_HAS_TYPE</span></h2>
  29. <p>BOOST_TTI_TRAIT_HAS_TYPE</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/tti/has_type_hpp.html" title="Header &lt;boost/tti/has_type.hpp&gt;">boost/tti/has_type.hpp</a>&gt;
  33. </span>BOOST_TTI_TRAIT_HAS_TYPE(trait, name)</pre></div>
  34. <div class="refsect1">
  35. <a name="idm45456560396352"></a><h2>Description</h2>
  36. <p>BOOST_TTI_TRAIT_HAS_TYPE is a macro which expands to a metafunction. The metafunction tests whether an inner type with a particular name exists and, optionally, whether a lambda expression invoked with the inner type is true or not.</p>
  37. <p>trait = the name of the metafunction within the tti namespace.</p>
  38. <p>name = the name of the inner type.</p>
  39. <p>generates a metafunction called "trait" where 'trait' is the macro parameter. template&lt;class BOOST_TTI_TP_T,class BOOST_TTI_TP_U&gt;
  40. struct trait
  41. {
  42. static const value = unspecified;
  43. typedef mpl::bool_&lt;true-or-false&gt; type;
  44. };
  45. The metafunction types and return:
  46. BOOST_TTI_TP_T = the enclosing type in which to look for our 'name'.
  47. BOOST_TTI_TP_U = (optional) An optional template parameter, defaulting to a marker type.
  48. If specified it is an MPL lambda expression which is invoked
  49. with the inner type found and must return a constant boolean
  50. value.
  51. returns = 'value' depends on whether or not the optional BOOST_TTI_TP_U is specified.
  52. If BOOST_TTI_TP_U is not specified, then 'value' is true if the 'name' type
  53. exists within the enclosing type BOOST_TTI_TP_T; otherwise 'value' is false.
  54. If BOOST_TTI_TP_U is specified , then 'value' is true if the 'name' type exists
  55. within the enclosing type BOOST_TTI_TP_T and the lambda expression as specified
  56. by BOOST_TTI_TP_U, invoked by passing the actual inner type of 'name', returns
  57. a 'value' of true; otherwise 'value' is false.
  58. The action taken with BOOST_TTI_TP_U occurs only when the 'name' type exists
  59. within the enclosing type BOOST_TTI_TP_T.
  60. </p>
  61. <p>Example usage:</p>
  62. <p>BOOST_TTI_TRAIT_HAS_TYPE(LookFor,MyType) generates the metafunction LookFor in the current scope to look for an inner type called MyType.</p>
  63. <p>LookFor&lt;EnclosingType&gt;::value is true if MyType is an inner type of EnclosingType, otherwise false.</p>
  64. <p>LookFor&lt;EnclosingType,ALambdaExpression&gt;::value is true if MyType is an inner type of EnclosingType and invoking ALambdaExpression with the inner type returns a value of true, otherwise false.</p>
  65. <p>A popular use of the optional MPL lambda expression is to check whether the type found is the same</p>
  66. <p>as another type, when the type found is a typedef. In that case our example would be:</p>
  67. <p>LookFor&lt;EnclosingType,boost::is_same&lt;_,SomeOtherType&gt; &gt;::value is true if MyType is an inner type of EnclosingType and is the same type as SomeOtherType. </p>
  68. </div>
  69. </div>
  70. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  71. <td align="left"></td>
  72. <td align="right"><div class="copyright-footer">Copyright &#169; 2011-2013 Tropic Software
  73. East Inc<p>
  74. Distributed under the Boost Software License, Version 1.0. (See accompanying
  75. 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>)
  76. </p>
  77. </div></td>
  78. </tr></table>
  79. <hr>
  80. <div class="spirit-nav">
  81. <a accesskey="p" href="header/boost/tti/has_type_hpp.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/tti/has_type_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="BOOST_TTI_HAS_TYPE.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  82. </div>
  83. </body>
  84. </html>