classlist.tex

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

\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf dev\-Data\-Packet} $\ast$ List::Get\-Next\-Packet (void)}\label{classList_a68}


\index{List@{List}!GetNextPacket@{GetNextPacket}}
\index{GetNextPacket@{GetNextPacket}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf dev\-Data\-Packet} $\ast$ List::Get\-Next\-Packet (void)}\label{classList_a22}


\index{List@{List}!GetPacketElement@{GetPacketElement}}
\index{GetPacketElement@{GetPacketElement}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf dev\-Data\-Packet} $\ast$ List::Get\-Packet\-Element (char $\ast$ {\em dev\_\-name})}\label{classList_a67}


\index{List@{List}!GetPacketElement@{GetPacketElement}}
\index{GetPacketElement@{GetPacketElement}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf dev\-Data\-Packet} $\ast$ List::Get\-Packet\-Element (char $\ast$ {\em dev\_\-name})}\label{classList_a21}


\index{List@{List}!ResetHelpPointer@{ResetHelpPointer}}
\index{ResetHelpPointer@{ResetHelpPointer}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void List::Reset\-Help\-Pointer (void)}\label{classList_a69}


\index{List@{List}!ResetHelpPointer@{ResetHelpPointer}}
\index{ResetHelpPointer@{ResetHelpPointer}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void List::Reset\-Help\-Pointer (void)}\label{classList_a23}


\index{List@{List}!SortPlotProperties@{SortPlotProperties}}
\index{SortPlotProperties@{SortPlotProperties}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void List::Sort\-Plot\-Properties (void)}\label{classList_a47}


\index{List@{List}!append@{append}}
\index{append@{append}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void List::append (double {\em d\_\-var}, char $\ast$ {\em dev\_\-name}, char $\ast$ {\em var\_\-name}, int {\em save\_\-flag}, int {\em var\_\-type}, int {\em scale}, int {\em offset})}\label{classList_a45}


\index{List@{List}!append@{append}}
\index{append@{append}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void List::append (int {\em i\_\-var}, char $\ast$ {\em dev\_\-name}, char $\ast$ {\em var\_\-name}, int {\em save\_\-flag}, int {\em var\_\-type}, int {\em scale}, int {\em offset})}\label{classList_a44}


\index{List@{List}!append@{append}}
\index{append@{append}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void List::append (double {\em d\_\-var}, char $\ast$ {\em dev\_\-name}, char $\ast$ {\em var\_\-name}, int {\em save\_\-flag}, int {\em var\_\-type}, int {\em scale}, int {\em offset})}\label{classList_a6}


\index{List@{List}!append@{append}}
\index{append@{append}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void List::append (int {\em i\_\-var}, char $\ast$ {\em dev\_\-name}, char $\ast$ {\em var\_\-name}, int {\em save\_\-flag}, int {\em var\_\-type}, int {\em scale}, int {\em offset})}\label{classList_a5}


\index{List@{List}!enabled@{enabled}}
\index{enabled@{enabled}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int List::enabled (char $\ast$ {\em dev\_\-name}, char $\ast$ {\em var\_\-name})}\label{classList_a60}


This function is very important! It checks the {\tt ENABLED} field of the {\tt STORE} section in the {\em initfile}, which is read by {\bf {\bf MAX}} at startup. The device\_\-module checks via this function, wether a specific channel is \char`\"{}{\em enabled}\char`\"{}, This way the device knows, if it should take data on this channel or not. (See also Int {\bf Scheduler::store}(int ) {\rm (p.\,\pageref{classScheduler_a20})} ) , the file laser.cpp and the descrption of the initfile \begin{Desc}
\item[{\bf Parameters: }]\par
\begin{description}
\item[
{\em Device\_\-Name, the}]name of the device \item[
{\em Variable\_\-Name, the}]name of the {\tt STORE} variable to check \end{description}
\end{Desc}
\begin{Desc}
\item[{\bf Returns: }]\par
TRUE if this \char`\"{}channel\char`\"{} is enabled, FALSE if not \end{Desc}
\index{List@{List}!enabled@{enabled}}
\index{enabled@{enabled}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int List::enabled (char $\ast$ {\em dev\_\-name}, char $\ast$ {\em var\_\-name})}\label{classList_a18}


