classfv_1_1GenFunction.tex 4.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. \hypertarget{classfv_1_1GenFunction}{}\section{fv\+:\+:Gen\+Function Class Reference}
  2. \label{classfv_1_1GenFunction}\index{fv\+::\+Gen\+Function@{fv\+::\+Gen\+Function}}
  3. Parent class to all \hyperlink{classfv_1_1Function}{Function} classes.
  4. {\ttfamily \#include $<$value.\+hpp$>$}
  5. Inheritance diagram for fv\+:\+:Gen\+Function\+:
  6. \nopagebreak
  7. \begin{figure}[H]
  8. \begin{center}
  9. \leavevmode
  10. \includegraphics[width=239pt]{classfv_1_1GenFunction__inherit__graph}
  11. \end{center}
  12. \end{figure}
  13. \subsection*{Public Member Functions}
  14. \begin{DoxyCompactItemize}
  15. \item
  16. \hypertarget{classfv_1_1GenFunction_a1a4622c277f0a4645cc597ac7e8ffad3}{}\label{classfv_1_1GenFunction_a1a4622c277f0a4645cc597ac7e8ffad3}
  17. {\bfseries Gen\+Function} (const std\+::string \&name, const std\+::string \&impl)
  18. \item
  19. \hypertarget{classfv_1_1GenFunction_ac821bad86421d773af1ba36f67174eb1}{}\label{classfv_1_1GenFunction_ac821bad86421d773af1ba36f67174eb1}
  20. std\+::string \& {\bfseries get\+\_\+name} ()
  21. \end{DoxyCompactItemize}
  22. \subsection*{Static Public Member Functions}
  23. \begin{DoxyCompactItemize}
  24. \item
  25. static std\+::string \hyperlink{classfv_1_1GenFunction_aecc1187b5bb9c551c104eb8478bdb567}{format\+\_\+code} (const std\+::string \&code)
  26. \begin{DoxyCompactList}\small\item\em Attempt to invoke clang-\/format for the purpose of printing out nicely formatted functions to the log file. \end{DoxyCompactList}\item
  27. \hypertarget{classfv_1_1GenFunction_a1882aa29a5de803a366ed1e87770a4e2}{}\label{classfv_1_1GenFunction_a1882aa29a5de803a366ed1e87770a4e2}
  28. static std\+::string {\bfseries summary} ()
  29. \item
  30. \hypertarget{classfv_1_1GenFunction_a2635f33d1ef39f00c07bde754c98cc6f}{}\label{classfv_1_1GenFunction_a2635f33d1ef39f00c07bde754c98cc6f}
  31. {\footnotesize template$<$typename T $>$ }\\static \hyperlink{classfv_1_1Function}{Function}$<$ T $>$ \& {\bfseries register\+\_\+function} (const std\+::string \&name, std\+::function$<$ T $>$ f, const std\+::string \&impl)
  32. \end{DoxyCompactItemize}
  33. \subsection*{Static Public Attributes}
  34. \begin{DoxyCompactItemize}
  35. \item
  36. \hypertarget{classfv_1_1GenFunction_a62f52779bd4aa60fefbd842f557b1f7d}{}\label{classfv_1_1GenFunction_a62f52779bd4aa60fefbd842f557b1f7d}
  37. static std\+::map$<$ const std\+::string, \hyperlink{classfv_1_1GenFunction}{Gen\+Function} $\ast$ $>$ \hyperlink{classfv_1_1GenFunction_a62f52779bd4aa60fefbd842f557b1f7d}{function\+\_\+registry}
  38. \begin{DoxyCompactList}\small\item\em Static mapping of functions from their name to the object wrapper of the function. \end{DoxyCompactList}\end{DoxyCompactItemize}
  39. \subsection*{Static Protected Attributes}
  40. \begin{DoxyCompactItemize}
  41. \item
  42. \hypertarget{classfv_1_1GenFunction_a8d8c682bb591126b6396eaf78dbf3157}{}\label{classfv_1_1GenFunction_a8d8c682bb591126b6396eaf78dbf3157}
  43. static bool {\bfseries in\+\_\+register\+\_\+function} =false
  44. \end{DoxyCompactItemize}
  45. \subsection*{Private Attributes}
  46. \begin{DoxyCompactItemize}
  47. \item
  48. \hypertarget{classfv_1_1GenFunction_a1ebce4419daac987081baf73bb8de795}{}\label{classfv_1_1GenFunction_a1ebce4419daac987081baf73bb8de795}
  49. std\+::string {\bfseries name}
  50. \item
  51. \hypertarget{classfv_1_1GenFunction_adafc97b5aa9684e027988bbfb5a8514b}{}\label{classfv_1_1GenFunction_adafc97b5aa9684e027988bbfb5a8514b}
  52. std\+::string {\bfseries impl}
  53. \end{DoxyCompactItemize}
  54. \subsection{Detailed Description}
  55. Parent class to all \hyperlink{classfv_1_1Function}{Function} classes.
  56. Holds a class-\/level collection of all created function objects.
  57. \subsection{Member Function Documentation}
  58. \hypertarget{classfv_1_1GenFunction_aecc1187b5bb9c551c104eb8478bdb567}{}\label{classfv_1_1GenFunction_aecc1187b5bb9c551c104eb8478bdb567}
  59. \index{fv\+::\+Gen\+Function@{fv\+::\+Gen\+Function}!format\+\_\+code@{format\+\_\+code}}
  60. \index{format\+\_\+code@{format\+\_\+code}!fv\+::\+Gen\+Function@{fv\+::\+Gen\+Function}}
  61. \subsubsection{\texorpdfstring{format\+\_\+code()}{format\_code()}}
  62. {\footnotesize\ttfamily static std\+::string fv\+::\+Gen\+Function\+::format\+\_\+code (\begin{DoxyParamCaption}\item[{const std\+::string \&}]{code }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [static]}}
  63. Attempt to invoke clang-\/format for the purpose of printing out nicely formatted functions to the log file.
  64. If clang-\/format is not present, this function just passes through the code unmodified.
  65. The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
  66. \item
  67. /home/caleb/\+Sources/\+T\+T\+T\+T/filval/\hyperlink{value_8hpp}{value.\+hpp}\end{DoxyCompactItemize}