\section{marlintpc\-:\-:T\-P\-C\-Voxel Class Reference}
\label{classmarlintpc_1_1TPCVoxel}\index{marlintpc\-::\-T\-P\-C\-Voxel@{marlintpc\-::\-T\-P\-C\-Voxel}}


An L\-C\-Fixed\-Object class to store charge in voxels of a T\-P\-C.  




{\ttfamily \#include $<$T\-P\-C\-Voxel.\-h$>$}

Inheritance diagram for marlintpc\-:\-:T\-P\-C\-Voxel\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classmarlintpc_1_1TPCVoxel}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
{\bfseries T\-P\-C\-Voxel} (int pad\-Index, int time\-Index, int charge, int module\-I\-D=0)\label{classmarlintpc_1_1TPCVoxel_aa60a92c894d15344b3663aa460bf3adb}

\item 
{\bfseries T\-P\-C\-Voxel} (E\-V\-E\-N\-T\-::\-L\-C\-Object $\ast$obj)\label{classmarlintpc_1_1TPCVoxel_a8bec2b8d074b3cc60a5c86760d25fdb7}

\item 
{\bfseries T\-P\-C\-Voxel} (const {\bf T\-P\-C\-Voxel} \&original)\label{classmarlintpc_1_1TPCVoxel_a4577b900cf83dcf167538c0ddd01aa1c}

\item 
int {\bf get\-Module\-I\-D} () const \label{classmarlintpc_1_1TPCVoxel_a93c7dbff37d9fa9d50bee83572eaa22a}

\begin{DoxyCompactList}\small\item\em Returns the G\-E\-A\-R Module\-I\-D. \end{DoxyCompactList}\item 
int {\bf get\-Pad\-Index} () const \label{classmarlintpc_1_1TPCVoxel_a9e4eeb2d92736af7e51842ed9697683d}

\begin{DoxyCompactList}\small\item\em Returns the G\-E\-A\-R pad index. \end{DoxyCompactList}\item 
int {\bf get\-Time\-Index} () const \label{classmarlintpc_1_1TPCVoxel_ab1e5cd018200ef9cdee9adb046c6bb4c}

\begin{DoxyCompactList}\small\item\em Returns the time index of the voxel. \end{DoxyCompactList}\item 
int {\bf get\-Charge} () const \label{classmarlintpc_1_1TPCVoxel_a23dcb4ee5869acb3fcf45facaa35a98d}

\begin{DoxyCompactList}\small\item\em Returns the charge in the voxel (in electrons/ions) \end{DoxyCompactList}\item 
void {\bf set\-Charge} (int charge)\label{classmarlintpc_1_1TPCVoxel_a40c8bd6954b369550f483affa94cc761}

\begin{DoxyCompactList}\small\item\em Set the charge if the voxel (in electrons/ions) \end{DoxyCompactList}\item 
bool {\bf operator==} (const {\bf T\-P\-C\-Voxel} \&right) const 
\begin{DoxyCompactList}\small\item\em Two voxels are equal if their pad index and time index are equal. \end{DoxyCompactList}\item 
bool {\bf operator$<$} (const {\bf T\-P\-C\-Voxel} \&right) const 
\begin{DoxyCompactList}\small\item\em $<$ operator for e.\-g. sorting in S\-T\-L containers. \end{DoxyCompactList}\item 
{\bf T\-P\-C\-Voxel} \& {\bfseries operator=} (const {\bf T\-P\-C\-Voxel} \&that)\label{classmarlintpc_1_1TPCVoxel_a611cd9bb4d5e53f84e4a19e0f7923fba}

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

\begin{DoxyCompactList}\small\item\em Print the voxel information. \end{DoxyCompactList}\item 
virtual const std\-::string {\bf get\-Type\-Name} () const \label{classmarlintpc_1_1TPCVoxel_a383e3f99668239324995408acc13c22f}

\begin{DoxyCompactList}\small\item\em Implementation of the get\-Type\-Name method of L\-C\-Generic\-Object. \end{DoxyCompactList}\item 
virtual const std\-::string {\bf get\-Data\-Description} () const 
\begin{DoxyCompactList}\small\item\em Implementation of the get\-Data\-Descripton method of L\-C\-Generic\-Object Pad\-Index, Time\-Index and Charge are all ints. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static std\-::string {\bf get\-Revision} ()\label{classmarlintpc_1_1TPCVoxel_aa4419859b8fa51ee342a78304f11c22a}