This function is very important! It checks the {\tt ENABLED} field of the {\tt STORE} section in the {\em initfile}, which is read by {\bf {\bf MAX}} at startup. The device\_\-module checks via this function, wether a specific channel is \char`\"{}{\em enabled}\char`\"{}, This way the device knows, if it should take data on this channel or not. (See also Int {\bf Scheduler::store}(int ) {\rm (p.\,\pageref{classScheduler_a20})} ) , the file laser.cpp and the descrption of the initfile \begin{Desc}
\item[{\bf Parameters: }]\par
\begin{description}
\item[
{\em Device\_\-Name, the}]name of the device \item[
{\em Variable\_\-Name, the}]name of the {\tt STORE} variable to check \end{description}
\end{Desc}
\begin{Desc}
\item[{\bf Returns: }]\par
TRUE if this \char`\"{}channel\char`\"{} is enabled, FALSE if not \end{Desc}
\index{List@{List}!exist@{exist}}
\index{exist@{exist}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Element} $\ast$ List::exist (char $\ast$ {\em dev\_\-name}, char $\ast$ {\em var\_\-name})}\label{classList_a46}


\index{List@{List}!exist@{exist}}
\index{exist@{exist}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf Element} $\ast$ List::exist (char $\ast$ {\em dev\_\-name}, char $\ast$ {\em var\_\-name})}\label{classList_a7}


\index{List@{List}!getAllDeviceParameters@{getAllDeviceParameters}}
\index{getAllDeviceParameters@{getAllDeviceParameters}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char $\ast$ List::get\-All\-Device\-Parameters (char $\ast$ {\em dev\_\-name})}\label{classList_a71}


\index{List@{List}!get_data_type@{get\_\-data\_\-type}}
\index{get_data_type@{get\_\-data\_\-type}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char $\ast$ List::get\_\-data\_\-type (char $\ast$ {\em dev\_\-name})}\label{classList_a66}


\index{List@{List}!get_data_type@{get\_\-data\_\-type}}
\index{get_data_type@{get\_\-data\_\-type}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char $\ast$ List::get\_\-data\_\-type (char $\ast$ {\em dev\_\-name})}\label{classList_a20}


\index{List@{List}!get_enabled_flag@{get\_\-enabled\_\-flag}}
\index{get_enabled_flag@{get\_\-enabled\_\-flag}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int List::get\_\-enabled\_\-flag (int {\em position})}\label{classList_a83}


\index{List@{List}!get_enabled_flag@{get\_\-enabled\_\-flag}}
\index{get_enabled_flag@{get\_\-enabled\_\-flag}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int List::get\_\-enabled\_\-flag (int {\em position})}\label{classList_a34}


\index{List@{List}!get_name@{get\_\-name}}
\index{get_name@{get\_\-name}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char $\ast$ List::get\_\-name (int {\em position})}\label{classList_a79}


\index{List@{List}!get_name@{get\_\-name}}
\index{get_name@{get\_\-name}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char $\ast$ List::get\_\-name (int {\em position})}\label{classList_a30}


\index{List@{List}!get_number_plotvars@{get\_\-number\_\-plotvars}}
\index{get_number_plotvars@{get\_\-number\_\-plotvars}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int List::get\_\-number\_\-plotvars (char $\ast$ {\em dev\_\-name})}\label{classList_a86}


\index{List@{List}!get_number_plotvars@{get\_\-number\_\-plotvars}}
\index{get_number_plotvars@{get\_\-number\_\-plotvars}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int List::get\_\-number\_\-plotvars (char $\ast$ {\em dev\_\-name})}\label{classList_a37}


\index{List@{List}!get_plot_flag@{get\_\-plot\_\-flag}}
\index{get_plot_flag@{get\_\-plot\_\-flag}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int List::get\_\-plot\_\-flag (int {\em position})}\label{classList_a82}


\index{List@{List}!get_plot_flag@{get\_\-plot\_\-flag}}
\index{get_plot_flag@{get\_\-plot\_\-flag}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int List::get\_\-plot\_\-flag (int {\em position})}\label{classList_a33}


