mirror of
https://github.com/itead/ITEADLIB_Arduino_Nextion.git
synced 2026-03-03 00:34:01 +01:00
275 lines
12 KiB
TeX
Executable File
275 lines
12 KiB
TeX
Executable File
\hypertarget{class_nex_waveform}{\section{Nex\+Waveform Class Reference}
|
|
\label{class_nex_waveform}\index{Nex\+Waveform@{Nex\+Waveform}}
|
|
}
|
|
|
|
|
|
{\ttfamily \#include $<$Nex\+Waveform.\+h$>$}
|
|
|
|
Inheritance diagram for Nex\+Waveform\+:\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[height=2.000000cm]{class_nex_waveform}
|
|
\end{center}
|
|
\end{figure}
|
|
\subsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\hyperlink{class_nex_waveform_a4f18ca5050823e874d526141c8595514}{Nex\+Waveform} (uint8\+\_\+t pid, uint8\+\_\+t cid, const char $\ast$name)
|
|
\item
|
|
bool \hyperlink{class_nex_waveform_a5b04ea7397b784947b845e2a03fc77e4}{add\+Value} (uint8\+\_\+t ch, uint8\+\_\+t number)
|
|
\item
|
|
uint32\+\_\+t \hyperlink{class_nex_waveform_a66cec3c4d0d1a769dbf50c8092cc01d1}{Get\+\_\+background\+\_\+color\+\_\+bco} (uint32\+\_\+t $\ast$number)
|
|
\item
|
|
bool \hyperlink{class_nex_waveform_aefec5eb25ee698c8c940c9190d60b696}{Set\+\_\+background\+\_\+color\+\_\+bco} (uint32\+\_\+t number)
|
|
\item
|
|
uint32\+\_\+t \hyperlink{class_nex_waveform_ac5a6622e9004600f24b12e60ebb6b984}{Get\+\_\+grid\+\_\+color\+\_\+gdc} (uint32\+\_\+t $\ast$number)
|
|
\item
|
|
bool \hyperlink{class_nex_waveform_ab396211f736824a0210446e68dc3edf4}{Set\+\_\+grid\+\_\+color\+\_\+gdc} (uint32\+\_\+t number)
|
|
\item
|
|
uint32\+\_\+t \hyperlink{class_nex_waveform_ad5c4968c81d4941a08841cbaf217c631}{Get\+\_\+grid\+\_\+width\+\_\+gdw} (uint32\+\_\+t $\ast$number)
|
|
\item
|
|
bool \hyperlink{class_nex_waveform_a41cb6d8b1ff6c309d1c4e8a1f73304fe}{Set\+\_\+grid\+\_\+width\+\_\+gdw} (uint32\+\_\+t number)
|
|
\item
|
|
uint32\+\_\+t \hyperlink{class_nex_waveform_a87f6baf5a7a9c52f54281865e757d9a3}{Get\+\_\+grid\+\_\+height\+\_\+gdh} (uint32\+\_\+t $\ast$number)
|
|
\item
|
|
bool \hyperlink{class_nex_waveform_a85e776a5347c22efd9abe9bb8cfdbddb}{Set\+\_\+grid\+\_\+height\+\_\+gdh} (uint32\+\_\+t number)
|
|
\item
|
|
uint32\+\_\+t \hyperlink{class_nex_waveform_a09e36144f65c73b21edcfd5caff8a914}{Get\+\_\+channel\+\_\+0\+\_\+color\+\_\+pco0} (uint32\+\_\+t $\ast$number)
|
|
\item
|
|
bool \hyperlink{class_nex_waveform_ade323e0eae3b5058a76245e5ac97b037}{Set\+\_\+channel\+\_\+0\+\_\+color\+\_\+pco0} (uint32\+\_\+t number)
|
|
\end{DoxyCompactItemize}
|
|
\subsection*{Additional Inherited Members}
|
|
|
|
|
|
\subsection{Detailed Description}
|
|
\hyperlink{class_nex_waveform}{Nex\+Waveform} component.
|
|
|
|
\subsection{Constructor \& Destructor Documentation}
|
|
\hypertarget{class_nex_waveform_a4f18ca5050823e874d526141c8595514}{\index{Nex\+Waveform@{Nex\+Waveform}!Nex\+Waveform@{Nex\+Waveform}}
|
|
\index{Nex\+Waveform@{Nex\+Waveform}!Nex\+Waveform@{Nex\+Waveform}}
|
|
\subsubsection[{Nex\+Waveform}]{\setlength{\rightskip}{0pt plus 5cm}Nex\+Waveform\+::\+Nex\+Waveform (
|
|
\begin{DoxyParamCaption}
|
|
\item[{uint8\+\_\+t}]{pid, }
|
|
\item[{uint8\+\_\+t}]{cid, }
|
|
\item[{const char $\ast$}]{name}
|
|
\end{DoxyParamCaption}
|
|
)}}\label{class_nex_waveform_a4f18ca5050823e874d526141c8595514}
|
|
|
|
|
|
|
|
|
|
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_waveform_a5b04ea7397b784947b845e2a03fc77e4}{\index{Nex\+Waveform@{Nex\+Waveform}!add\+Value@{add\+Value}}
|
|
\index{add\+Value@{add\+Value}!Nex\+Waveform@{Nex\+Waveform}}
|
|
\subsubsection[{add\+Value}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Waveform\+::add\+Value (
|
|
\begin{DoxyParamCaption}
|
|
\item[{uint8\+\_\+t}]{ch, }
|
|
\item[{uint8\+\_\+t}]{number}
|
|
\end{DoxyParamCaption}
|
|
)}}\label{class_nex_waveform_a5b04ea7397b784947b845e2a03fc77e4}
|
|
Add value to show.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em ch} & -\/ channel of waveform(0-\/3). \\
|
|
\hline
|
|
{\em number} & -\/ the value of waveform.\\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
\begin{DoxyRetVals}{Return values}
|
|
{\em true} & -\/ success. \\
|
|
\hline
|
|
{\em false} & -\/ failed. \\
|
|
\hline
|
|
\end{DoxyRetVals}
|
|
\hypertarget{class_nex_waveform_a66cec3c4d0d1a769dbf50c8092cc01d1}{\index{Nex\+Waveform@{Nex\+Waveform}!Get\+\_\+background\+\_\+color\+\_\+bco@{Get\+\_\+background\+\_\+color\+\_\+bco}}
|
|
\index{Get\+\_\+background\+\_\+color\+\_\+bco@{Get\+\_\+background\+\_\+color\+\_\+bco}!Nex\+Waveform@{Nex\+Waveform}}
|
|
\subsubsection[{Get\+\_\+background\+\_\+color\+\_\+bco}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Waveform\+::\+Get\+\_\+background\+\_\+color\+\_\+bco (
|
|
\begin{DoxyParamCaption}
|
|
\item[{uint32\+\_\+t $\ast$}]{number}
|
|
\end{DoxyParamCaption}
|
|
)}}\label{class_nex_waveform_a66cec3c4d0d1a769dbf50c8092cc01d1}
|
|
Get bco 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_waveform_a09e36144f65c73b21edcfd5caff8a914}{\index{Nex\+Waveform@{Nex\+Waveform}!Get\+\_\+channel\+\_\+0\+\_\+color\+\_\+pco0@{Get\+\_\+channel\+\_\+0\+\_\+color\+\_\+pco0}}
|
|
\index{Get\+\_\+channel\+\_\+0\+\_\+color\+\_\+pco0@{Get\+\_\+channel\+\_\+0\+\_\+color\+\_\+pco0}!Nex\+Waveform@{Nex\+Waveform}}
|
|
\subsubsection[{Get\+\_\+channel\+\_\+0\+\_\+color\+\_\+pco0}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Waveform\+::\+Get\+\_\+channel\+\_\+0\+\_\+color\+\_\+pco0 (
|
|
\begin{DoxyParamCaption}
|
|
\item[{uint32\+\_\+t $\ast$}]{number}
|
|
\end{DoxyParamCaption}
|
|
)}}\label{class_nex_waveform_a09e36144f65c73b21edcfd5caff8a914}
|
|
Get pco0 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_waveform_ac5a6622e9004600f24b12e60ebb6b984}{\index{Nex\+Waveform@{Nex\+Waveform}!Get\+\_\+grid\+\_\+color\+\_\+gdc@{Get\+\_\+grid\+\_\+color\+\_\+gdc}}
|
|
\index{Get\+\_\+grid\+\_\+color\+\_\+gdc@{Get\+\_\+grid\+\_\+color\+\_\+gdc}!Nex\+Waveform@{Nex\+Waveform}}
|
|
\subsubsection[{Get\+\_\+grid\+\_\+color\+\_\+gdc}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Waveform\+::\+Get\+\_\+grid\+\_\+color\+\_\+gdc (
|
|
\begin{DoxyParamCaption}
|
|
\item[{uint32\+\_\+t $\ast$}]{number}
|
|
\end{DoxyParamCaption}
|
|
)}}\label{class_nex_waveform_ac5a6622e9004600f24b12e60ebb6b984}
|
|
Get gdc 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_waveform_a87f6baf5a7a9c52f54281865e757d9a3}{\index{Nex\+Waveform@{Nex\+Waveform}!Get\+\_\+grid\+\_\+height\+\_\+gdh@{Get\+\_\+grid\+\_\+height\+\_\+gdh}}
|
|
\index{Get\+\_\+grid\+\_\+height\+\_\+gdh@{Get\+\_\+grid\+\_\+height\+\_\+gdh}!Nex\+Waveform@{Nex\+Waveform}}
|
|
\subsubsection[{Get\+\_\+grid\+\_\+height\+\_\+gdh}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Waveform\+::\+Get\+\_\+grid\+\_\+height\+\_\+gdh (
|
|
\begin{DoxyParamCaption}
|
|
\item[{uint32\+\_\+t $\ast$}]{number}
|
|
\end{DoxyParamCaption}
|
|
)}}\label{class_nex_waveform_a87f6baf5a7a9c52f54281865e757d9a3}
|
|
Get gdh 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_waveform_ad5c4968c81d4941a08841cbaf217c631}{\index{Nex\+Waveform@{Nex\+Waveform}!Get\+\_\+grid\+\_\+width\+\_\+gdw@{Get\+\_\+grid\+\_\+width\+\_\+gdw}}
|
|
\index{Get\+\_\+grid\+\_\+width\+\_\+gdw@{Get\+\_\+grid\+\_\+width\+\_\+gdw}!Nex\+Waveform@{Nex\+Waveform}}
|
|
\subsubsection[{Get\+\_\+grid\+\_\+width\+\_\+gdw}]{\setlength{\rightskip}{0pt plus 5cm}uint32\+\_\+t Nex\+Waveform\+::\+Get\+\_\+grid\+\_\+width\+\_\+gdw (
|
|
\begin{DoxyParamCaption}
|
|
\item[{uint32\+\_\+t $\ast$}]{number}
|
|
\end{DoxyParamCaption}
|
|
)}}\label{class_nex_waveform_ad5c4968c81d4941a08841cbaf217c631}
|
|
Get gdw 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_waveform_aefec5eb25ee698c8c940c9190d60b696}{\index{Nex\+Waveform@{Nex\+Waveform}!Set\+\_\+background\+\_\+color\+\_\+bco@{Set\+\_\+background\+\_\+color\+\_\+bco}}
|
|
\index{Set\+\_\+background\+\_\+color\+\_\+bco@{Set\+\_\+background\+\_\+color\+\_\+bco}!Nex\+Waveform@{Nex\+Waveform}}
|
|
\subsubsection[{Set\+\_\+background\+\_\+color\+\_\+bco}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Waveform\+::\+Set\+\_\+background\+\_\+color\+\_\+bco (
|
|
\begin{DoxyParamCaption}
|
|
\item[{uint32\+\_\+t}]{number}
|
|
\end{DoxyParamCaption}
|
|
)}}\label{class_nex_waveform_aefec5eb25ee698c8c940c9190d60b696}
|
|
Set bco 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_waveform_ade323e0eae3b5058a76245e5ac97b037}{\index{Nex\+Waveform@{Nex\+Waveform}!Set\+\_\+channel\+\_\+0\+\_\+color\+\_\+pco0@{Set\+\_\+channel\+\_\+0\+\_\+color\+\_\+pco0}}
|
|
\index{Set\+\_\+channel\+\_\+0\+\_\+color\+\_\+pco0@{Set\+\_\+channel\+\_\+0\+\_\+color\+\_\+pco0}!Nex\+Waveform@{Nex\+Waveform}}
|
|
\subsubsection[{Set\+\_\+channel\+\_\+0\+\_\+color\+\_\+pco0}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Waveform\+::\+Set\+\_\+channel\+\_\+0\+\_\+color\+\_\+pco0 (
|
|
\begin{DoxyParamCaption}
|
|
\item[{uint32\+\_\+t}]{number}
|
|
\end{DoxyParamCaption}
|
|
)}}\label{class_nex_waveform_ade323e0eae3b5058a76245e5ac97b037}
|
|
Set pco0 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_waveform_ab396211f736824a0210446e68dc3edf4}{\index{Nex\+Waveform@{Nex\+Waveform}!Set\+\_\+grid\+\_\+color\+\_\+gdc@{Set\+\_\+grid\+\_\+color\+\_\+gdc}}
|
|
\index{Set\+\_\+grid\+\_\+color\+\_\+gdc@{Set\+\_\+grid\+\_\+color\+\_\+gdc}!Nex\+Waveform@{Nex\+Waveform}}
|
|
\subsubsection[{Set\+\_\+grid\+\_\+color\+\_\+gdc}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Waveform\+::\+Set\+\_\+grid\+\_\+color\+\_\+gdc (
|
|
\begin{DoxyParamCaption}
|
|
\item[{uint32\+\_\+t}]{number}
|
|
\end{DoxyParamCaption}
|
|
)}}\label{class_nex_waveform_ab396211f736824a0210446e68dc3edf4}
|
|
Set gdc 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_waveform_a85e776a5347c22efd9abe9bb8cfdbddb}{\index{Nex\+Waveform@{Nex\+Waveform}!Set\+\_\+grid\+\_\+height\+\_\+gdh@{Set\+\_\+grid\+\_\+height\+\_\+gdh}}
|
|
\index{Set\+\_\+grid\+\_\+height\+\_\+gdh@{Set\+\_\+grid\+\_\+height\+\_\+gdh}!Nex\+Waveform@{Nex\+Waveform}}
|
|
\subsubsection[{Set\+\_\+grid\+\_\+height\+\_\+gdh}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Waveform\+::\+Set\+\_\+grid\+\_\+height\+\_\+gdh (
|
|
\begin{DoxyParamCaption}
|
|
\item[{uint32\+\_\+t}]{number}
|
|
\end{DoxyParamCaption}
|
|
)}}\label{class_nex_waveform_a85e776a5347c22efd9abe9bb8cfdbddb}
|
|
Set gdh 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_waveform_a41cb6d8b1ff6c309d1c4e8a1f73304fe}{\index{Nex\+Waveform@{Nex\+Waveform}!Set\+\_\+grid\+\_\+width\+\_\+gdw@{Set\+\_\+grid\+\_\+width\+\_\+gdw}}
|
|
\index{Set\+\_\+grid\+\_\+width\+\_\+gdw@{Set\+\_\+grid\+\_\+width\+\_\+gdw}!Nex\+Waveform@{Nex\+Waveform}}
|
|
\subsubsection[{Set\+\_\+grid\+\_\+width\+\_\+gdw}]{\setlength{\rightskip}{0pt plus 5cm}bool Nex\+Waveform\+::\+Set\+\_\+grid\+\_\+width\+\_\+gdw (
|
|
\begin{DoxyParamCaption}
|
|
\item[{uint32\+\_\+t}]{number}
|
|
\end{DoxyParamCaption}
|
|
)}}\label{class_nex_waveform_a41cb6d8b1ff6c309d1c4e8a1f73304fe}
|
|
Set gdw 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}
|
|
|
|
|
|
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
\hyperlink{_nex_waveform_8h}{Nex\+Waveform.\+h}\item
|
|
\hyperlink{_nex_waveform_8cpp}{Nex\+Waveform.\+cpp}\end{DoxyCompactItemize}
|