classfv_1_1WrapperVector.tex 4.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. \hypertarget{classfv_1_1WrapperVector}{}\section{fv\+:\+:Wrapper\+Vector$<$ T $>$ Class Template Reference}
  2. \label{classfv_1_1WrapperVector}\index{fv\+::\+Wrapper\+Vector$<$ T $>$@{fv\+::\+Wrapper\+Vector$<$ T $>$}}
  3. A std\+::vector wrapper around a C-\/style array.
  4. {\ttfamily \#include $<$value.\+hpp$>$}
  5. Inheritance diagram for fv\+:\+:Wrapper\+Vector$<$ T $>$\+:
  6. \nopagebreak
  7. \begin{figure}[H]
  8. \begin{center}
  9. \leavevmode
  10. \includegraphics[width=211pt]{classfv_1_1WrapperVector__inherit__graph}
  11. \end{center}
  12. \end{figure}
  13. Collaboration diagram for fv\+:\+:Wrapper\+Vector$<$ T $>$\+:
  14. \nopagebreak
  15. \begin{figure}[H]
  16. \begin{center}
  17. \leavevmode
  18. \includegraphics[width=350pt]{classfv_1_1WrapperVector__coll__graph}
  19. \end{center}
  20. \end{figure}
  21. \subsection*{Public Member Functions}
  22. \begin{DoxyCompactItemize}
  23. \item
  24. \hypertarget{classfv_1_1WrapperVector_a2bc64820fe35a31f58971c8ed3c28a7a}{}\label{classfv_1_1WrapperVector_a2bc64820fe35a31f58971c8ed3c28a7a}
  25. {\bfseries Wrapper\+Vector} (\hyperlink{classfv_1_1Value}{Value}$<$ int $>$ $\ast$size, \hyperlink{classfv_1_1Value}{Value}$<$ T $\ast$$>$ $\ast$data, const std\+::string \&alias=\char`\"{}\char`\"{})
  26. \item
  27. \hypertarget{classfv_1_1WrapperVector_a07359f0cfd9e1656827375bb68f0f0a4}{}\label{classfv_1_1WrapperVector_a07359f0cfd9e1656827375bb68f0f0a4}
  28. {\bfseries Wrapper\+Vector} (const std\+::string \&label\+\_\+size, const std\+::string \&label\+\_\+data, const std\+::string \&alias=\char`\"{}\char`\"{})
  29. \end{DoxyCompactItemize}
  30. \subsection*{Private Member Functions}
  31. \begin{DoxyCompactItemize}
  32. \item
  33. void \hyperlink{classfv_1_1WrapperVector_a2ee99bc4425642d209df7b48ee2ada95}{update\+\_\+value} ()
  34. \begin{DoxyCompactList}\small\item\em Updates the internal value. \end{DoxyCompactList}\end{DoxyCompactItemize}
  35. \subsection*{Private Attributes}
  36. \begin{DoxyCompactItemize}
  37. \item
  38. \hypertarget{classfv_1_1WrapperVector_a10ede4104152047ed9561cf53760c56a}{}\label{classfv_1_1WrapperVector_a10ede4104152047ed9561cf53760c56a}
  39. \hyperlink{classfv_1_1Value}{Value}$<$ int $>$ $\ast$ {\bfseries size}
  40. \item
  41. \hypertarget{classfv_1_1WrapperVector_a28f084653f04d7c3b02b0deca2e425a7}{}\label{classfv_1_1WrapperVector_a28f084653f04d7c3b02b0deca2e425a7}
  42. \hyperlink{classfv_1_1Value}{Value}$<$ T $\ast$ $>$ $\ast$ {\bfseries data}
  43. \end{DoxyCompactItemize}
  44. \subsection*{Additional Inherited Members}
  45. \subsection{Detailed Description}
  46. \subsubsection*{template$<$typename T$>$\newline
  47. class fv\+::\+Wrapper\+Vector$<$ T $>$}
  48. A std\+::vector wrapper around a C-\/style array.
  49. In order to make some of the higher-\/level \hyperlink{classfv_1_1Value}{Value} types easier to work with, it is a good idea to wrap all arrays in the original data source with std\+::vector objects. To do this, it is necessary to supply both a \hyperlink{classfv_1_1Value}{Value} object containing the array itself as well as another \hyperlink{classfv_1_1Value}{Value} object containing the size of that array. Currently, update\+\_\+value will simply copy the contents of the array into the interally held vector.
  50. \subsection{Member Function Documentation}
  51. \hypertarget{classfv_1_1WrapperVector_a2ee99bc4425642d209df7b48ee2ada95}{}\label{classfv_1_1WrapperVector_a2ee99bc4425642d209df7b48ee2ada95}
  52. \index{fv\+::\+Wrapper\+Vector@{fv\+::\+Wrapper\+Vector}!update\+\_\+value@{update\+\_\+value}}
  53. \index{update\+\_\+value@{update\+\_\+value}!fv\+::\+Wrapper\+Vector@{fv\+::\+Wrapper\+Vector}}
  54. \subsubsection{\texorpdfstring{update\+\_\+value()}{update\_value()}}
  55. {\footnotesize\ttfamily template$<$typename T $>$ \\
  56. void \hyperlink{classfv_1_1WrapperVector}{fv\+::\+Wrapper\+Vector}$<$ T $>$\+::update\+\_\+value (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [private]}, {\ttfamily [virtual]}}
  57. Updates the internal value.
  58. 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.
  59. Implements \hyperlink{classfv_1_1DerivedValue_ae59e80a98eb74b95d8961bfe12ee5ec2}{fv\+::\+Derived\+Value$<$ std\+::vector$<$ T $>$ $>$}.
  60. Here is the call graph for this function\+:
  61. \nopagebreak
  62. \begin{figure}[H]
  63. \begin{center}
  64. \leavevmode
  65. \includegraphics[width=338pt]{classfv_1_1WrapperVector_a2ee99bc4425642d209df7b48ee2ada95_cgraph}
  66. \end{center}
  67. \end{figure}
  68. The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
  69. \item
  70. /home/caleb/\+Sources/\+T\+T\+T\+T/filval/\hyperlink{value_8hpp}{value.\+hpp}\end{DoxyCompactItemize}