classlist.tex

max 2.3是具有图形界面的数据采集系统

\section{List  Class Reference}
\label{classList}\index{List@{List}}
This class represents the list of the {\em Device} {\em Parameter} {\em Data} together with the functions to access it. Check here for int {\bf List::putvar}(int, char $\ast$,char $\ast$) {\rm (p.\,\pageref{classList_a12})}, int {\bf List::getvar}(int $\ast$,char $\ast$,char $\ast$) {\rm (p.\,\pageref{classList_a10})} and int {\bf List::enabled}(char $\ast$,char $\ast$) {\rm (p.\,\pageref{classList_a18})} functions. 


{\tt \#include $<$list.hh$>$}

\subsection*{Public Methods}
\begin{CompactItemize}
\item 
{\bf List} ()
\item 
{\bf $\sim$List} ()
\item 
void {\bf initialize} ()
\item 
void {\bf insert} (int, char $\ast$,char $\ast$,int, int)
\item 
void {\bf insert} (double, char $\ast$,char $\ast$,int, int)
\item 
void {\bf append} (int, char $\ast$,char $\ast$,int, int, int, int)
\item 
void {\bf append} (double,char $\ast$,char $\ast$,int, int, int, int)
\item 
{\bf Element}$\ast$ {\bf exist} (char $\ast$,char $\ast$)
\item 
void {\bf remove} ()
\item 
int {\bf is\_\-active} (char $\ast$)
\item 
int {\bf getvar} (int $\ast$,char $\ast$,char $\ast$)
\item 
int {\bf getvar} (double $\ast$,char $\ast$,char $\ast$)
\item 
int {\bf putvar} (int,char $\ast$,char $\ast$)
\item 
int {\bf putvar} (double,char $\ast$,char $\ast$)
\item 
int {\bf varcomp} ({\bf Element} $\ast$,char $\ast$,char $\ast$)
\item 
void {\bf putvar} (int, int)
\item 
void {\bf putvar} (double, int)
\item 
void {\bf putvar} (char $\ast$,int)
\item 
int {\bf enabled} (char $\ast$,char $\ast$)
\item 
int {\bf plotstatus} (int)
\item 
char$\ast$ {\bf get\_\-data\_\-type} (char $\ast$)
\item 
{\bf dev\-Data\-Packet}$\ast$ {\bf Get\-Packet\-Element} (char $\ast$)
\item 
{\bf dev\-Data\-Packet}$\ast$ {\bf Get\-Next\-Packet} (void)
\item 
void {\bf Reset\-Help\-Pointer} (void)
\item 
int {\bf Advance\-Help\-Pointer} (void)
\item 
void {\bf reset\_\-data\_\-buffer} ()
\item 
void {\bf printlist} ()
\item 
{\bf Element}$\ast$ {\bf End\_\-Of\_\-List} ()
\item 
char$\ast$ {\bf getstring} (int)
\item 
int {\bf get\_\-type} (int)
\item 
char$\ast$ {\bf get\_\-name} (int)
\item 
char$\ast$ {\bf get\_\-var\_\-name} (int)
\item 
int {\bf get\_\-store\_\-flag} (int)
\item 
int {\bf get\_\-plot\_\-flag} (int)
\item 
int {\bf get\_\-enabled\_\-flag} (int)
\item 
void {\bf set\_\-enabled\_\-flag} (int, bool)
\item 
void {\bf set\_\-plot\_\-flag} (int, bool)
\item 
int {\bf get\_\-number\_\-plotvars} (char $\ast$)
\item 
string {\bf get\_\-plotvar\_\-namelist} (char $\ast$)
\item 
{\bf List} ()
\item 
{\bf $\sim$List} ()
\item 
void {\bf initialize} ()
\item 
void {\bf insert} (int, char $\ast$,char $\ast$,int, int)
\item 
void {\bf insert} (double, char $\ast$,char $\ast$,int, int)
\item 
void {\bf append} (int, char $\ast$,char $\ast$,int, int, int, int)
\item 
void {\bf append} (double,char $\ast$,char $\ast$,int, int, int, int)
\item 
{\bf Element}$\ast$ {\bf exist} (char $\ast$,char $\ast$)
\item 
void {\bf Sort\-Plot\-Properties} (void)
\item 
void {\bf remove} ()
\item 
int {\bf is\_\-active} (char $\ast$)
\item 
int {\bf remove} (int)
\item 
int {\bf remove} (double)
\item 
int {\bf getvar} (int $\ast$,char $\ast$,char $\ast$)
\item 
int {\bf getvar} (double $\ast$,char $\ast$,char $\ast$)
\item 
int {\bf putvar} (int,char $\ast$,char $\ast$)
\item 
int {\bf putvar} (double,char $\ast$,char $\ast$)
\item 
int {\bf varcomp} ({\bf Element} $\ast$,char $\ast$,char $\ast$)
\item 
void {\bf putvar} (int, int)
\item 
void {\bf putvar} (double, int)
\item 
void {\bf putvar} (char $\ast$,int)
\item 
int {\bf enabled} (char $\ast$,char $\ast$)
\item 
int {\bf plotstatus} (int)
\item 
int {\bf getint} (int)
\item 
double {\bf getdouble} (int)
\item 
char {\bf getchr} (int)
\item 
char$\ast$ {\bf getstr} (int)
\item 
char$\ast$ {\bf get\_\-data\_\-type} (char $\ast$)
\item 
{\bf dev\-Data\-Packet}$\ast$ {\bf Get\-Packet\-Element} (char $\ast$)
\item 
{\bf dev\-Data\-Packet}$\ast$ {\bf Get\-Next\-Packet} (void)
\item 
void {\bf Reset\-Help\-Pointer} (void)
\item 
int {\bf Advance\-Help\-Pointer} (void)
\item 
char$\ast$ {\bf get\-All\-Device\-Parameters} (char $\ast$)
\item 
void {\bf reset\_\-data\_\-buffer} ()
\item 
void {\bf printlist} ()
\item 
int {\bf initlist} (char $\ast$)
\item 
int {\bf init\-Plot\-Options} (FILE $\ast$fp, {\bf Plot\-Props} $\ast$)
\item 
{\bf Element}$\ast$ {\bf End\_\-Of\_\-List} ()
\item 
char$\ast$ {\bf getstring} (int)
\item 
int {\bf get\_\-type} (int)
\item 
char$\ast$ {\bf get\_\-name} (int)
\item 
char$\ast$ {\bf get\_\-var\_\-name} (int)
\item 
int {\bf get\_\-store\_\-flag} (int)
\item 
int {\bf get\_\-plot\_\-flag} (int)
\item 
int {\bf get\_\-enabled\_\-flag} (int)
\item 
void {\bf set\_\-enabled\_\-flag} (int, bool)
\item 
void {\bf set\_\-plot\_\-flag} (int, bool)
\item 
int {\bf get\_\-number\_\-plotvars} (char $\ast$)
\item 
string {\bf get\_\-plotvar\_\-namelist} (char $\ast$)
\end{CompactItemize}
\subsection*{Public Attributes}
\begin{CompactItemize}
\item 
QList$<${\bf Plot\-Props}$>$$\ast$ {\bf Plot\-Prop\-List}
\end{CompactItemize}


\subsection{Detailed Description}
This class represents the list of the {\em Device} {\em Parameter} {\em Data} together with the functions to access it. Check here for int {\bf List::putvar}(int, char $\ast$,char $\ast$) {\rm (p.\,\pageref{classList_a12})}, int {\bf List::getvar}(int $\ast$,char $\ast$,char $\ast$) {\rm (p.\,\pageref{classList_a10})} and int {\bf List::enabled}(char $\ast$,char $\ast$) {\rm (p.\,\pageref{classList_a18})} functions.

The {\em Device} {\em Parameter} {\em Data} is the data that is given in the {\em initfile}, which is read by {\bf {\bf MAX}} at startup. This data can be edited in the left listbox of the {\bf Main\-GUI} {\rm (p.\,\pageref{classMainGUI})}. Each device parameter is uniquely defined by two arguments. A {\em Device-Name} and a {\em Variable-Name}. These are always given as arguments when accessing the value. See also the default initfile \char`\"{}{\em initfile}\char`\"{} on how to set up a database. Only the class-functions that are important for the user are documented. You may not want to call the other functions. A documentation for the rest can be found in the source code directly. (see : list.cpp, list.cpp) 



\subsection{Constructor \& Destructor Documentation}
\index{List@{List}!List@{List}}
\index{List@{List}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}List::List ()\hspace{0.3cm}{\tt  [inline]}}\label{classList_a0}


