\hypertarget{classcpphlib_1_1PPPASSIVETIMER}{\section{cpphlib.\-P\-P\-P\-A\-S\-S\-I\-V\-E\-T\-I\-M\-E\-R \-Class \-Reference}
\label{classcpphlib_1_1PPPASSIVETIMER}\index{cpphlib.\-P\-P\-P\-A\-S\-S\-I\-V\-E\-T\-I\-M\-E\-R@{cpphlib.\-P\-P\-P\-A\-S\-S\-I\-V\-E\-T\-I\-M\-E\-R}}
}


\-The timer.  


\subsection*{\-Public \-Member \-Functions}
\begin{DoxyCompactItemize}
\item 
def \hyperlink{classcpphlib_1_1PPPASSIVETIMER_ac4f9d4f5ad6a190506a060c20f742e66}{\-\_\-\-\_\-init\-\_\-\-\_\-}
\begin{DoxyCompactList}\small\item\em \-Documentation for method. \end{DoxyCompactList}\item 
def \hyperlink{classcpphlib_1_1PPPASSIVETIMER_a3e19056769ae7326d2929f3321dae658}{reset}
\item 
def \hyperlink{classcpphlib_1_1PPPASSIVETIMER_a80fb45ec46f8ca0dc1aa704a37c84611}{set}
\begin{DoxyCompactList}\small\item\em \-Documentation for method. \end{DoxyCompactList}\item 
def \hyperlink{classcpphlib_1_1PPPASSIVETIMER_acdeca6c84bd3a25d74d4c815b19582b9}{isexpired}
\begin{DoxyCompactList}\small\item\em \-Documentation for method. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{\-Public \-Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classcpphlib_1_1PPPASSIVETIMER_a6feb94bf5388659724725d08e1a899ad}{{\bfseries active}}\label{classcpphlib_1_1PPPASSIVETIMER_a6feb94bf5388659724725d08e1a899ad}

\item 
\hypertarget{classcpphlib_1_1PPPASSIVETIMER_a439d10087963bbd00a4fc2b4ba5cb0a4}{{\bfseries starttime}}\label{classcpphlib_1_1PPPASSIVETIMER_a439d10087963bbd00a4fc2b4ba5cb0a4}

\item 
\hypertarget{classcpphlib_1_1PPPASSIVETIMER_afa9802f48ca43885e7859e27fb937b3d}{{\bfseries duration}}\label{classcpphlib_1_1PPPASSIVETIMER_afa9802f48ca43885e7859e27fb937b3d}

\end{DoxyCompactItemize}


\subsection{\-Detailed \-Description}
\-The timer. 

{\bfseries } {\itshape \/} {\bfseries {\itshape \/}} \-This class provides a timer which can be used in the working loop of the control programs. \-The working loop must run continously, this way sleep can not be used, because sleep suspends the working loop, and input changes can be missed. \-This is why a timer is needed, which can be started, stopped, and restarted automatically, or triggered way, and it timeouts based on delta time. 

\subsection{\-Constructor \& \-Destructor \-Documentation}
\hypertarget{classcpphlib_1_1PPPASSIVETIMER_ac4f9d4f5ad6a190506a060c20f742e66}{\index{cpphlib\-::\-P\-P\-P\-A\-S\-S\-I\-V\-E\-T\-I\-M\-E\-R@{cpphlib\-::\-P\-P\-P\-A\-S\-S\-I\-V\-E\-T\-I\-M\-E\-R}!\-\_\-\-\_\-init\-\_\-\-\_\-@{\-\_\-\-\_\-init\-\_\-\-\_\-}}
\index{\-\_\-\-\_\-init\-\_\-\-\_\-@{\-\_\-\-\_\-init\-\_\-\-\_\-}!cpphlib::PPPASSIVETIMER@{cpphlib\-::\-P\-P\-P\-A\-S\-S\-I\-V\-E\-T\-I\-M\-E\-R}}
\subsubsection[{\-\_\-\-\_\-init\-\_\-\-\_\-}]{\setlength{\rightskip}{0pt plus 5cm}def {\bf cpphlib.\-P\-P\-P\-A\-S\-S\-I\-V\-E\-T\-I\-M\-E\-R.\-\_\-\-\_\-init\-\_\-\-\_\-} (
\begin{DoxyParamCaption}
\item[{}]{self, }
\item[{}]{duration = {\ttfamily 0}, }
\item[{}]{active = {\ttfamily \-False}}
\end{DoxyParamCaption}
)}}\label{classcpphlib_1_1PPPASSIVETIMER_ac4f9d4f5ad6a190506a060c20f742e66}


\-Documentation for method. 

{\bfseries } {\itshape \/} {\bfseries {\itshape \/}} \-When the timer is being created, you can define its timeout value, and you also can activate it immediately. \-If there is no parameters defined, the timer exists, but it is inactive. \-Its timeout value can be defined later, and it also can be activated then. 
\begin{DoxyParams}{\-Parameters}
{\em duration} & \-The time in seconds (float number also can be entered fx. 0.\-01) \\
\hline
{\em active} & \-It the parameter is {\bfseries {\itshape \-True\/}}, then timer starts immediately. \par
\par
 \begin{DoxyVerb}Short description: Constructs PPPASSIVETIMER class\end{DoxyVerb}
 \\
