classfilval_1_1ObservedValue.tex 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. \hypertarget{classfilval_1_1ObservedValue}{}\section{filval\+:\+:Observed\+Value$<$ T $>$ Class Template Reference}
  2. \label{classfilval_1_1ObservedValue}\index{filval\+::\+Observed\+Value$<$ T $>$@{filval\+::\+Observed\+Value$<$ T $>$}}
  3. A generic, observed, value.
  4. {\ttfamily \#include $<$value.\+hpp$>$}
  5. Inheritance diagram for filval\+:\+:Observed\+Value$<$ T $>$\+:
  6. \nopagebreak
  7. \begin{figure}[H]
  8. \begin{center}
  9. \leavevmode
  10. \includegraphics[width=229pt]{classfilval_1_1ObservedValue__inherit__graph}
  11. \end{center}
  12. \end{figure}
  13. Collaboration diagram for filval\+:\+:Observed\+Value$<$ T $>$\+:
  14. \nopagebreak
  15. \begin{figure}[H]
  16. \begin{center}
  17. \leavevmode
  18. \includegraphics[width=229pt]{classfilval_1_1ObservedValue__coll__graph}
  19. \end{center}
  20. \end{figure}
  21. \subsection*{Public Member Functions}
  22. \begin{DoxyCompactItemize}
  23. \item
  24. \hypertarget{classfilval_1_1ObservedValue_a0bce29e7d100187548c7ba3ef80f9c89}{}\label{classfilval_1_1ObservedValue_a0bce29e7d100187548c7ba3ef80f9c89}
  25. {\bfseries Observed\+Value} (const std\+::string \&\hyperlink{classfilval_1_1GenValue_a007e38c03ee041c2a657afa3d6e91ab1}{name}, T $\ast$val\+\_\+ref)
  26. \item
  27. \hypertarget{classfilval_1_1ObservedValue_af38ebd68326b8282a9f769f89021e46a}{}\label{classfilval_1_1ObservedValue_af38ebd68326b8282a9f769f89021e46a}
  28. T \& \hyperlink{classfilval_1_1ObservedValue_af38ebd68326b8282a9f769f89021e46a}{get\+\_\+value} ()
  29. \begin{DoxyCompactList}\small\item\em Calculate, if necessary, and return the value held by this object. \end{DoxyCompactList}\end{DoxyCompactItemize}
  30. \subsection*{Private Member Functions}
  31. \begin{DoxyCompactItemize}
  32. \item
  33. void \hyperlink{classfilval_1_1ObservedValue_a68c4fc1eb89682c7b16d2d46874f5421}{\+\_\+reset} ()
  34. \begin{DoxyCompactList}\small\item\em Mark the internal value as invalid. \end{DoxyCompactList}\end{DoxyCompactItemize}
  35. \subsection*{Private Attributes}
  36. \begin{DoxyCompactItemize}
  37. \item
  38. \hypertarget{classfilval_1_1ObservedValue_ad943ba7c4ff0d7d601d961c563f01826}{}\label{classfilval_1_1ObservedValue_ad943ba7c4ff0d7d601d961c563f01826}
  39. T $\ast$ {\bfseries val\+\_\+ref}
  40. \end{DoxyCompactItemize}
  41. \subsection*{Additional Inherited Members}
  42. \subsection{Detailed Description}
  43. \subsubsection*{template$<$typename T$>$\newline
  44. class filval\+::\+Observed\+Value$<$ T $>$}
  45. A generic, observed, value.
  46. An \hyperlink{classfilval_1_1ObservedValue}{Observed\+Value} is the interface to your dataset. Upon creation, an \hyperlink{classfilval_1_1ObservedValue}{Observed\+Value} is given a pointer to an object of type T. When an observation is loaded into memory, the value at the location referenced by that pointer must be updated with the associated data from that observation. This is the responsibility of whatever \hyperlink{classfilval_1_1DataSet}{Data\+Set} implementation is being used. This object then will read that data and return it when requested.
  47. \subsection{Member Function Documentation}
  48. \hypertarget{classfilval_1_1ObservedValue_a68c4fc1eb89682c7b16d2d46874f5421}{}\label{classfilval_1_1ObservedValue_a68c4fc1eb89682c7b16d2d46874f5421}
  49. \index{filval\+::\+Observed\+Value@{filval\+::\+Observed\+Value}!\+\_\+reset@{\+\_\+reset}}
  50. \index{\+\_\+reset@{\+\_\+reset}!filval\+::\+Observed\+Value@{filval\+::\+Observed\+Value}}
  51. \subsubsection{\texorpdfstring{\+\_\+reset()}{\_reset()}}
  52. {\footnotesize\ttfamily template$<$typename T$>$ \\
  53. void \hyperlink{classfilval_1_1ObservedValue}{filval\+::\+Observed\+Value}$<$ T $>$\+::\+\_\+reset (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [private]}, {\ttfamily [virtual]}}
  54. Mark the internal value as invalid.
  55. This is needed for \hyperlink{classfilval_1_1DerivedValue}{Derived\+Value} to force a recalculation of the internal value when a new observation is loaded into memory. It is called automatically for all \hyperlink{classfilval_1_1GenValue}{Gen\+Value} objects when reset is called.
  56. Implements \hyperlink{classfilval_1_1GenValue_ae9d5bd9fde2d04f6cd05d5b901a8c78a}{filval\+::\+Gen\+Value}.
  57. The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
  58. \item
  59. /home/caleb/\+Sources/\+T\+T\+T\+T/filval/\hyperlink{value_8hpp}{value.\+hpp}\end{DoxyCompactItemize}