\begin{DoxyCompactList}\small\item\em returns the svn revision of the code \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item 
void {\bf set\-Module\-I\-D} (int module\-I\-D)\label{classmarlintpc_1_1TPCVoxel_a5e87794a64f1724a7395a7aa6263782b}

\begin{DoxyCompactList}\small\item\em Set the module, only called from the constructor. \end{DoxyCompactList}\item 
void {\bf set\-Pad\-Index} (int pad\-Index)\label{classmarlintpc_1_1TPCVoxel_ace366ed172436111e44420b281d6fac2}

\begin{DoxyCompactList}\small\item\em Set the pad index, only called from the constructor. \end{DoxyCompactList}\item 
void {\bf set\-Time\-Index} (int time\-Index)\label{classmarlintpc_1_1TPCVoxel_ad0310296511ede2c377a313c394febdc}

\begin{DoxyCompactList}\small\item\em Set the time index, only called from the constructor. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
An L\-C\-Fixed\-Object class to store charge in voxels of a T\-P\-C. 

Also provides comparison operators for sorting, e.\-g. in S\-T\-L containers. 

\subsection{Member Function Documentation}
\index{marlintpc\-::\-T\-P\-C\-Voxel@{marlintpc\-::\-T\-P\-C\-Voxel}!get\-Data\-Description@{get\-Data\-Description}}
\index{get\-Data\-Description@{get\-Data\-Description}!marlintpc::TPCVoxel@{marlintpc\-::\-T\-P\-C\-Voxel}}
\subsubsection[{get\-Data\-Description}]{\setlength{\rightskip}{0pt plus 5cm}virtual const std\-::string marlintpc\-::\-T\-P\-C\-Voxel\-::get\-Data\-Description (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}\label{classmarlintpc_1_1TPCVoxel_a740891d9a28b8861631409b13e373f2c}


Implementation of the get\-Data\-Descripton method of L\-C\-Generic\-Object Pad\-Index, Time\-Index and Charge are all ints. 

\index{marlintpc\-::\-T\-P\-C\-Voxel@{marlintpc\-::\-T\-P\-C\-Voxel}!operator$<$@{operator$<$}}
\index{operator$<$@{operator$<$}!marlintpc::TPCVoxel@{marlintpc\-::\-T\-P\-C\-Voxel}}
\subsubsection[{operator$<$}]{\setlength{\rightskip}{0pt plus 5cm}bool marlintpc\-::\-T\-P\-C\-Voxel\-::operator$<$ (
\begin{DoxyParamCaption}
\item[{const {\bf T\-P\-C\-Voxel} \&}]{right}
\end{DoxyParamCaption}
) const}\label{classmarlintpc_1_1TPCVoxel_a214dee21434e5fac879b7cbeb0014f4c}


$<$ operator for e.\-g. sorting in S\-T\-L containers. 

They are sorted in pad index, and within this in time index. Charge is not considdered. 

References get\-Module\-I\-D(), get\-Pad\-Index(), and get\-Time\-Index().

\index{marlintpc\-::\-T\-P\-C\-Voxel@{marlintpc\-::\-T\-P\-C\-Voxel}!operator==@{operator==}}
\index{operator==@{operator==}!marlintpc::TPCVoxel@{marlintpc\-::\-T\-P\-C\-Voxel}}
\subsubsection[{operator==}]{\setlength{\rightskip}{0pt plus 5cm}bool marlintpc\-::\-T\-P\-C\-Voxel\-::operator== (
\begin{DoxyParamCaption}
\item[{const {\bf T\-P\-C\-Voxel} \&}]{right}
\end{DoxyParamCaption}
) const}\label{classmarlintpc_1_1TPCVoxel_a8db8c8bfbf3106b7a83a6d695ffeacbe}


Two voxels are equal if their pad index and time index are equal. 

The charge is not considered. 

References get\-Module\-I\-D(), get\-Pad\-Index(), and get\-Time\-Index().



The documentation for this class was generated from the following files\-:\begin{DoxyCompactItemize}
\item 
T\-P\-C\-Voxel.\-h\item 
T\-P\-C\-Voxel.\-cc\end{DoxyCompactItemize}
