Code owners
Assign users and groups as approvers for specific file changes. Learn more.
class_n___photo_conducteur.tex 8.82 KiB
\section{N\_\-Photo\-Conducteur Class Reference}
\label{class_n___photo_conducteur}\index{N_PhotoConducteur@{N\_\-PhotoConducteur}}
This class manage Novelec Photo\-Conductor types.
{\tt \#include $<$N\_\-Photo\-Conducteur.h$>$}
Inheritance diagram for N\_\-Photo\-Conducteur::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=3cm]{class_n___photo_conducteur}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item
{\bf N\_\-Photo\-Conducteur} (std::string \&com\-Link\_\-device\_\-name, short channel\_\-address, short electro\-Type)\label{class_n___photo_conducteur__n___photo_conducteura0}
\begin{CompactList}\small\item\em Initialization. \item\end{CompactList}\item
virtual {\bf $\sim$N\_\-Photo\-Conducteur} (void)\label{class_n___photo_conducteur__n___photo_conducteura1}
\begin{CompactList}\small\item\em Release resources. \item\end{CompactList}\item
void {\bf range\_\-up} (void)\label{class_n___photo_conducteur__n___photo_conducteura2}
\begin{CompactList}\small\item\em device dependent commands. \item\end{CompactList}\item
void {\bf range\_\-down} (void)\label{class_n___photo_conducteur__n___photo_conducteura3}
\item
std::string {\bf get\_\-Electro\-Meter\-Gain} (void)\label{class_n___photo_conducteur__n___photo_conducteura4}
\begin{CompactList}\small\item\em getters and setters. \item\end{CompactList}\item
void {\bf set\_\-Electro\-Meter\-Gain} (std::string)\label{class_n___photo_conducteur__n___photo_conducteura5}
\item
std::string {\bf get\_\-Electro\-Meter\-Polarity} (void)\label{class_novelec___m_c_c_e2__novelec___m_c_c_e2a2}
\begin{CompactList}\small\item\em Novelec getters and setters. \item\end{CompactList}\item
void {\bf set\_\-Electro\-Meter\-Polarity} (std::string)\label{class_novelec___m_c_c_e2__novelec___m_c_c_e2a3}
\item
void {\bf set\_\-Zero\_\-Von\-F\_\-function} (void)\label{class_novelec___m_c_c_e2__novelec___m_c_c_e2a4}
\begin{CompactList}\small\item\em Electrometer Functions : mode for novelec types. \item\end{CompactList}\item
void {\bf set\_\-Offset\_\-Zero\-V1\_\-function} (void)\label{class_novelec___m_c_c_e2__novelec___m_c_c_e2a5}
\item
void {\bf set\_\-Leakage\_\-Zero\-V2\_\-function} (void)\label{class_novelec___m_c_c_e2__novelec___m_c_c_e2a6}
\item
void {\bf set\_\-Test\_\-function} (void)\label{class_novelec___m_c_c_e2__novelec___m_c_c_e2a7}
\item
void {\bf mcce\_\-on} (void)
\begin{CompactList}\small\item\em Commands to start/stop the data acquisition. \item\end{CompactList}\item
void {\bf mcce\_\-off} (void)\label{class_novelec___m_c_c_e2__novelec___m_c_c_e2a9}
\item
std::string {\bf electrometer\_\-status} (void)\label{class_novelec___m_c_c_e2__novelec___m_c_c_e2a10}
\begin{CompactList}\small\item\em Electrometer Status. \item\end{CompactList}\item
virtual void {\bf reset} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a13}
\item
virtual void {\bf local} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a14}
\item
virtual void {\bf remote} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a15}
\item
std::string {\bf get\_\-value} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a16}
\begin{CompactList}\small\item\em Electrometer : cmd to get electrometer data. \item\end{CompactList}\item
void {\bf auto\-Range\_\-on} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a17}
\begin{CompactList}\small\item\em Keithley Electrometer methods. \item\end{CompactList}\item
void {\bf zero\_\-check\_\-on} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a18}
\item
void {\bf zero\_\-check\_\-off} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a19}
\item
void {\bf zero\_\-correct\_\-on} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a20}
\item
void {\bf zero\_\-correct\_\-off} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a21}
\item
void {\bf auto\_\-zero\_\-on} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a22}
\item
void {\bf auto\_\-zero\_\-off} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a23}
\item
virtual void {\bf auto\-Range\_\-off} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a24}
\item
virtual void {\bf set\-Amper\-Meter\-Mode} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a25}
\item
virtual void {\bf set\-Volt\-Meter\-Mode} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a26}
\item
virtual void {\bf set\-Ohm\-Meter\-Mode} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a27}
\item
virtual void {\bf set\-Coulomb\-Meter\-Mode} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a28}
\item
void {\bf init\_\-keithley} (void)
\begin{CompactList}\small\item\em Following functions are only supported for SCPI protocol. \item\end{CompactList}\item
void {\bf clear\_\-registers} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a30}
\item
void {\bf average\-State\-ON} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a31}
\item
void {\bf average\-State\-OFF} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a32}
\item
void {\bf set\_\-knplc} (std::string n\-PLC)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a33}
\item
void {\bf set\_\-triggercount} (std::string trigcounts)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a34}
\item
void {\bf set\_\-averagecount} (std::string avercounts)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a35}
\item
void {\bf set\_\-averagecontrol} (std::string averctrl)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a36}
\item
std::string {\bf get\_\-knplc} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a37}
\item
std::string {\bf get\_\-triggercount} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a38}
\item
std::string {\bf get\_\-averagecount} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a39}
\item std::string {\bf get\_\-averagecontrol} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a40}
\item
virtual std::string {\bf get\_\-Electro\-Meter\-Frequency} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a41}
\item
virtual void {\bf set\_\-Electro\-Meter\-Frequency} (std::string freq)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a43}
\item
virtual std::string {\bf get\_\-Electro\-Meter\-Mode} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a45}
\begin{CompactList}\small\item\em Common getters and setters. \item\end{CompactList}\item
virtual std::string {\bf get\_\-Electro\-Meter\-Range} (void)\label{class_abstract_electrometer_class__novelec___m_c_c_e2a46}
\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item
short {\bf \_\-range\-Limit}\label{class_novelec___m_c_c_e2__novelec___m_c_c_e2p0}
\item
short {\bf \_\-range}\label{class_abstract_electrometer_class__novelec___m_c_c_e2p1}
\item
std::string {\bf \_\-range\-Str}\label{class_abstract_electrometer_class__novelec___m_c_c_e2p2}
\item
std::string {\bf \_\-mode}\label{class_abstract_electrometer_class__novelec___m_c_c_e2p3}
\item
{\bf Electrometer\-Protocol} $\ast$ {\bf \_\-electrometer\-Protocol}\label{class_abstract_electrometer_class__novelec___m_c_c_e2p4}
\item
std::string {\bf \_\-device\_\-proxy\_\-name}\label{class_abstract_electrometer_class__novelec___m_c_c_e2p5}
\end{CompactItemize}
\subsection{Detailed Description}
This class manage Novelec Photo\-Conductor types.
\begin{Desc}
\item[Author:]Xavier Elattaoui \end{Desc}
\begin{Desc}
\item[Date:]11-2006 \end{Desc}
\subsection{Member Function Documentation}
\index{N_PhotoConducteur@{N\_\-Photo\-Conducteur}!init_keithley@{init\_\-keithley}}
\index{init_keithley@{init\_\-keithley}!N_PhotoConducteur@{N\_\-Photo\-Conducteur}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Abstract\-Electrometer\-Class::init\_\-keithley (void)\hspace{0.3cm}{\tt [inherited]}}\label{class_abstract_electrometer_class__novelec___m_c_c_e2a29}
Following functions are only supported for SCPI protocol.
\index{N_PhotoConducteur@{N\_\-Photo\-Conducteur}!mcce_on@{mcce\_\-on}}
\index{mcce_on@{mcce\_\-on}!N_PhotoConducteur@{N\_\-Photo\-Conducteur}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Novelec\_\-MCCE2::mcce\_\-on (void)\hspace{0.3cm}{\tt [virtual, inherited]}}\label{class_novelec___m_c_c_e2__novelec___m_c_c_e2a8}
Commands to start/stop the data acquisition.
This emulate the MCCE2 key ON/OFF (all parameters must be set before switching ON the MCCE2)
Reimplemented from {\bf Abstract\-Electrometer\-Class} {\rm (p.\,\pageref{class_abstract_electrometer_class})}.
The documentation for this class was generated from the following file:\begin{CompactItemize}
\item N\_\-Photo\-Conducteur.h\end{CompactItemize}