PageRenderTime 1824ms CodeModel.GetById 34ms RepoModel.GetById 9ms app.codeStats 0ms

/boost_1_57_0/doc/html/boost/typeindex/type_id_runtime.html

http://github.com/MisterTea/HyperNEAT
HTML | 98 lines | 95 code | 3 blank | 0 comment | 0 complexity | f9a3463eae4ac8c9d2f804b4bb2671b5 MD5 | raw file
Possible License(s): BSD-3-Clause, LGPL-3.0, GPL-3.0, GPL-2.0 
    

  1. <html>
    2. 

  2. <head>
    3. 

  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
    4. 

  4. <title>Function template type_id_runtime</title>
    5. 

  5. <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
    6. 

  6. <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
    7. 

  7. <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
    8. 

  8. <link rel="up" href="../../boost_typeindex_header_reference.html#header.boost.type_index_hpp" title="Header &lt;boost/type_index.hpp&gt;">
    9. 

  9. <link rel="prev" href="type_id_with_cvr.html" title="Function template type_id_with_cvr">
    10. 

  10. <link rel="next" href="../../BOOST_TYPE_INDEX_REGISTER_CLASS.html" title="Macro BOOST_TYPE_INDEX_REGISTER_CLASS">
    11. 

  11. </head>
    12. 

  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
    13. 

  13. <table cellpadding="2" width="100%"><tr>
    14. 

  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
    15. 

  15. <td align="center"><a href="../../../../index.html">Home</a></td>
    16. 

  16. <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
    17. 

  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
    18. 

  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
    19. 

  19. <td align="center"><a href="../../../../more/index.htm">More</a></td>
    20. 

  20. </tr></table>
    21. 

  21. <hr>
    22. 

  22. <div class="spirit-nav">
    23. 

  23. <a accesskey="p" href="type_id_with_cvr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_typeindex_header_reference.html#header.boost.type_index_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_TYPE_INDEX_REGISTER_CLASS.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
    24. 

  24. </div>
    25. 

  25. <div class="refentry">
    26. 

  26. <a name="boost.typeindex.type_id_runtime"></a><div class="titlepage"></div>
    27. 

  27. <div class="refnamediv">
    28. 

  28. <h2><span class="refentrytitle">Function template type_id_runtime</span></h2>
    29. 

  29. <p>boost::typeindex::type_id_runtime</p>
    30. 

  30. </div>
    31. 

  31. <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
    32. 

  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="../../boost_typeindex_header_reference.html#header.boost.type_index_hpp" title="Header &lt;boost/type_index.hpp&gt;">boost/type_index.hpp</a>&gt;
    33. 

  33. 

  34. </span>
    35. 

  35. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">&gt;</span> <span class="identifier">type_index</span> <span class="identifier">type_id_runtime</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&amp;</span> runtime_val<span class="special">)</span><span class="special">;</span></pre></div>
    36. 

  36. <div class="refsect1">
    37. 

  37. <a name="idp482619040"></a><h2>Description</h2>
    38. 

  38. <p>Function that works exactly like C++ typeid(rtti_val) call, but returns boost::type_index.</p>
    39. 

  39. <p>Retunrs runtime information about specified type.</p>
    40. 

  40. <p><span class="bold"><strong>Requirements:</strong></span> RTTI available or Base and Derived classes must be marked with BOOST_TYPE_INDEX_REGISTER_CLASS.</p>
    41. 

  41. <p><span class="bold"><strong>Example:</strong></span> </p>
    42. 

  42. <pre class="programlisting"><span class="keyword">struct</span> <span class="identifier">Base</span> <span class="special">{</span> <span class="keyword">virtual</span> <span class="special">~</span><span class="identifier">Base</span><span class="special">(</span><span class="special">)</span><span class="special">{</span><span class="special">}</span> <span class="special">}</span><span class="special">;</span>
    43. 

  43. <span class="keyword">struct</span> <span class="identifier">Derived</span><span class="special">:</span> <span class="keyword">public</span> <span class="identifier">Base</span>  <span class="special">{</span><span class="special">}</span><span class="special">;</span>
    44. 

  44. <span class="special">...</span>
    45. 

  45. <span class="identifier">Derived</span> <span class="identifier">d</span><span class="special">;</span>
    46. 

  46. <span class="identifier">Base</span><span class="special">&amp;</span> <span class="identifier">b</span> <span class="special">=</span> <span class="identifier">d</span><span class="special">;</span>
    47. 

  47. <span class="identifier">type_index</span> <span class="identifier">ti</span> <span class="special">=</span> <span class="identifier">type_id_runtime</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span><span class="special">;</span>
    48. 

  48. <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special">&lt;&lt;</span> <span class="identifier">ti</span><span class="special">.</span><span class="identifier">pretty_name</span><span class="special">(</span><span class="special">)</span><span class="special">;</span>  <span class="comment">// Outputs 'Derived'</span>
    49. 

  49. </pre>
    50. 

  50. <p>
    51. 

  51. 

  52. 

  53. </p>
    54. 

  54. <div class="variablelist"><table border="0" class="variablelist compact">
    55. 

  55. <colgroup>
    56. 

  56. <col align="left" valign="top">
    57. 

  57. <col>
    58. 

  58. </colgroup>
    59. 

  59. <tbody>
    60. 

  60. <tr>
    61. 

  61. <td><p><span class="term">Parameters:</span></p></td>
    62. 

  62. <td><div class="variablelist"><table border="0" class="variablelist compact">
    63. 

  63. <colgroup>
    64. 

  64. <col align="left" valign="top">
    65. 

  65. <col>
    66. 

  66. </colgroup>
    67. 

  67. <tbody><tr>
    68. 

  68. <td><p><span class="term"><code class="computeroutput">runtime_val</code></span></p></td>
    69. 

  69. <td><p>Varaible which runtime type must be returned. </p></td>
    70. 

  70. </tr></tbody>
    71. 

  71. </table></div></td>
    72. 

  72. </tr>
    73. 

  73. <tr>
    74. 

  74. <td><p><span class="term">Returns:</span></p></td>
    75. 

  75. <td><p>boost::typeindex::type_index with information about the specified variable. </p></td>
    76. 

  76. </tr>
    77. 

  77. <tr>
    78. 

  78. <td><p><span class="term">Throws:</span></p></td>
    79. 

  79. <td>Nothing. </td>
    80. 

  80. </tr>
    81. 

  81. </tbody>
    82. 

  82. </table></div>
    83. 

  83. </div>
    84. 

  84. </div>
    85. 

  85. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
    86. 

  86. <td align="left"></td>
    87. 

  87. <td align="right"><div class="copyright-footer">Copyright &#169; 2012-2014 Antony Polukhin<p>
    88. 

  88.         Distributed under the Boost Software License, Version 1.0. (See accompanying
    89. 

  89.         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>)
    90. 

  90.       </p>
    91. 

  91. </div></td>
    92. 

  92. </tr></table>
    93. 

  93. <hr>
    94. 

  94. <div class="spirit-nav">
    95. 

  95. <a accesskey="p" href="type_id_with_cvr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_typeindex_header_reference.html#header.boost.type_index_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_TYPE_INDEX_REGISTER_CLASS.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
    96. 

  96. </div>
    97. 

  97. </body>
    98. 

  98. </html>
    99. 

  99.