iot-firmware/lib/ITEADLIB_Arduino_Nextion-master/latex/class_nex_timer.tex

\hypertarget{class_nex_timer}{\section{Nex\+Timer Class Reference}
\label{class_nex_timer}\index{Nex\+Timer@{Nex\+Timer}}
}


{\ttfamily \#include $<$Nex\+Timer.\+h$>$}

Inheritance diagram for Nex\+Timer\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=3.000000cm]{class_nex_timer}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_nex_timer_a5cb6cdcf0d7e46723364d486d4dcd650}{Nex\+Timer} (uint8\+\_\+t pid, uint8\+\_\+t cid, const char $\ast$name)
\item 
void \hyperlink{class_nex_timer_ae6f1ae95ef40b8bc6f482185b1ec5175}{attach\+Timer} (\hyperlink{group___touch_event_ga162dea47b078e8878d10d6981a9dd0c6}{Nex\+Touch\+Event\+Cb} timer, void $\ast$ptr=N\+U\+L\+L)
\item 
void \hyperlink{class_nex_timer_a365d08df4623ce8a146e73ff9204d5cb}{detach\+Timer} (void)
\item 
bool \hyperlink{class_nex_timer_afd95e7490e28e2a36437be608f26b40e}{get\+Cycle} (uint32\+\_\+t $\ast$number)
\item 
bool \hyperlink{class_nex_timer_acf20f76949ed43f05b1c33613dabcb01}{set\+Cycle} (uint32\+\_\+t number)
\item 
bool \hyperlink{class_nex_timer_a01c146befad40fc0321891ac69e75710}{enable} (void)
\item 
bool \hyperlink{class_nex_timer_ae016d7d39ede6cf813221b26691809f1}{disable} (void)
\item 
uint32\+\_\+t \hyperlink{class_nex_timer_ae186b1c014e8bf67036f8a5faf73ae67}{Get\+\_\+cycle\+\_\+tim} (uint32\+\_\+t $\ast$number)
\item 
bool \hyperlink{class_nex_timer_a30829813c0c42680c1f7bcf5fc5b7c8b}{Set\+\_\+cycle\+\_\+tim} (uint32\+\_\+t number)
\end{DoxyCompactItemize}
\subsection*{Additional Inherited Members}


\subsection{Detailed Description}
\hyperlink{class_nex_timer}{Nex\+Timer} component.

Commonly, you want to do something after set timer cycle and enable it,and the cycle value must be greater than 50 

\subsection{Constructor \& Destructor Documentation}
\hypertarget{class_nex_timer_a5cb6cdcf0d7e46723364d486d4dcd650}{\index{Nex\+Timer@{Nex\+Timer}!Nex\+Timer@{Nex\+Timer}}
\index{Nex\+Timer@{Nex\+Timer}!Nex\+Timer@{Nex\+Timer}}
\subsubsection[{Nex\+Timer}]{\setlength{\rightskip}{0pt plus 5cm}Nex\+Timer\+::\+Nex\+Timer (
\begin{DoxyParamCaption}
\item[{uint8\+\_\+t}]{pid, }
\item[{uint8\+\_\+t}]{cid, }
\item[{const char $\ast$}]{name}
\end{DoxyParamCaption}
)}}\label{class_nex_timer_a5cb6cdcf0d7e46723364d486d4dcd650}




Constructor.


\begin{DoxyParams}{Parameters}
{\em pid} & -\/ page id. \\
\hline
{\em cid} & -\/ component id. \\
\hline
{\em name} & -\/ pointer to an unique name in range of all components. \\
\hline
\end{DoxyParams}


\subsection{Member Function Documentation}
\hypertarget{class_nex_timer_ae6f1ae95ef40b8bc6f482185b1ec5175}{\index{Nex\+Timer@{Nex\+Timer}!attach\+Timer@{attach\+Timer}}
\index{attach\+Timer@{attach\+Timer}!Nex\+Timer@{Nex\+Timer}}
\subsubsection[{attach\+Timer}]{\setlength{\rightskip}{0pt plus 5cm}void Nex\+Timer\+::attach\+Timer (
\begin{DoxyParamCaption}
\item[{{\bf Nex\+Touch\+Event\+Cb}}]{timer, }
\item[{void $\ast$}]{ptr = {\ttfamily NULL}}
\end{DoxyParamCaption}
)}}\label{class_nex_timer_ae6f1ae95ef40b8bc6f482185b1ec5175}
Attach an callback function of timer respond event.


