\section{tpcconddata\-:\-:Field\-Setting Class Reference}
\label{classtpcconddata_1_1FieldSetting}\index{tpcconddata\-::\-Field\-Setting@{tpcconddata\-::\-Field\-Setting}}


class to store the field setting of a T\-P\-C with G\-E\-M-\/based amplification system  




{\ttfamily \#include $<$Field\-Setting.\-h$>$}

Inheritance diagram for tpcconddata\-:\-:Field\-Setting\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classtpcconddata_1_1FieldSetting}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
{\bfseries Field\-Setting} (int N\-G\-E\-Ms)\label{classtpcconddata_1_1FieldSetting_abf79bb7db2e047ff2c85765cfd7ef881}

\item 
{\bfseries Field\-Setting} (E\-V\-E\-N\-T\-::\-L\-C\-Object $\ast$Obj)\label{classtpcconddata_1_1FieldSetting_a90b87584ca642459c0b9053562ce5cd1}

\item 
int {\bf get\-N\-G\-E\-Ms} () const \label{classtpcconddata_1_1FieldSetting_a6ea7542004d8ce9b510eca5c26ae86e4}

\begin{DoxyCompactList}\small\item\em return the Number of G\-E\-Ms \end{DoxyCompactList}\item 
int {\bf get\-G\-E\-M\-Status} () const \label{classtpcconddata_1_1FieldSetting_a53ada9e9db4fd4678ebdd85b4057bddd}

\begin{DoxyCompactList}\small\item\em return the status of the G\-E\-M System 0\-: off 1\-: running normally 2\-: ramping up 3\-: ramping down 4\-: tripped 5\-: other error \end{DoxyCompactList}\item 
int {\bf get\-Drift\-Field\-Status} () const \label{classtpcconddata_1_1FieldSetting_a57c187c04c67c1264d3081d84bba8efb}

\begin{DoxyCompactList}\small\item\em return the status of the Drift\-Field System 0\-: off 1\-: running normally 2\-: ramping up 3\-: ramping down \end{DoxyCompactList}\item 
int {\bf get\-Magnetic\-Field\-Status} () const \label{classtpcconddata_1_1FieldSetting_a6536f4fb4e61de1beb8c0543126c11a6}

\begin{DoxyCompactList}\small\item\em return the status of the Magnet 0\-: off 1\-: running normally 2\-: ramping up 3\-: ramping down \end{DoxyCompactList}\item 
float {\bf get\-G\-E\-M\-Voltage} (int G\-E\-M\-I\-D) const \label{classtpcconddata_1_1FieldSetting_a5e115ccc892f12c98f6afcadf5e6ba62}

\begin{DoxyCompactList}\small\item\em return the voltage of the given number G\-E\-M 0 is the nearest the drift region \end{DoxyCompactList}\item 
float {\bf get\-Transfer\-Field} (int G\-E\-M\-I\-D) const \label{classtpcconddata_1_1FieldSetting_a0711ffefb58e2941b7fcac76c024a1a0}

\begin{DoxyCompactList}\small\item\em return the field (in V/mm) between the G\-E\-M N and N+1 \end{DoxyCompactList}\item 
float {\bf get\-Induction\-Field} () const \label{classtpcconddata_1_1FieldSetting_aed17fb23f4881785355919aaf9d541eb}

\begin{DoxyCompactList}\small\item\em return the field (in V/mm) between the last G\-E\-M and the Pad-\/\-Readout-\/\-Plane \end{DoxyCompactList}\item 
float {\bf get\-Guard\-Ring\-Voltage} () const \label{classtpcconddata_1_1FieldSetting_a3abbf138b6e53226eb26559b42c2a0d1}

\begin{DoxyCompactList}\small\item\em return voltage (in V) of the guard ring on the gem modules \end{DoxyCompactList}\item 
float {\bf get\-Cathode\-Voltage} () const \label{classtpcconddata_1_1FieldSetting_adbdb4f273abb9d8c65b15de5fed7159e}

