classfilval_1_1BoundValue.tex 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. \hypertarget{classfilval_1_1BoundValue}{}\section{filval\+:\+:Bound\+Value$<$ T $>$ Class Template Reference}
  2. \label{classfilval_1_1BoundValue}\index{filval\+::\+Bound\+Value$<$ T $>$@{filval\+::\+Bound\+Value$<$ T $>$}}
  3. A generic value owning only a function object.
  4. {\ttfamily \#include $<$value.\+hpp$>$}
  5. Inheritance diagram for filval\+:\+:Bound\+Value$<$ T $>$\+:
  6. \nopagebreak
  7. \begin{figure}[H]
  8. \begin{center}
  9. \leavevmode
  10. \includegraphics[width=220pt]{classfilval_1_1BoundValue__inherit__graph}
  11. \end{center}
  12. \end{figure}
  13. Collaboration diagram for filval\+:\+:Bound\+Value$<$ T $>$\+:
  14. \nopagebreak
  15. \begin{figure}[H]
  16. \begin{center}
  17. \leavevmode
  18. \includegraphics[width=243pt]{classfilval_1_1BoundValue__coll__graph}
  19. \end{center}
  20. \end{figure}
  21. \subsection*{Public Member Functions}
  22. \begin{DoxyCompactItemize}
  23. \item
  24. \hypertarget{classfilval_1_1BoundValue_a83b84653daad6bf91231bbe226d97991}{}\label{classfilval_1_1BoundValue_a83b84653daad6bf91231bbe226d97991}
  25. {\bfseries Bound\+Value} (const std\+::string \&\hyperlink{classfilval_1_1GenValue_a007e38c03ee041c2a657afa3d6e91ab1}{name}, std\+::function$<$ T()$>$ f)
  26. \end{DoxyCompactItemize}
  27. \subsection*{Protected Member Functions}
  28. \begin{DoxyCompactItemize}
  29. \item
  30. void \hyperlink{classfilval_1_1BoundValue_a90be966f85204cac57075e4ee66f2fa9}{update\+\_\+value} ()
  31. \begin{DoxyCompactList}\small\item\em Updates the internal value. \end{DoxyCompactList}\end{DoxyCompactItemize}
  32. \subsection*{Protected Attributes}
  33. \begin{DoxyCompactItemize}
  34. \item
  35. \hypertarget{classfilval_1_1BoundValue_ae95f1b20407397dfbf84c18722a01c05}{}\label{classfilval_1_1BoundValue_ae95f1b20407397dfbf84c18722a01c05}
  36. std\+::function$<$ T()$>$ {\bfseries f}
  37. \end{DoxyCompactItemize}
  38. \subsection*{Additional Inherited Members}
  39. \subsection{Detailed Description}
  40. \subsubsection*{template$<$typename T$>$\newline
  41. class filval\+::\+Bound\+Value$<$ T $>$}
  42. A generic value owning only a function object.
  43. All necessary values upon which this value depends must be bound to the function object.
  44. \subsection{Member Function Documentation}
  45. \hypertarget{classfilval_1_1BoundValue_a90be966f85204cac57075e4ee66f2fa9}{}\label{classfilval_1_1BoundValue_a90be966f85204cac57075e4ee66f2fa9}
  46. \index{filval\+::\+Bound\+Value@{filval\+::\+Bound\+Value}!update\+\_\+value@{update\+\_\+value}}
  47. \index{update\+\_\+value@{update\+\_\+value}!filval\+::\+Bound\+Value@{filval\+::\+Bound\+Value}}
  48. \subsubsection{\texorpdfstring{update\+\_\+value()}{update\_value()}}
  49. {\footnotesize\ttfamily template$<$typename T $>$ \\
  50. void \hyperlink{classfilval_1_1BoundValue}{filval\+::\+Bound\+Value}$<$ T $>$\+::update\+\_\+value (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [protected]}, {\ttfamily [virtual]}}
  51. Updates the internal value.
  52. This function should be overridden by any child class to do the actual work of updating value based on whatever rules the class chooses. Normally, this consists of geting the values from some associated \hyperlink{classfilval_1_1Value}{Value} objects, doing some calculation on them, and storing the result in value.
  53. Implements \hyperlink{classfilval_1_1DerivedValue_a74e04450a550454510329a9e6b941304}{filval\+::\+Derived\+Value$<$ T $>$}.
  54. The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
  55. \item
  56. /home/caleb/\+Sources/\+T\+T\+T\+T/filval/\hyperlink{value_8hpp}{value.\+hpp}\end{DoxyCompactItemize}