coriolis/katabatic/doc/latex/classKatabatic_1_1Observer.tex

\hypertarget{classKatabatic_1_1Observer}{}\section{Observer$<$ T $>$ Class Template Reference}
\label{classKatabatic_1_1Observer}\index{Observer$<$ T $>$@{Observer$<$ T $>$}}


\mbox{\hyperlink{classKatabatic_1_1Observer}{Observer}} Design Pattern, \mbox{\hyperlink{classKatabatic_1_1Observer}{Observer}} part.  




Inheritance diagram for Observer$<$ T $>$\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=168pt]{classKatabatic_1_1Observer__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classKatabatic_1_1Observer_ab05ec12517c51952960dd4f324499b44}{Observer}} (const T $\ast$owner)
\item 
T $\ast$ \mbox{\hyperlink{classKatabatic_1_1Observer_ac29b8f99d632058c95784fd7233b8474}{get\+Owner}} () const
\end{DoxyCompactItemize}


\subsection{Detailed Description}
\subsubsection*{template$<$typename T$>$\newline
class Katabatic\+::\+Observer$<$ T $>$}

\mbox{\hyperlink{classKatabatic_1_1Observer}{Observer}} Design Pattern, \mbox{\hyperlink{classKatabatic_1_1Observer}{Observer}} part. 

{\bfseries First, a warning about names\+:} although this class is named \mbox{\hyperlink{classKatabatic_1_1Observer}{Observer}}, it is intended to be an attribute nested inside the whole object which is indeed, the true \mbox{\hyperlink{classKatabatic_1_1Observer}{Observer}}. This nesting object is called, most of the time the {\bfseries owner} in the following. But sometimes, for simplification it may also be called the \mbox{\hyperlink{classKatabatic_1_1Observer}{Observer}}.\hypertarget{classKatabatic_1_1Observer_secImplObserver}{}\subsection{Observer Implementation Notes}\label{classKatabatic_1_1Observer_secImplObserver}
To retrieve the {\itshape owner} from the \mbox{\hyperlink{classKatabatic_1_1Observer}{Observer}} attribute, we uses the offset from the attribute in the {\itshape owner}. This offset is computed once and for all the first time the template constructor is called. 

\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classKatabatic_1_1Observer_ab05ec12517c51952960dd4f324499b44}\label{classKatabatic_1_1Observer_ab05ec12517c51952960dd4f324499b44}} 
\index{Katabatic\+::\+Observer@{Katabatic\+::\+Observer}!Observer@{Observer}}
\index{Observer@{Observer}!Katabatic\+::\+Observer@{Katabatic\+::\+Observer}}
\subsubsection{\texorpdfstring{Observer()}{Observer()}}
{\footnotesize\ttfamily \mbox{\hyperlink{classKatabatic_1_1Observer}{Observer}} (\begin{DoxyParamCaption}\item[{const T $\ast$}]{owner }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}

The owner of the oberver is needed to compute, on the first creation only, the offset of the \mbox{\hyperlink{classKatabatic_1_1Observer}{Observer}} attribute inside the {\ttfamily owner} complete object. 

\subsection{Member Function Documentation}
\mbox{\Hypertarget{classKatabatic_1_1Observer_ac29b8f99d632058c95784fd7233b8474}\label{classKatabatic_1_1Observer_ac29b8f99d632058c95784fd7233b8474}} 
\index{Katabatic\+::\+Observer@{Katabatic\+::\+Observer}!get\+Owner@{get\+Owner}}
\index{get\+Owner@{get\+Owner}!Katabatic\+::\+Observer@{Katabatic\+::\+Observer}}
\subsubsection{\texorpdfstring{get\+Owner()}{getOwner()}}
{\footnotesize\ttfamily T $\ast$ get\+Owner (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}

{\bfseries Returns\+:} The owner of the observer. 

The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
Observer.\+h\item 
Observer.\+dox\end{DoxyCompactItemize}