• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>Macro BOOST_TTI_TRAIT_HAS_MEMBER_FUNCTION_TEMPLATE</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 1. The Type Traits Introspection Library">
8<link rel="up" href="header/boost/tti/has_member_function_template_hpp.html" title="Header &lt;boost/tti/has_member_function_template.hpp&gt;">
9<link rel="prev" href="header/boost/tti/has_member_function_template_hpp.html" title="Header &lt;boost/tti/has_member_function_template.hpp&gt;">
10<link rel="next" href="BOOST_TT_idm45731741155232.html" title="Macro BOOST_TTI_HAS_MEMBER_FUNCTION_TEMPLATE">
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_member_function_template_hpp.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/tti/has_member_function_template_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_TT_idm45731741155232.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="refentry">
26<a name="BOOST_TT_idm45731741163504"></a><div class="titlepage"></div>
27<div class="refnamediv">
28<h2><span class="refentrytitle">Macro BOOST_TTI_TRAIT_HAS_MEMBER_FUNCTION_TEMPLATE</span></h2>
29<p>BOOST_TTI_TRAIT_HAS_MEMBER_FUNCTION_TEMPLATE — A macro which expands to a metafunction which tests whether an inner member function template with a particular name exists. </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_member_function_template_hpp.html" title="Header &lt;boost/tti/has_member_function_template.hpp&gt;">boost/tti/has_member_function_template.hpp</a>&gt;
33
34</span>BOOST_TTI_TRAIT_HAS_MEMBER_FUNCTION_TEMPLATE(trait, name, ...)</pre></div>
35<div class="refsect1">
36<a name="idm45658024502096"></a><h2>Description</h2>
37<p>BOOST_TTI_TRAIT_HAS_MEMBER_FUNCTION_TEMPLATE is a macro which expands to a metafunction. The metafunction tests whether an inner member function template with a particular name exists. The macro takes the form of BOOST_TTI_TRAIT_HAS_MEMBER_FUNCTION_TEMPLATE(trait,name,...) where</p>
38<p>trait = the name of the metafunction <br>
39 name = inner member function template name <br>
40 ... = variadic parameters.</p>
41<p>The variadic parameter(s) are either:</p>
42<p>A sequence of valid instantiations for the member function template parameters ie. 'int,long,double' etc.</p>
43<p>or</p>
44<p>A single variadic parameter which is a Boost PP array whose elements are a sequence of valid instantiations for the member function template parameters ie. '(3,(int,long,double))' etc. This form is allowed in order to be compatible with using the non-variadic form of this macro.</p>
45<p>BOOST_TTI_TRAIT_HAS_MEMBER_FUNCTION_TEMPLATE generates a metafunction called "trait" where 'trait' is the first macro parameter.</p>
46<pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">BOOST_TTI_TP_T</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">BOOST_TTI_R</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">BOOST_TTI_FS</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">BOOST_TTI_TAG</span><span class="special">&gt;</span>
47<span class="keyword">struct</span> <span class="identifier">trait</span>
48  <span class="special">{</span>
49  <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">value</span> <span class="special">=</span> <span class="identifier">unspecified</span><span class="special">;</span>
50  <span class="keyword">typedef</span> <span class="identifier">mpl</span><span class="special">::</span><span class="identifier">bool_</span><span class="special">&lt;</span><span class="keyword">true</span><span class="special">-</span><span class="identifier">or</span><span class="special">-</span><span class="keyword">false</span><span class="special">&gt;</span> <span class="identifier">type</span><span class="special">;</span>
51  <span class="special">}</span><span class="special">;</span>
52
53<span class="identifier">The</span> <span class="identifier">metafunction</span> <span class="identifier">types</span> <span class="identifier">and</span> <span class="keyword">return</span><span class="special">:</span>
54
55  <span class="identifier">BOOST_TTI_TP_T</span>   <span class="special">=</span> <span class="identifier">the</span> <span class="identifier">enclosing</span> <span class="identifier">type</span> <span class="identifier">in</span> <span class="identifier">which</span> <span class="identifier">to</span> <span class="identifier">look</span> <span class="keyword">for</span> <span class="identifier">our</span> <span class="char">'name'</span><span class="special">.</span>
56                     <span class="identifier">The</span> <span class="identifier">enclosing</span> <span class="identifier">type</span> <span class="identifier">can</span> <span class="identifier">be</span> <span class="identifier">a</span> <span class="keyword">class</span><span class="special">,</span> <span class="keyword">struct</span><span class="special">,</span> <span class="identifier">or</span> <span class="keyword">union</span><span class="special">.</span>
57                              <span class="identifier">OR</span>
58                     <span class="identifier">a</span> <span class="identifier">pointer</span> <span class="identifier">to</span> <span class="identifier">member</span> <span class="identifier">function</span> <span class="identifier">as</span> <span class="identifier">a</span> <span class="identifier">single</span> <span class="identifier">type</span>
59                     <span class="identifier">which</span> <span class="identifier">encapsulates</span> <span class="identifier">a</span> <span class="identifier">single</span> <span class="identifier">instantiation</span> <span class="identifier">of</span>
60                     <span class="identifier">the</span> <span class="identifier">member</span> <span class="identifier">function</span> <span class="keyword">template</span><span class="special">.</span>
61
62  <span class="identifier">BOOST_TTI_TP_R</span>   <span class="special">=</span> <span class="special">(</span><span class="identifier">optional</span><span class="special">)</span> <span class="identifier">the</span> <span class="keyword">return</span> <span class="identifier">type</span> <span class="identifier">of</span> <span class="identifier">the</span> <span class="identifier">member</span> <span class="identifier">function</span> <span class="keyword">template</span>
63            <span class="identifier">in</span> <span class="identifier">a</span> <span class="identifier">single</span> <span class="identifier">instantiation</span> <span class="identifier">of</span> <span class="identifier">the</span> <span class="identifier">member</span> <span class="identifier">function</span> <span class="keyword">template</span>
64            <span class="keyword">if</span> <span class="identifier">the</span> <span class="identifier">first</span> <span class="identifier">parameter</span> <span class="identifier">is</span> <span class="identifier">the</span> <span class="identifier">enclosing</span> <span class="identifier">type</span><span class="special">.</span>
65
66  <span class="identifier">BOOST_TTI_TP_FS</span>  <span class="special">=</span> <span class="special">(</span><span class="identifier">optional</span><span class="special">)</span> <span class="identifier">the</span> <span class="identifier">parameters</span> <span class="identifier">of</span> <span class="identifier">the</span> <span class="identifier">member</span> <span class="identifier">function</span> <span class="keyword">template</span> <span class="identifier">as</span> <span class="identifier">a</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">mpl</span> <span class="identifier">forward</span> <span class="identifier">sequence</span>
67            <span class="keyword">if</span> <span class="identifier">the</span> <span class="identifier">first</span> <span class="identifier">parameter</span> <span class="identifier">is</span> <span class="identifier">the</span> <span class="identifier">enclosing</span> <span class="identifier">type</span> <span class="identifier">and</span> <span class="identifier">the</span> <span class="identifier">member</span> <span class="identifier">function</span> <span class="keyword">template</span> <span class="identifier">parameters</span>
68            <span class="identifier">are</span> <span class="identifier">not</span> <span class="identifier">empty</span><span class="special">.</span> <span class="identifier">These</span> <span class="identifier">parameters</span> <span class="identifier">are</span> <span class="identifier">a</span> <span class="identifier">single</span> <span class="identifier">instantiation</span> <span class="identifier">of</span> <span class="identifier">the</span> <span class="identifier">member</span> <span class="identifier">function</span> <span class="keyword">template</span><span class="special">.</span>
69
70  <span class="identifier">BOOST_TTI_TP_TAG</span> <span class="special">=</span> <span class="special">(</span><span class="identifier">optional</span><span class="special">)</span> <span class="identifier">a</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">function_types</span> <span class="identifier">tag</span> <span class="identifier">to</span> <span class="identifier">apply</span> <span class="identifier">to</span> <span class="identifier">the</span> <span class="identifier">member</span> <span class="identifier">function</span> <span class="keyword">template</span>
71            <span class="keyword">if</span> <span class="identifier">the</span> <span class="identifier">first</span> <span class="identifier">parameter</span> <span class="identifier">is</span> <span class="identifier">the</span> <span class="identifier">enclosing</span> <span class="identifier">type</span> <span class="identifier">and</span> <span class="identifier">a</span> <span class="identifier">tag</span> <span class="identifier">is</span> <span class="identifier">needed</span><span class="special">.</span>
72
73  <span class="identifier">returns</span> <span class="special">=</span> <span class="char">'value'</span> <span class="identifier">is</span> <span class="keyword">true</span> <span class="keyword">if</span> <span class="identifier">the</span> <span class="char">'name'</span> <span class="identifier">exists</span><span class="special">,</span>
74            <span class="identifier">with</span> <span class="identifier">the</span> <span class="identifier">appropriate</span> <span class="identifier">member</span> <span class="identifier">function</span> <span class="keyword">template</span> <span class="identifier">type</span><span class="special">,</span>
75            <span class="identifier">otherwise</span> <span class="char">'value'</span> <span class="identifier">is</span> <span class="keyword">false</span><span class="special">.</span>
76</pre>
77<p> </p>
78</div>
79</div>
80<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
81<td align="left"></td>
82<td align="right"><div class="copyright-footer">Copyright © 2011-2013 Tropic Software
83      East Inc<p>
84        Distributed under the Boost Software License, Version 1.0. (See accompanying
85        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>)
86      </p>
87</div></td>
88</tr></table>
89<hr>
90<div class="spirit-nav">
91<a accesskey="p" href="header/boost/tti/has_member_function_template_hpp.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="header/boost/tti/has_member_function_template_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_TT_idm45731741155232.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
92</div>
93</body>
94</html>
95