classfv_1_1Pair.tex 3.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. \hypertarget{classfv_1_1Pair}{}\section{fv\+:\+:Pair$<$ T1, T2 $>$ Class Template Reference}
  2. \label{classfv_1_1Pair}\index{fv\+::\+Pair$<$ T1, T2 $>$@{fv\+::\+Pair$<$ T1, T2 $>$}}
  3. Creates a std\+::pair type from a two other \hyperlink{classfv_1_1Value}{Value} objects.
  4. {\ttfamily \#include $<$value.\+hpp$>$}
  5. Inheritance diagram for fv\+:\+:Pair$<$ T1, T2 $>$\+:
  6. \nopagebreak
  7. \begin{figure}[H]
  8. \begin{center}
  9. \leavevmode
  10. \includegraphics[width=203pt]{classfv_1_1Pair__inherit__graph}
  11. \end{center}
  12. \end{figure}
  13. Collaboration diagram for fv\+:\+:Pair$<$ T1, T2 $>$\+:
  14. \nopagebreak
  15. \begin{figure}[H]
  16. \begin{center}
  17. \leavevmode
  18. \includegraphics[width=203pt]{classfv_1_1Pair__coll__graph}
  19. \end{center}
  20. \end{figure}
  21. \subsection*{Public Member Functions}
  22. \begin{DoxyCompactItemize}
  23. \item
  24. \hypertarget{classfv_1_1Pair_a1846e7f1e986a2fb47e388330cdd8ff3}{}\label{classfv_1_1Pair_a1846e7f1e986a2fb47e388330cdd8ff3}
  25. {\bfseries Pair} (\hyperlink{classfv_1_1Value}{Value}$<$ T1 $>$ $\ast$value1, \hyperlink{classfv_1_1Value}{Value}$<$ T2 $>$ $\ast$value2, const std\+::string alias=\char`\"{}\char`\"{})
  26. \item
  27. \hypertarget{classfv_1_1Pair_a9fad00f2ff4488f118455e1dcdd1c11a}{}\label{classfv_1_1Pair_a9fad00f2ff4488f118455e1dcdd1c11a}
  28. {\bfseries Pair} (const std\+::string \&label1, const std\+::string \&label2, const std\+::string alias=\char`\"{}\char`\"{})
  29. \end{DoxyCompactItemize}
  30. \subsection*{Protected Member Functions}
  31. \begin{DoxyCompactItemize}
  32. \item
  33. void \hyperlink{classfv_1_1Pair_ab3225f03f49240fc1547a5005f57b864}{update\+\_\+value} ()
  34. \begin{DoxyCompactList}\small\item\em Updates the internal value. \end{DoxyCompactList}\end{DoxyCompactItemize}
  35. \subsection*{Protected Attributes}
  36. \begin{DoxyCompactItemize}
  37. \item
  38. \hypertarget{classfv_1_1Pair_a6b7cd0e47693fbff80539b3a7df0ecab}{}\label{classfv_1_1Pair_a6b7cd0e47693fbff80539b3a7df0ecab}
  39. std\+::pair$<$ \hyperlink{classfv_1_1Value}{Value}$<$ T1 $>$ $\ast$, \hyperlink{classfv_1_1Value}{Value}$<$ T2 $>$ $\ast$$>$ {\bfseries value\+\_\+pair}
  40. \end{DoxyCompactItemize}
  41. \subsection*{Additional Inherited Members}
  42. \subsection{Detailed Description}
  43. \subsubsection*{template$<$typename T1, typename T2$>$\newline
  44. class fv\+::\+Pair$<$ T1, T2 $>$}
  45. Creates a std\+::pair type from a two other \hyperlink{classfv_1_1Value}{Value} objects.
  46. \subsection{Member Function Documentation}
  47. \hypertarget{classfv_1_1Pair_ab3225f03f49240fc1547a5005f57b864}{}\label{classfv_1_1Pair_ab3225f03f49240fc1547a5005f57b864}
  48. \index{fv\+::\+Pair@{fv\+::\+Pair}!update\+\_\+value@{update\+\_\+value}}
  49. \index{update\+\_\+value@{update\+\_\+value}!fv\+::\+Pair@{fv\+::\+Pair}}
  50. \subsubsection{\texorpdfstring{update\+\_\+value()}{update\_value()}}
  51. {\footnotesize\ttfamily template$<$typename T1 , typename T2 $>$ \\
  52. void \hyperlink{classfv_1_1Pair}{fv\+::\+Pair}$<$ T1, T2 $>$\+::update\+\_\+value (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [protected]}, {\ttfamily [virtual]}}
  53. Updates the internal value.
  54. 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{classfv_1_1Value}{Value} objects, doing some calculation on them, and storing the result in value.
  55. Implements \hyperlink{classfv_1_1DerivedValue_ae59e80a98eb74b95d8961bfe12ee5ec2}{fv\+::\+Derived\+Value$<$ std\+::pair$<$ T1, T2 $>$ $>$}.
  56. The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
  57. \item
  58. /home/caleb/\+Sources/\+T\+T\+T\+T/filval/\hyperlink{value_8hpp}{value.\+hpp}\end{DoxyCompactItemize}