\hline
\end{DoxyParams}


\subsection{\-Member \-Function \-Documentation}
\hypertarget{classcpphlib_1_1PPPASSIVETIMER_acdeca6c84bd3a25d74d4c815b19582b9}{\index{cpphlib\-::\-P\-P\-P\-A\-S\-S\-I\-V\-E\-T\-I\-M\-E\-R@{cpphlib\-::\-P\-P\-P\-A\-S\-S\-I\-V\-E\-T\-I\-M\-E\-R}!isexpired@{isexpired}}
\index{isexpired@{isexpired}!cpphlib::PPPASSIVETIMER@{cpphlib\-::\-P\-P\-P\-A\-S\-S\-I\-V\-E\-T\-I\-M\-E\-R}}
\subsubsection[{isexpired}]{\setlength{\rightskip}{0pt plus 5cm}def {\bf cpphlib.\-P\-P\-P\-A\-S\-S\-I\-V\-E\-T\-I\-M\-E\-R.\-isexpired} (
\begin{DoxyParamCaption}
\item[{}]{self}
\end{DoxyParamCaption}
)}}\label{classcpphlib_1_1PPPASSIVETIMER_acdeca6c84bd3a25d74d4c815b19582b9}


\-Documentation for method. 

{\bfseries } {\itshape \/} {\bfseries {\itshape \/}} \-Timeout flag of the timer. \-Its return value is {\bfseries {\itshape \-False\/}} till the time spent since calling {\bfseries set} or {\bfseries reset} methods less than given in duration parameter. \-If the value is bigger than the return value is {\bfseries {\itshape \-True\/}}, and timer goes inactive state. \-Restarting the timer can be using {\bfseries reset}, or {\bfseries set} method with setting new timeout value. \par
\par
 \begin{DoxyVerb}Short description: Timeout flag of the timer\end{DoxyVerb}
 \hypertarget{classcpphlib_1_1PPPASSIVETIMER_a3e19056769ae7326d2929f3321dae658}{\index{cpphlib\-::\-P\-P\-P\-A\-S\-S\-I\-V\-E\-T\-I\-M\-E\-R@{cpphlib\-::\-P\-P\-P\-A\-S\-S\-I\-V\-E\-T\-I\-M\-E\-R}!reset@{reset}}
\index{reset@{reset}!cpphlib::PPPASSIVETIMER@{cpphlib\-::\-P\-P\-P\-A\-S\-S\-I\-V\-E\-T\-I\-M\-E\-R}}
\subsubsection[{reset}]{\setlength{\rightskip}{0pt plus 5cm}def {\bf cpphlib.\-P\-P\-P\-A\-S\-S\-I\-V\-E\-T\-I\-M\-E\-R.\-reset} (
\begin{DoxyParamCaption}
\item[{}]{self}
\end{DoxyParamCaption}
)}}\label{classcpphlib_1_1PPPASSIVETIMER_a3e19056769ae7326d2929f3321dae658}
\begin{DoxyVerb}Short description: It restarts the timer\end{DoxyVerb}
 \hypertarget{classcpphlib_1_1PPPASSIVETIMER_a80fb45ec46f8ca0dc1aa704a37c84611}{\index{cpphlib\-::\-P\-P\-P\-A\-S\-S\-I\-V\-E\-T\-I\-M\-E\-R@{cpphlib\-::\-P\-P\-P\-A\-S\-S\-I\-V\-E\-T\-I\-M\-E\-R}!set@{set}}
\index{set@{set}!cpphlib::PPPASSIVETIMER@{cpphlib\-::\-P\-P\-P\-A\-S\-S\-I\-V\-E\-T\-I\-M\-E\-R}}
\subsubsection[{set}]{\setlength{\rightskip}{0pt plus 5cm}def {\bf cpphlib.\-P\-P\-P\-A\-S\-S\-I\-V\-E\-T\-I\-M\-E\-R.\-set} (
\begin{DoxyParamCaption}
\item[{}]{self, }
\item[{}]{duration}
\end{DoxyParamCaption}
)}}\label{classcpphlib_1_1PPPASSIVETIMER_a80fb45ec46f8ca0dc1aa704a37c84611}


\-Documentation for method. 

{\bfseries } {\itshape \/} {\bfseries {\itshape \/}} \-It sets, or changes timing value, and restarts the timer 
\begin{DoxyParams}{\-Parameters}
{\em duration} & \-The time in seconds (float number also can be entered fx. 0.\-01) \par
\par
 \begin{DoxyVerb}Short description: It sets, or changes timing value\end{DoxyVerb}
 \\
\hline
\end{DoxyParams}


\-The documentation for this class was generated from the following file\-:\begin{DoxyCompactItemize}
\item 
cpphlib.\-py\end{DoxyCompactItemize}