\begin{DoxyParams}{Parameters}
{\em timer} & -\/ callback called with ptr when a timer respond event occurs. \\
\hline
{\em ptr} & -\/ parameter passed into push\mbox{[}default\+:N\+U\+L\+L\mbox{]}. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
none.
\end{DoxyReturn}
\begin{DoxyNote}{Note}
If calling this method multiply, the last call is valid. 
\end{DoxyNote}
\hypertarget{class_nex_timer_a365d08df4623ce8a146e73ff9204d5cb}{\index{Nex\+Timer@{Nex\+Timer}!detach\+Timer@{detach\+Timer}}
\index{detach\+Timer@{detach\+Timer}!Nex\+Timer@{Nex\+Timer}}
\subsubsection[{detach\+Timer}]{\setlength{\rightskip}{0pt plus 5cm}void Nex\+Timer\+::detach\+Timer (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}}\label{class_nex_timer_a365d08df4623ce8a146e73ff9204d5cb}
Detach an callback function.

\begin{DoxyReturn}{Returns}
none. 
\end{DoxyReturn}
\hypertarget{class_nex_timer_ae016d7d39ede6cf813221b26691809f1}{\index{Nex\+Timer@{Nex\+Timer}!disable@{disable}}
\index{disable@{disable}!Nex\+Timer@{Nex\+Timer}}
\subsubsection[{disable}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Timer\+::disable (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}}\label{class_nex_timer_ae016d7d39ede6cf813221b26691809f1}
contorl timer disable.


\begin{DoxyRetVals}{Return values}
{\em true} & -\/ success. \\
\hline
{\em false} & -\/ failed. \\
\hline
\end{DoxyRetVals}
\hypertarget{class_nex_timer_a01c146befad40fc0321891ac69e75710}{\index{Nex\+Timer@{Nex\+Timer}!enable@{enable}}
\index{enable@{enable}!Nex\+Timer@{Nex\+Timer}}
\subsubsection[{enable}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Timer\+::enable (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}}\label{class_nex_timer_a01c146befad40fc0321891ac69e75710}
contorl timer enable.


\begin{DoxyRetVals}{Return values}
{\em true} & -\/ success. \\
\hline
{\em false} & -\/ failed. \\
\hline
\end{DoxyRetVals}
\hypertarget{class_nex_timer_ae186b1c014e8bf67036f8a5faf73ae67}{\index{Nex\+Timer@{Nex\+Timer}!Get\+\_\+cycle\+\_\+tim@{Get\+\_\+cycle\+\_\+tim}}
\index{Get\+\_\+cycle\+\_\+tim@{Get\+\_\+cycle\+\_\+tim}!Nex\+Timer@{Nex\+Timer}}
\subsubsection[{Get\+\_\+cycle\+\_\+tim}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Timer\+::\+Get\+\_\+cycle\+\_\+tim (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_timer_ae186b1c014e8bf67036f8a5faf73ae67}
Get tim attribute of component


\begin{DoxyParams}{Parameters}
{\em number} & -\/ buffer storing data retur \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the length of the data 
\end{DoxyReturn}
\hypertarget{class_nex_timer_afd95e7490e28e2a36437be608f26b40e}{\index{Nex\+Timer@{Nex\+Timer}!get\+Cycle@{get\+Cycle}}
\index{get\+Cycle@{get\+Cycle}!Nex\+Timer@{Nex\+Timer}}
\subsubsection[{get\+Cycle}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Timer\+::get\+Cycle (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t $\ast$}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_timer_afd95e7490e28e2a36437be608f26b40e}
Get the value of timer cycle val.


\begin{DoxyParams}{Parameters}
{\em number} & -\/ an output parameter to save the value of timer cycle.\\
\hline
\end{DoxyParams}

\begin{DoxyRetVals}{Return values}
{\em true} & -\/ success. \\
\hline
{\em false} & -\/ failed. \\
\hline
\end{DoxyRetVals}
\hypertarget{class_nex_timer_a30829813c0c42680c1f7bcf5fc5b7c8b}{\index{Nex\+Timer@{Nex\+Timer}!Set\+\_\+cycle\+\_\+tim@{Set\+\_\+cycle\+\_\+tim}}
\index{Set\+\_\+cycle\+\_\+tim@{Set\+\_\+cycle\+\_\+tim}!Nex\+Timer@{Nex\+Timer}}
\subsubsection[{Set\+\_\+cycle\+\_\+tim}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Timer\+::\+Set\+\_\+cycle\+\_\+tim (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_timer_a30829813c0c42680c1f7bcf5fc5b7c8b}
Set tim attribute of component


\begin{DoxyParams}{Parameters}
{\em number} & -\/ To set up the data \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if success, false for failure 
\end{DoxyReturn}
\hypertarget{class_nex_timer_acf20f76949ed43f05b1c33613dabcb01}{\index{Nex\+Timer@{Nex\+Timer}!set\+Cycle@{set\+Cycle}}
\index{set\+Cycle@{set\+Cycle}!Nex\+Timer@{Nex\+Timer}}
\subsubsection[{set\+Cycle}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Timer\+::set\+Cycle (
\begin{DoxyParamCaption}
\item[{uint32\+\_\+t}]{number}
\end{DoxyParamCaption}
)}}\label{class_nex_timer_acf20f76949ed43f05b1c33613dabcb01}
Set the value of timer cycle val.


\begin{DoxyParams}{Parameters}
{\em number} & -\/ the value of timer cycle.\\
\hline
\end{DoxyParams}

\begin{DoxyRetVals}{Return values}
{\em true} & -\/ success. \\
\hline
{\em false} & -\/ failed.\\
\hline
\end{DoxyRetVals}
\begin{DoxyWarning}{Warning}
the cycle value must be greater than 50. 
\end{DoxyWarning}


The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
\hyperlink{_nex_timer_8h}{Nex\+Timer.\+h}\item 
\hyperlink{_nex_timer_8cpp}{Nex\+Timer.\+cpp}\end{DoxyCompactItemize}