\begin{DoxyCompactList}\small\item\em return voltage (in V) of the cathode of the field cage \end{DoxyCompactList}\item 
float {\bf get\-Anode\-Voltage} () const 
\begin{DoxyCompactList}\small\item\em return voltage (in V) of the anode of the field cage (e.\-g. \end{DoxyCompactList}\item 
float {\bf get\-Drift\-Field} (float max\-Drift\-Legth) const \label{classtpcconddata_1_1FieldSetting_a6f541c30827bcb2bc9bc61d86d83082f}

\begin{DoxyCompactList}\small\item\em return the driftfield (in V/mm) if the length of the driftregion (in mm) is given \end{DoxyCompactList}\item 
float {\bf get\-Magnetic\-Field} () const \label{classtpcconddata_1_1FieldSetting_af1ddea7635d94a02a7d08fed8184533c}

\begin{DoxyCompactList}\small\item\em return the magnetic field (in T) \end{DoxyCompactList}\item 
void {\bf set\-G\-E\-M\-Status} (int Value)\label{classtpcconddata_1_1FieldSetting_afa1f1c4ca4e8316a70dd9e834ec41164}

\begin{DoxyCompactList}\small\item\em set the status of a G\-E\-M (see get\-G\-E\-M\-Status) \end{DoxyCompactList}\item 
void {\bf set\-Drift\-Field\-Status} (int Value)\label{classtpcconddata_1_1FieldSetting_a8dac09a17fd189d8c16d6f3cb7993936}

\begin{DoxyCompactList}\small\item\em set the status of a drift field (see get\-Drift\-Field\-Status) \end{DoxyCompactList}\item 
void {\bf set\-Magnetic\-Field\-Status} (int Value)\label{classtpcconddata_1_1FieldSetting_a1a5bb1378becb488b3b6528031dd2faa}

\begin{DoxyCompactList}\small\item\em set the status of a magnet (see get\-Magnetic\-Field\-Status) \end{DoxyCompactList}\item 
void {\bf set\-G\-E\-M\-Voltage} (int G\-E\-M\-I\-D, float Value)\label{classtpcconddata_1_1FieldSetting_a574d5d9f1ba6eda21c8d733f9ccd79e3}

\begin{DoxyCompactList}\small\item\em set the voltage of the given number G\-E\-M 0 is the nearest the drift region \end{DoxyCompactList}\item 
void {\bf set\-Transfer\-Field} (int G\-E\-M\-I\-D, float Value)\label{classtpcconddata_1_1FieldSetting_a52e09a751ffcbc8904a483a0f232646e}

\begin{DoxyCompactList}\small\item\em set the field (in V/mm) between the G\-E\-M N and N+1 \end{DoxyCompactList}\item 
void {\bf set\-Induction\-Field} (float Value)\label{classtpcconddata_1_1FieldSetting_a6c9992f12deaa49afbdd027aabc12892}

\begin{DoxyCompactList}\small\item\em set the field (in V/mm) between the last G\-E\-M and the Pad-\/\-Readout-\/\-Plane \end{DoxyCompactList}\item 
void {\bf set\-Cathode\-Voltage} (float Value)\label{classtpcconddata_1_1FieldSetting_a6b20c0e1addf1b39e493870eae30f247}

\begin{DoxyCompactList}\small\item\em set voltage (in V) of the cathode of the field cage \end{DoxyCompactList}\item 
void {\bf set\-Guard\-Ring\-Voltage} (float Value)\label{classtpcconddata_1_1FieldSetting_ac58ca2e4419596094cc6ba4f310cf720}

\begin{DoxyCompactList}\small\item\em set voltage (in V) of the guard ring on gem module \end{DoxyCompactList}\item 
void {\bf set\-Anode\-Voltage} (float Value)
\begin{DoxyCompactList}\small\item\em set voltage (in V) of the anode of the field cage (e.\-g. \end{DoxyCompactList}\item 
void {\bf set\-Magnetic\-Field} (float Value)\label{classtpcconddata_1_1FieldSetting_a9faaedd3e15b24129f3cacab75951666}

\begin{DoxyCompactList}\small\item\em return the magnetic field (in T) \end{DoxyCompactList}\item 
I\-M\-P\-L\-::\-L\-C\-Generic\-Object\-Impl $\ast$ {\bfseries obj} ()\label{classtpcconddata_1_1FieldSetting_a1696c11c4d264613418689e806e2b453}

\item 
virtual int {\bfseries id} ()\label{classtpcconddata_1_1FieldSetting_a39afc9bf4182991a2ace4e8eff2399ad}

\item 
void {\bfseries print} (std\-::ostream \&os=std\-::cout) const \label{classtpcconddata_1_1FieldSetting_ae4703b1dbfc7657ac383ac33a0ae32b5}

\item 
int {\bfseries get\-N\-Int} () const \label{classtpcconddata_1_1FieldSetting_a51a29fb6d8fb5c1605cbbab306cfbb7b}

\item 
int {\bfseries get\-N\-Float} () const \label{classtpcconddata_1_1FieldSetting_a7d73d87ca6ba7744d3484c2e0310d7f4}

\item 
int {\bfseries get\-N\-Double} () const \label{classtpcconddata_1_1FieldSetting_ac2e024a86ebe5c87a511f7b770d6c0b6}

\item 
int {\bfseries get\-Int\-Val} (int index) const \label{classtpcconddata_1_1FieldSetting_a5fbca41d43617415e8d7d0457e4437aa}

\item 
float {\bfseries get\-Float\-Val} (int index) const \label{classtpcconddata_1_1FieldSetting_a132762ab5ace95d69fc2cb5f92fc37e2}

\item 
double {\bfseries get\-Double\-Val} (int index) const \label{classtpcconddata_1_1FieldSetting_ab33587309e02b008e9dce8cbd92e23fc}

\item 
bool {\bfseries is\-Fixed\-Size} () const \label{classtpcconddata_1_1FieldSetting_abdb74257620d65d792b617681540009b}

\item 
virtual const std\-::string {\bfseries get\-Type\-Name} () const \label{classtpcconddata_1_1FieldSetting_a511c48bf34cfd82f52f49c51ec589807}

\item 
virtual const std\-::string {\bfseries get\-Data\-Description} () const \label{classtpcconddata_1_1FieldSetting_aeb792261db16a3dbe4d8994d4fa9a06e}

\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static std\-::string {\bfseries get\-Revision} ()\label{classtpcconddata_1_1FieldSetting_ab375f3154853bbd26fd0252c6d7dddcb}

\item 
static std\-::string {\bfseries get\-Default\-Col\-Name} ()\label{classtpcconddata_1_1FieldSetting_a2491280982852b3ae66c088e1c25dd85}

\end{DoxyCompactItemize}
\subsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item 
void {\bf set\-N\-G\-E\-Ms} (int Value)\label{classtpcconddata_1_1FieldSetting_a63410e4a9b11db57e35b86d2b63fb511}

\begin{DoxyCompactList}\small\item\em set the Number of G\-E\-Ms is protected, numberof G\-E\-Ms is to imported for consistence can only be set by constructor \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item 
bool {\bfseries create\-Obj}\label{classtpcconddata_1_1FieldSetting_a7427b0550421e932b0fe538ebe972960}

\item 
I\-M\-P\-L\-::\-L\-C\-Generic\-Object\-Impl $\ast$ {\bfseries my\-Obj}\label{classtpcconddata_1_1FieldSetting_ae9ebaa967474f1818d65257e628e6688}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
class to store the field setting of a T\-P\-C with G\-E\-M-\/based amplification system 

\subsection{Member Function Documentation}
\index{tpcconddata\-::\-Field\-Setting@{tpcconddata\-::\-Field\-Setting}!get\-Anode\-Voltage@{get\-Anode\-Voltage}}
\index{get\-Anode\-Voltage@{get\-Anode\-Voltage}!tpcconddata::FieldSetting@{tpcconddata\-::\-Field\-Setting}}
\subsubsection[{get\-Anode\-Voltage}]{\setlength{\rightskip}{0pt plus 5cm}float tpcconddata\-::\-Field\-Setting\-::get\-Anode\-Voltage (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}\label{classtpcconddata_1_1FieldSetting_a47828c91da0318a64fa24ad1101c0770}


return voltage (in V) of the anode of the field cage (e.\-g. 

the shield at the position of the first G\-E\-M) 

Referenced by marlintpc\-::\-Field\-Setting\-Listener\-::get\-Anode\-Voltage(), and get\-Drift\-Field().

\index{tpcconddata\-::\-Field\-Setting@{tpcconddata\-::\-Field\-Setting}!set\-Anode\-Voltage@{set\-Anode\-Voltage}}
\index{set\-Anode\-Voltage@{set\-Anode\-Voltage}!tpcconddata::FieldSetting@{tpcconddata\-::\-Field\-Setting}}
\subsubsection[{set\-Anode\-Voltage}]{\setlength{\rightskip}{0pt plus 5cm}void tpcconddata\-::\-Field\-Setting\-::set\-Anode\-Voltage (
\begin{DoxyParamCaption}
\item[{float}]{Value}
\end{DoxyParamCaption}
)}\label{classtpcconddata_1_1FieldSetting_aba41ab05f5737755f52febce180d0f99}


set voltage (in V) of the anode of the field cage (e.\-g. 

the shield at the position of the first G\-E\-M) 

The documentation for this class was generated from the following files\-:\begin{DoxyCompactItemize}
\item 
Field\-Setting.\-h\item 
Field\-Setting.\-cc\end{DoxyCompactItemize}
