Code owners
Assign users and groups as approvers for specific file changes. Learn more.
class_novelec_protocol.tex 7.50 KiB
\section{Novelec\-Protocol Class Reference}
\label{class_novelec_protocol}\index{NovelecProtocol@{NovelecProtocol}}
This class manage the Novelec Commands Protocol.
{\tt \#include $<$Novelec\-Protocol.h$>$}
Inheritance diagram for Novelec\-Protocol::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2cm]{class_novelec_protocol}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf Novelec\-Protocol} (std::string \&gpib\_\-device\_\-name, short channel\_\-address, short electro\-Type\-Number)\label{class_novelec_protocol__novelec_protocola0}
\begin{CompactList}\small\item\em Initialization. \item\end{CompactList}\item
virtual {\bf $\sim$Novelec\-Protocol} (void)\label{class_novelec_protocol__novelec_protocola1}
\begin{CompactList}\small\item\em Release resources. \item\end{CompactList}\item
void {\bf set\_\-range} (std::string value)\label{class_novelec_protocol__novelec_protocola2}
\begin{CompactList}\small\item\em Electrometer Functions. \item\end{CompactList}\item
std::string {\bf get\_\-range} (void)\label{class_novelec_protocol__novelec_protocola3}
\item
void {\bf reset} (void)\label{class_novelec_protocol__novelec_protocola4}
\item
void {\bf local} (void)\label{class_novelec_protocol__novelec_protocola5}
\item
void {\bf remote} (void)\label{class_novelec_protocol__novelec_protocola6}
\item
std::string {\bf get\_\-value} (void)\label{class_novelec_protocol__novelec_protocola7}
\begin{CompactList}\small\item\em Electrometer : cmd to get electrometer data. \item\end{CompactList}\item
void {\bf switch\_\-MCCE2\_\-ON} (void)\label{class_novelec_protocol__novelec_protocola8}
\begin{CompactList}\small\item\em Electrometer Mode : Novelec SUPPORTS these commands. \item\end{CompactList}\item
void {\bf switch\_\-MCCE2\_\-OFF} (void)\label{class_novelec_protocol__novelec_protocola9}
\item
void {\bf unable\_\-zero\-VF\_\-func} (void)\label{class_novelec_protocol__novelec_protocola10}
\item
void {\bf unable\_\-offset\_\-zero\-V1\_\-func} (void)\label{class_novelec_protocol__novelec_protocola11}
\item
void {\bf unable\_\-leakage\_\-zero\-V2\_\-func} (void)\label{class_novelec_protocol__novelec_protocola12}
\item
void {\bf unable\_\-test\_\-func} (void)\label{class_novelec_protocol__novelec_protocola13}
\item
std::string {\bf get\_\-raw\_\-status} (void)\label{class_novelec_protocol__novelec_protocola14}
\begin{CompactList}\small\item\em Get Raw Electrometer Status. \item\end{CompactList}\item
std::string {\bf get\_\-mode} (void)\label{class_novelec_protocol__novelec_protocola15}
\begin{CompactList}\small\item\em Electrometer Mode : getters and setters. \item\end{CompactList}\item
std::string {\bf get\_\-polarity} (void)\label{class_novelec_protocol__novelec_protocola16}
\item
std::string {\bf get\_\-frequency} (void)\label{class_novelec_protocol__novelec_protocola17}
\item std::string {\bf get\_\-gain} (void)\label{class_novelec_protocol__novelec_protocola18}
\item
std::string {\bf get\_\-errors} (void)\label{class_novelec_protocol__novelec_protocola19}
\item
std::string {\bf get\_\-electrotype} (void)\label{class_novelec_protocol__novelec_protocola20}
\item
void {\bf set\_\-polarity} (std::string pola)\label{class_novelec_protocol__novelec_protocola21}
\item
void {\bf set\_\-frequency} (std::string freq)\label{class_novelec_protocol__novelec_protocola22}
\item
void {\bf set\_\-gain} (std::string gain)\label{class_novelec_protocol__novelec_protocola23}
\item
virtual void {\bf init\_\-keithley} (void)\label{class_electrometer_protocol__novelec_protocola24}
\begin{CompactList}\small\item\em Electrometer : Keithley protocol dependent commands. \item\end{CompactList}\item
virtual void {\bf set\_\-knplc} (std::string n\-PLC)\label{class_electrometer_protocol__novelec_protocola25}
\item
virtual void {\bf set\_\-triggercount} (std::string trigcounts)\label{class_electrometer_protocol__novelec_protocola26}
\item
virtual void {\bf set\_\-averagecount} (std::string avercounts)\label{class_electrometer_protocol__novelec_protocola27}
\item
virtual void {\bf set\_\-averagecontrol} (std::string averctrl)\label{class_electrometer_protocol__novelec_protocola28}
\item
virtual std::string {\bf get\_\-knplc} (void)\label{class_electrometer_protocol__novelec_protocola29}
\item
virtual std::string {\bf get\_\-triggercount} (void)\label{class_electrometer_protocol__novelec_protocola30}
\item
virtual std::string {\bf get\_\-averagecount} (void)\label{class_electrometer_protocol__novelec_protocola31}
\item
virtual std::string {\bf get\_\-averagecontrol} (void)\label{class_electrometer_protocol__novelec_protocola32}
\item
virtual void {\bf clear\_\-registers} (void)\label{class_electrometer_protocol__novelec_protocola33}
\item
virtual void {\bf average\-State\-ON} (void)\label{class_electrometer_protocol__novelec_protocola34}
\item
virtual void {\bf average\-State\-OFF} (void)\label{class_electrometer_protocol__novelec_protocola35}
\item
virtual void {\bf set\-Amper\-Meter\-Mode} (void)\label{class_electrometer_protocol__novelec_protocola36}
\item
virtual void {\bf set\-Volt\-Meter\-Mode} (void)\label{class_electrometer_protocol__novelec_protocola37}
\item
virtual void {\bf set\-Ohm\-Meter\-Mode} (void)\label{class_electrometer_protocol__novelec_protocola38}
\item
virtual void {\bf set\-Coulomb\-Meter\-Mode} (void)\label{class_electrometer_protocol__novelec_protocola39}
\item
virtual void {\bf auto\-Range\_\-on} (void)\label{class_electrometer_protocol__novelec_protocola40}
\item
virtual void {\bf auto\-Range\_\-off} (void)\label{class_electrometer_protocol__novelec_protocola41}
\item
virtual void {\bf zero\_\-check\_\-on} (void)\label{class_electrometer_protocol__novelec_protocola42}
\item
virtual void {\bf zero\_\-check\_\-off} (void)\label{class_electrometer_protocol__novelec_protocola43}
\item
virtual void {\bf zero\_\-correct\_\-on} (void)\label{class_electrometer_protocol__novelec_protocola44}
\item
virtual void {\bf zero\_\-correct\_\-off} (void)\label{class_electrometer_protocol__novelec_protocola45}
\item
virtual void {\bf auto\_\-zero\_\-on} (void)\label{class_electrometer_protocol__novelec_protocola46}
\item
virtual void {\bf auto\_\-zero\_\-off} (void)\label{class_electrometer_protocol__novelec_protocola47}
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item
std::string {\bf check\_\-and\_\-extract\_\-data} (std::string resp\_\-to\_\-check)\label{class_novelec_protocol__novelec_protocolb0}
\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item
short {\bf \_\-dev\-Add}\label{class_novelec_protocol__novelec_protocolp0}
\item
short {\bf \_\-nov\-Type}\label{class_novelec_protocol__novelec_protocolp1}
\item
short {\bf \_\-range\-Parameter\-Num}\label{class_novelec_protocol__novelec_protocolp2}
\item
std::string {\bf \_\-function}\label{class_novelec_protocol__novelec_protocolp3}
\item
short {\bf \_\-range}\label{class_electrometer_protocol__novelec_protocolp4}
\item
std::string {\bf \_\-mode}\label{class_electrometer_protocol__novelec_protocolp5}
\item
{\bf Communication\-Link} $\ast$ {\bf \_\-communication\_\-link}\label{class_electrometer_protocol__novelec_protocolp6}
\end{CompactItemize}
\subsection{Detailed Description}
This class manage the Novelec Commands Protocol.
\begin{Desc}
\item[Author:]Xavier Elattaoui \end{Desc}
\begin{Desc}
\item[Date:]11-2006 \end{Desc}
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item
Novelec\-Protocol.h\end{CompactItemize}