\index{List@{List}!get_plotvar_namelist@{get\_\-plotvar\_\-namelist}}
\index{get_plotvar_namelist@{get\_\-plotvar\_\-namelist}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}string List::get\_\-plotvar\_\-namelist (char $\ast$ {\em dev\_\-name})}\label{classList_a87}


\index{List@{List}!get_plotvar_namelist@{get\_\-plotvar\_\-namelist}}
\index{get_plotvar_namelist@{get\_\-plotvar\_\-namelist}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}string List::get\_\-plotvar\_\-namelist (char $\ast$ {\em dev\_\-name})}\label{classList_a38}


\index{List@{List}!get_store_flag@{get\_\-store\_\-flag}}
\index{get_store_flag@{get\_\-store\_\-flag}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int List::get\_\-store\_\-flag (int {\em position})}\label{classList_a81}


\index{List@{List}!get_store_flag@{get\_\-store\_\-flag}}
\index{get_store_flag@{get\_\-store\_\-flag}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int List::get\_\-store\_\-flag (int {\em position})}\label{classList_a32}


\index{List@{List}!get_type@{get\_\-type}}
\index{get_type@{get\_\-type}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int List::get\_\-type (int {\em position})}\label{classList_a78}


\index{List@{List}!get_type@{get\_\-type}}
\index{get_type@{get\_\-type}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int List::get\_\-type (int {\em position})}\label{classList_a29}


\index{List@{List}!get_var_name@{get\_\-var\_\-name}}
\index{get_var_name@{get\_\-var\_\-name}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char $\ast$ List::get\_\-var\_\-name (int {\em position})}\label{classList_a80}


\index{List@{List}!get_var_name@{get\_\-var\_\-name}}
\index{get_var_name@{get\_\-var\_\-name}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char $\ast$ List::get\_\-var\_\-name (int {\em position})}\label{classList_a31}


\index{List@{List}!getchr@{getchr}}
\index{getchr@{getchr}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char List::getchr (int {\em position})}\label{classList_a64}


\index{List@{List}!getdouble@{getdouble}}
\index{getdouble@{getdouble}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}double List::getdouble (int {\em position})}\label{classList_a63}


\index{List@{List}!getint@{getint}}
\index{getint@{getint}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int List::getint (int {\em position})}\label{classList_a62}


\index{List@{List}!getstr@{getstr}}
\index{getstr@{getstr}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char $\ast$ List::getstr (int {\em position})}\label{classList_a65}


\index{List@{List}!getstring@{getstring}}
\index{getstring@{getstring}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char $\ast$ List::getstring (int {\em position})}\label{classList_a77}


\index{List@{List}!getstring@{getstring}}
\index{getstring@{getstring}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}char $\ast$ List::getstring (int {\em position})}\label{classList_a28}


\index{List@{List}!getvar@{getvar}}
\index{getvar@{getvar}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int List::getvar (double $\ast$ {\em d\_\-var}, char $\ast$ {\em dev\_\-name}, char $\ast$ {\em var\_\-name})}\label{classList_a53}


This function is called from the device module to retrieve a device Parameter from the Device Parameter {\bf Database} {\rm (p.\,\pageref{classDatabase})}. \begin{Desc}
\item[{\bf Parameters: }]\par
\begin{description}
\item[
{\em Value, a}]reference to the {\em double} variable to be received \item[
{\em Device\_\-Name,  the}]device name \item[
{\em Variable\_\-Name,  the}]variable name \end{description}
\end{Desc}
\begin{Desc}
\item[{\bf Returns: }]\par
-1 if variable was not found(argument is zero), 1 if variable was found \end{Desc}
\index{List@{List}!getvar@{getvar}}
\index{getvar@{getvar}!List@{List}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int List::getvar (int $\ast$ {\em i\_\-var}, char $\ast$ {\em dev\_\-name}, char $\ast$ {\em var\_\-name})}\label{classList_a52}


This function is called from the device module to retrieve a device Parameter from the Device Parameter {\bf Database} {\rm (p.\,\pageref{classDatabase})}.

{\em An} {\em Example} from the the file laser.cpp :

How to read the variable \char`\"{}laser\char`\"{}, \char`\"{}phase\char`\"{} into the integer value b :

 result = device\_\-data -$>$getvar(\&b,\char`\"{}laser\char`\"{},\char`\"{}phase\char`\"{})  \begin{Desc}