\index{List@{List}!~List@{$\sim$List}}
\index{~List@{$\sim$List}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}List::$\sim$List ()\hspace{0.3cm}{\tt  [inline]}}\label{classList_a1}


\index{List@{List}!List@{List}}
\index{List@{List}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}List::List ()\hspace{0.3cm}{\tt  [inline]}}\label{classList_a39}


\index{List@{List}!~List@{$\sim$List}}
\index{~List@{$\sim$List}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}List::$\sim$List ()\hspace{0.3cm}{\tt  [inline]}}\label{classList_a40}




\subsection{Member Function Documentation}
\index{List@{List}!AdvanceHelpPointer@{AdvanceHelpPointer}}
\index{AdvanceHelpPointer@{AdvanceHelpPointer}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int List::Advance\-Help\-Pointer (void)}\label{classList_a70}


\index{List@{List}!AdvanceHelpPointer@{AdvanceHelpPointer}}
\index{AdvanceHelpPointer@{AdvanceHelpPointer}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int List::Advance\-Help\-Pointer (void)}\label{classList_a24}


\index{List@{List}!End_Of_List@{End\_\-Of\_\-List}}
\index{End_Of_List@{End\_\-Of\_\-List}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Element} $\ast$ List::End\_\-Of\_\-List ()}\label{classList_a76}


\index{List@{List}!End_Of_List@{End\_\-Of\_\-List}}
\index{End_Of_List@{End\_\-Of\_\-List}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Element} $\ast$ List::End\_\-Of\_\-List ()}\label{classList_a27}


\index{List@{List}!GetNextPacket@{GetNextPacket}}
\index{GetNextPacket@{GetNextPacket}!List@{List}}