classfv_1_1GenFunction.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>TTTT Analysis: fv::GenFunction Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">TTTT Analysis
  25. &#160;<span id="projectnumber">0.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.13 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <script type="text/javascript" src="menudata.js"></script>
  38. <script type="text/javascript" src="menu.js"></script>
  39. <script type="text/javascript">
  40. $(function() {
  41. initMenu('',true,false,'search.php','Search');
  42. $(document).ready(function() { init_search(); });
  43. });
  44. </script>
  45. <div id="main-nav"></div>
  46. <!-- window showing the filter options -->
  47. <div id="MSearchSelectWindow"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. onkeydown="return searchBox.OnSearchSelectKey(event)">
  51. </div>
  52. <!-- iframe showing the search results (closed by default) -->
  53. <div id="MSearchResultsWindow">
  54. <iframe src="javascript:void(0)" frameborder="0"
  55. name="MSearchResults" id="MSearchResults">
  56. </iframe>
  57. </div>
  58. <div id="nav-path" class="navpath">
  59. <ul>
  60. <li class="navelem"><a class="el" href="namespacefv.html">fv</a></li><li class="navelem"><a class="el" href="classfv_1_1GenFunction.html">GenFunction</a></li> </ul>
  61. </div>
  62. </div><!-- top -->
  63. <div class="header">
  64. <div class="summary">
  65. <a href="#pub-methods">Public Member Functions</a> &#124;
  66. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  67. <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
  68. <a href="#pro-static-attribs">Static Protected Attributes</a> &#124;
  69. <a href="#pri-attribs">Private Attributes</a> &#124;
  70. <a href="classfv_1_1GenFunction-members.html">List of all members</a> </div>
  71. <div class="headertitle">
  72. <div class="title">fv::GenFunction Class Reference</div> </div>
  73. </div><!--header-->
  74. <div class="contents">
  75. <p>Parent class to all Function classes.
  76. <a href="classfv_1_1GenFunction.html#details">More...</a></p>
  77. <p><code>#include &lt;<a class="el" href="value_8hpp_source.html">value.hpp</a>&gt;</code></p>
  78. <div class="dynheader">
  79. Inheritance diagram for fv::GenFunction:</div>
  80. <div class="dyncontent">
  81. <div class="center"><img src="classfv_1_1GenFunction__inherit__graph.png" border="0" usemap="#fv_1_1GenFunction_inherit__map" alt="Inheritance graph"/></div>
  82. <map name="fv_1_1GenFunction_inherit__map" id="fv_1_1GenFunction_inherit__map">
  83. <area shape="rect" id="node2" href="classfv_1_1Function_3_01R_07ArgTypes_8_8_8_08_4.html" title="In order to enable proper provenance tracking, and at the same time keep the ability to embed functio..." alt="" coords="5,80,217,107"/>
  84. </map>
  85. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  86. <table class="memberdecls">
  87. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  88. Public Member Functions</h2></td></tr>
  89. <tr class="memitem:a1a4622c277f0a4645cc597ac7e8ffad3"><td class="memItemLeft" align="right" valign="top"><a id="a1a4622c277f0a4645cc597ac7e8ffad3"></a>
  90. &#160;</td><td class="memItemRight" valign="bottom"><b>GenFunction</b> (const std::string &amp;name, const std::string &amp;impl)</td></tr>
  91. <tr class="separator:a1a4622c277f0a4645cc597ac7e8ffad3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:ac821bad86421d773af1ba36f67174eb1"><td class="memItemLeft" align="right" valign="top"><a id="ac821bad86421d773af1ba36f67174eb1"></a>
  93. std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>get_name</b> ()</td></tr>
  94. <tr class="separator:ac821bad86421d773af1ba36f67174eb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a11d3571bfc71bb231082617334fd0301"><td class="memItemLeft" align="right" valign="top"><a id="a11d3571bfc71bb231082617334fd0301"></a>
  96. std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>get_impl</b> ()</td></tr>
  97. <tr class="separator:a11d3571bfc71bb231082617334fd0301"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. </table><table class="memberdecls">
  99. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  100. Static Public Member Functions</h2></td></tr>
  101. <tr class="memitem:aecc1187b5bb9c551c104eb8478bdb567"><td class="memItemLeft" align="right" valign="top">static std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfv_1_1GenFunction.html#aecc1187b5bb9c551c104eb8478bdb567">format_code</a> (const std::string &amp;code)</td></tr>
  102. <tr class="memdesc:aecc1187b5bb9c551c104eb8478bdb567"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attempt to invoke clang-format for the purpose of printing out nicely formatted functions to the log file. <a href="#aecc1187b5bb9c551c104eb8478bdb567">More...</a><br /></td></tr>
  103. <tr class="separator:aecc1187b5bb9c551c104eb8478bdb567"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a1882aa29a5de803a366ed1e87770a4e2"><td class="memItemLeft" align="right" valign="top"><a id="a1882aa29a5de803a366ed1e87770a4e2"></a>
  105. static std::string&#160;</td><td class="memItemRight" valign="bottom"><b>summary</b> ()</td></tr>
  106. <tr class="separator:a1882aa29a5de803a366ed1e87770a4e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a2635f33d1ef39f00c07bde754c98cc6f"><td class="memTemplParams" colspan="2"><a id="a2635f33d1ef39f00c07bde754c98cc6f"></a>
  108. template&lt;typename T &gt; </td></tr>
  109. <tr class="memitem:a2635f33d1ef39f00c07bde754c98cc6f"><td class="memTemplItemLeft" align="right" valign="top">static Function&lt; T &gt; &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>register_function</b> (const std::string &amp;name, std::function&lt; T &gt; f, const std::string &amp;impl)</td></tr>
  110. <tr class="separator:a2635f33d1ef39f00c07bde754c98cc6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:ad2ff572dc8ba3059f2679cb450b719d3"><td class="memTemplParams" colspan="2"><a id="ad2ff572dc8ba3059f2679cb450b719d3"></a>
  112. template&lt;typename T &gt; </td></tr>
  113. <tr class="memitem:ad2ff572dc8ba3059f2679cb450b719d3"><td class="memTemplItemLeft" align="right" valign="top">static Function&lt; T &gt; &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>lookup_function</b> (const std::string &amp;name)</td></tr>
  114. <tr class="separator:ad2ff572dc8ba3059f2679cb450b719d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. </table><table class="memberdecls">
  116. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
  117. Static Public Attributes</h2></td></tr>
  118. <tr class="memitem:a62f52779bd4aa60fefbd842f557b1f7d"><td class="memItemLeft" align="right" valign="top"><a id="a62f52779bd4aa60fefbd842f557b1f7d"></a>
  119. static std::map&lt; const std::string, <a class="el" href="classfv_1_1GenFunction.html">GenFunction</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfv_1_1GenFunction.html#a62f52779bd4aa60fefbd842f557b1f7d">function_registry</a></td></tr>
  120. <tr class="memdesc:a62f52779bd4aa60fefbd842f557b1f7d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Static mapping of functions from their name to the object wrapper of the function. <br /></td></tr>
  121. <tr class="separator:a62f52779bd4aa60fefbd842f557b1f7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. </table><table class="memberdecls">
  123. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a>
  124. Static Protected Attributes</h2></td></tr>
  125. <tr class="memitem:a8d8c682bb591126b6396eaf78dbf3157"><td class="memItemLeft" align="right" valign="top"><a id="a8d8c682bb591126b6396eaf78dbf3157"></a>
  126. static bool&#160;</td><td class="memItemRight" valign="bottom"><b>in_register_function</b> =false</td></tr>
  127. <tr class="separator:a8d8c682bb591126b6396eaf78dbf3157"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. </table><table class="memberdecls">
  129. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
  130. Private Attributes</h2></td></tr>
  131. <tr class="memitem:a1ebce4419daac987081baf73bb8de795"><td class="memItemLeft" align="right" valign="top"><a id="a1ebce4419daac987081baf73bb8de795"></a>
  132. std::string&#160;</td><td class="memItemRight" valign="bottom"><b>name</b></td></tr>
  133. <tr class="separator:a1ebce4419daac987081baf73bb8de795"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:adafc97b5aa9684e027988bbfb5a8514b"><td class="memItemLeft" align="right" valign="top"><a id="adafc97b5aa9684e027988bbfb5a8514b"></a>
  135. std::string&#160;</td><td class="memItemRight" valign="bottom"><b>impl</b></td></tr>
  136. <tr class="separator:adafc97b5aa9684e027988bbfb5a8514b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. </table>
  138. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  139. <div class="textblock"><p>Parent class to all Function classes. </p>
  140. <p>Holds a class-level collection of all created function objects. </p>
  141. <p class="definition">Definition at line <a class="el" href="value_8hpp_source.html#l00139">139</a> of file <a class="el" href="value_8hpp_source.html">value.hpp</a>.</p>
  142. </div><h2 class="groupheader">Member Function Documentation</h2>
  143. <a id="aecc1187b5bb9c551c104eb8478bdb567"></a>
  144. <h2 class="memtitle"><span class="permalink"><a href="#aecc1187b5bb9c551c104eb8478bdb567">&#9670;&nbsp;</a></span>format_code()</h2>
  145. <div class="memitem">
  146. <div class="memproto">
  147. <table class="mlabels">
  148. <tr>
  149. <td class="mlabels-left">
  150. <table class="memname">
  151. <tr>
  152. <td class="memname">static std::string fv::GenFunction::format_code </td>
  153. <td>(</td>
  154. <td class="paramtype">const std::string &amp;&#160;</td>
  155. <td class="paramname"><em>code</em></td><td>)</td>
  156. <td></td>
  157. </tr>
  158. </table>
  159. </td>
  160. <td class="mlabels-right">
  161. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  162. </tr>
  163. </table>
  164. </div><div class="memdoc">
  165. <p>Attempt to invoke clang-format for the purpose of printing out nicely formatted functions to the log file. </p>
  166. <p>If clang-format is not present, this function just passes through the code unmodified. </p>
  167. <p class="definition">Definition at line <a class="el" href="value_8hpp_source.html#l00172">172</a> of file <a class="el" href="value_8hpp_source.html">value.hpp</a>.</p>
  168. </div>
  169. </div>
  170. <hr/>The documentation for this class was generated from the following file:<ul>
  171. <li>/home/caleb/Sources/TTTT/filval/<a class="el" href="value_8hpp_source.html">value.hpp</a></li>
  172. </ul>
  173. </div><!-- contents -->
  174. <!-- start footer part -->
  175. <hr class="footer"/><address class="footer"><small>
  176. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  177. <img class="footer" src="doxygen.png" alt="doxygen"/>
  178. </a> 1.8.13
  179. </small></address>
  180. </body>
  181. </html>