\section{E\-V\-E\-N\-T\-:\-:Sim\-Calorimeter\-Hit Class Reference}
\label{classEVENT_1_1SimCalorimeterHit}\index{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit@{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit}}


The generic simulated calorimeter hit.  




{\ttfamily \#include $<$pre-\/generated/\-E\-V\-E\-N\-T/\-Sim\-Calorimeter\-Hit.\-h$>$}

Inheritance diagram for E\-V\-E\-N\-T\-:\-:Sim\-Calorimeter\-Hit\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=5.000000cm]{classEVENT_1_1SimCalorimeterHit}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
typedef {\bf Sim\-Calorimeter\-Hit} {\bf lcobject\-\_\-type}\label{classEVENT_1_1SimCalorimeterHit_a1e962a0b823610ccf84d86d1766ba882}

\begin{DoxyCompactList}\small\item\em Useful typedef for template programming with \doxyref{L\-C\-I\-O}{p.}{classEVENT_1_1LCIO}. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual {\bf $\sim$\-Sim\-Calorimeter\-Hit} ()\label{classEVENT_1_1SimCalorimeterHit_a23cb738d93ecbe1a33837a8ef46ec9fc}

\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item 
virtual int {\bf get\-Cell\-I\-D0} () const =0\label{classEVENT_1_1SimCalorimeterHit_a315bfb85eb3e9846b72c1a1ebf706e11}

\begin{DoxyCompactList}\small\item\em Returns the detector specific (geometrical) cell id. \end{DoxyCompactList}\item 
virtual int {\bf get\-Cell\-I\-D1} () const =0
\begin{DoxyCompactList}\small\item\em Returns the second detector specific (geometrical) cell id. \end{DoxyCompactList}\item 
virtual float {\bf get\-Energy} () const =0\label{classEVENT_1_1SimCalorimeterHit_a191c87ddf304e8187e95128549f0fc99}

\begin{DoxyCompactList}\small\item\em Returns the energy of the hit in [Ge\-V]. \end{DoxyCompactList}\item 
virtual const float $\ast$ {\bf get\-Position} () const =0
\begin{DoxyCompactList}\small\item\em Returns the position of the hit in world coordinates. \end{DoxyCompactList}\item 
virtual const float $\ast$ {\bf get\-Step\-Position} (int i) const =0\label{classEVENT_1_1SimCalorimeterHit_a7e01c1012c2e4c9224de262c5dbbf2ea}

\begin{DoxyCompactList}\small\item\em Returns the position where the energy deposited (step) occurred optional, only if bit L\-C\-I\-O\-::\-C\-H\-B\-I\-T\-\_\-\-S\-T\-E\-P is set. \end{DoxyCompactList}\item 
virtual int {\bf get\-N\-M\-C\-Particles} () const =0
\begin{DoxyCompactList}\small\item\em Returns the number of M\-C contributions to the hit. \end{DoxyCompactList}\item 
virtual int {\bf get\-N\-M\-C\-Contributions} () const =0
\begin{DoxyCompactList}\small\item\em Returns the number of M\-C contributions to the hit. \end{DoxyCompactList}\item 
virtual float {\bf get\-Energy\-Cont} (int i) const =0
\begin{DoxyCompactList}\small\item\em Returns the energy in [Ge\-V] of the i-\/th contribution to the hit. \end{DoxyCompactList}\item 
virtual float {\bf get\-Time\-Cont} (int i) const =0
\begin{DoxyCompactList}\small\item\em Returns the time of the i-\/th in [ns] contribution to the hit. \end{DoxyCompactList}\item 
virtual int {\bf get\-P\-D\-G\-Cont} (int i) const =0
\begin{DoxyCompactList}\small\item\em Returns the P\-D\-G code of the shower particle that caused this contribution. \end{DoxyCompactList}\item 
virtual {\bf M\-C\-Particle} $\ast$ {\bf get\-Particle\-Cont} (int i) const =0
\begin{DoxyCompactList}\small\item\em Returns the \doxyref{M\-C\-Particle}{p.}{classEVENT_1_1MCParticle} that caused the shower responsible for this contribution to the hit. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Additional Inherited Members}


\subsection{Detailed Description}
The generic simulated calorimeter hit. 

\begin{DoxyAuthor}{Author}
gaede 
\end{DoxyAuthor}
\begin{DoxyVersion}{Version}

\end{DoxyVersion}
\begin{DoxyParagraph}{Id\-:}
Sim\-Calorimeter\-Hit.\-aid,v 1.\-8 2006-\/03-\/24 13\-:25\-:52 gaede Exp 
\end{DoxyParagraph}


\subsection{Member Function Documentation}
\index{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit@{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit}!get\-Cell\-I\-D1@{get\-Cell\-I\-D1}}
\index{get\-Cell\-I\-D1@{get\-Cell\-I\-D1}!EVENT::SimCalorimeterHit@{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit}}
\subsubsection[{get\-Cell\-I\-D1}]{\setlength{\rightskip}{0pt plus 5cm}virtual int E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit\-::get\-Cell\-I\-D1 (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classEVENT_1_1SimCalorimeterHit_aef0b7499c8dbfbd235f30ef5de4b45eb}


Returns the second detector specific (geometrical) cell id. 

0 if information is not stored -\/ check the flag word (bit C\-H\-B\-I\-T\-\_\-\-I\-D1) of the collection. Default is to store only cellid0. 

Implemented in {\bf I\-M\-P\-L\-::\-Sim\-Calorimeter\-Hit\-Impl} \doxyref{}{p.}{classIMPL_1_1SimCalorimeterHitImpl_ac5bfccc894bd71c7038b82944c9d381d}.



Referenced by S\-I\-O\-::\-S\-I\-O\-Sim\-Cal\-Hit\-Handler\-::write().

\index{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit@{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit}!get\-Energy\-Cont@{get\-Energy\-Cont}}
\index{get\-Energy\-Cont@{get\-Energy\-Cont}!EVENT::SimCalorimeterHit@{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit}}
\subsubsection[{get\-Energy\-Cont}]{\setlength{\rightskip}{0pt plus 5cm}virtual float E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit\-::get\-Energy\-Cont (
\begin{DoxyParamCaption}
\item[{int}]{i}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classEVENT_1_1SimCalorimeterHit_af38c3b20e9946df1db8aad9b00c30fea}


Returns the energy in [Ge\-V] of the i-\/th contribution to the hit. 

\begin{DoxySeeAlso}{See Also}
\doxyref{get\-N\-M\-C\-Contributions()}{p.}{classEVENT_1_1SimCalorimeterHit_abd096d0ea5ea41b2f4cacf7b21a3b9da} 
\end{DoxySeeAlso}


Implemented in {\bf I\-M\-P\-L\-::\-Sim\-Calorimeter\-Hit\-Impl} \doxyref{}{p.}{classIMPL_1_1SimCalorimeterHitImpl_a27fc2e571c1e817b4bf65b6a9346cffc}.



Referenced by S\-I\-O\-::\-S\-I\-O\-Sim\-Cal\-Hit\-Handler\-::write().

\index{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit@{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit}!get\-N\-M\-C\-Contributions@{get\-N\-M\-C\-Contributions}}
\index{get\-N\-M\-C\-Contributions@{get\-N\-M\-C\-Contributions}!EVENT::SimCalorimeterHit@{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit}}
\subsubsection[{get\-N\-M\-C\-Contributions}]{\setlength{\rightskip}{0pt plus 5cm}virtual int E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit\-::get\-N\-M\-C\-Contributions (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classEVENT_1_1SimCalorimeterHit_abd096d0ea5ea41b2f4cacf7b21a3b9da}


Returns the number of M\-C contributions to the hit. 

0 if information is not stored. There are two levels of detail\-: if collection flag bit L\-C\-I\-O.\-C\-H\-B\-I\-T\-\_\-\-S\-T\-E\-P==1 then all simulator steps' contributions to the hit are stored, otherwise there is only one contribution for every particle entering the calorimeter. 

Implemented in {\bf I\-M\-P\-L\-::\-Sim\-Calorimeter\-Hit\-Impl} \doxyref{}{p.}{classIMPL_1_1SimCalorimeterHitImpl_afb51d0a037b4c8cc65ebfd01c871d185}.



Referenced by S\-I\-O\-::\-S\-I\-O\-Sim\-Cal\-Hit\-Handler\-::write().

\index{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit@{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit}!get\-N\-M\-C\-Particles@{get\-N\-M\-C\-Particles}}
\index{get\-N\-M\-C\-Particles@{get\-N\-M\-C\-Particles}!EVENT::SimCalorimeterHit@{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit}}
\subsubsection[{get\-N\-M\-C\-Particles}]{\setlength{\rightskip}{0pt plus 5cm}virtual int E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit\-::get\-N\-M\-C\-Particles (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classEVENT_1_1SimCalorimeterHit_a6849f5b575804239a3560a42ca8ec1be}


Returns the number of M\-C contributions to the hit. 

0 if information is not stored. Renamed to get\-N\-M\-C\-Contributions. \begin{DoxyRefDesc}{Deprecated}
\item[{\bf Deprecated}]\begin{DoxySeeAlso}{See Also}
\doxyref{get\-N\-M\-C\-Contributions()}{p.}{classEVENT_1_1SimCalorimeterHit_abd096d0ea5ea41b2f4cacf7b21a3b9da} 
\end{DoxySeeAlso}
\end{DoxyRefDesc}


Implemented in {\bf I\-M\-P\-L\-::\-Sim\-Calorimeter\-Hit\-Impl} \doxyref{}{p.}{classIMPL_1_1SimCalorimeterHitImpl_a47e021a41d3a1827f31eb9cdc48dc3d2}.

\index{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit@{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit}!get\-Particle\-Cont@{get\-Particle\-Cont}}
\index{get\-Particle\-Cont@{get\-Particle\-Cont}!EVENT::SimCalorimeterHit@{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit}}
\subsubsection[{get\-Particle\-Cont}]{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf M\-C\-Particle}$\ast$ E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit\-::get\-Particle\-Cont (
\begin{DoxyParamCaption}
\item[{int}]{i}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classEVENT_1_1SimCalorimeterHit_ac63cdf66917a009ab7a142110d0b59da}


Returns the \doxyref{M\-C\-Particle}{p.}{classEVENT_1_1MCParticle} that caused the shower responsible for this contribution to the hit. 

This is the particle that flew into the calorimeter and not the shower particle that made the energy deposition. \begin{DoxySeeAlso}{See Also}
\doxyref{get\-N\-M\-C\-Contributions()}{p.}{classEVENT_1_1SimCalorimeterHit_abd096d0ea5ea41b2f4cacf7b21a3b9da} 
\end{DoxySeeAlso}


Implemented in {\bf I\-M\-P\-L\-::\-Sim\-Calorimeter\-Hit\-Impl} \doxyref{}{p.}{classIMPL_1_1SimCalorimeterHitImpl_a0ad48c0241f1d6e8f10bbf019928c10f}.



Referenced by S\-I\-O\-::\-S\-I\-O\-Sim\-Cal\-Hit\-Handler\-::write().

\index{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit@{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit}!get\-P\-D\-G\-Cont@{get\-P\-D\-G\-Cont}}
\index{get\-P\-D\-G\-Cont@{get\-P\-D\-G\-Cont}!EVENT::SimCalorimeterHit@{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit}}
\subsubsection[{get\-P\-D\-G\-Cont}]{\setlength{\rightskip}{0pt plus 5cm}virtual int E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit\-::get\-P\-D\-G\-Cont (
\begin{DoxyParamCaption}
\item[{int}]{i}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classEVENT_1_1SimCalorimeterHit_a930674626381a8e1fa4b057a44ab82fd}


Returns the P\-D\-G code of the shower particle that caused this contribution. 

Check the flag word bit L\-C\-I\-O.\-C\-H\-B\-I\-T\-\_\-\-S\-T\-E\-P of the collection whether this information is available. \begin{DoxySeeAlso}{See Also}
\doxyref{get\-N\-M\-C\-Contributions()}{p.}{classEVENT_1_1SimCalorimeterHit_abd096d0ea5ea41b2f4cacf7b21a3b9da} 
\end{DoxySeeAlso}


Implemented in {\bf I\-M\-P\-L\-::\-Sim\-Calorimeter\-Hit\-Impl} \doxyref{}{p.}{classIMPL_1_1SimCalorimeterHitImpl_a1172c142cb5a4443652ca750ad51ca91}.



Referenced by S\-I\-O\-::\-S\-I\-O\-Sim\-Cal\-Hit\-Handler\-::write().

\index{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit@{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit}!get\-Position@{get\-Position}}
\index{get\-Position@{get\-Position}!EVENT::SimCalorimeterHit@{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit}}
\subsubsection[{get\-Position}]{\setlength{\rightskip}{0pt plus 5cm}virtual const float$\ast$ E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit\-::get\-Position (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classEVENT_1_1SimCalorimeterHit_a9e9866b99f16d217359f92cd917d66f9}


Returns the position of the hit in world coordinates. 

N\-U\-L\-L if information is not stored -\/ check the flag word (bit C\-H\-B\-I\-T\-\_\-\-L\-O\-N\-G) of the collection. 

Implemented in {\bf I\-M\-P\-L\-::\-Sim\-Calorimeter\-Hit\-Impl} \doxyref{}{p.}{classIMPL_1_1SimCalorimeterHitImpl_a86d9fa946b076030cc964f515a1d6a99}.



Referenced by S\-I\-O\-::\-S\-I\-O\-Sim\-Cal\-Hit\-Handler\-::write().

\index{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit@{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit}!get\-Time\-Cont@{get\-Time\-Cont}}
\index{get\-Time\-Cont@{get\-Time\-Cont}!EVENT::SimCalorimeterHit@{E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit}}
\subsubsection[{get\-Time\-Cont}]{\setlength{\rightskip}{0pt plus 5cm}virtual float E\-V\-E\-N\-T\-::\-Sim\-Calorimeter\-Hit\-::get\-Time\-Cont (
\begin{DoxyParamCaption}
\item[{int}]{i}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classEVENT_1_1SimCalorimeterHit_a25fc40ee05fe45680b3c6e44c957b616}


Returns the time of the i-\/th in [ns] contribution to the hit. 

\begin{DoxySeeAlso}{See Also}
\doxyref{get\-N\-M\-C\-Contributions()}{p.}{classEVENT_1_1SimCalorimeterHit_abd096d0ea5ea41b2f4cacf7b21a3b9da} 
\end{DoxySeeAlso}


Implemented in {\bf I\-M\-P\-L\-::\-Sim\-Calorimeter\-Hit\-Impl} \doxyref{}{p.}{classIMPL_1_1SimCalorimeterHitImpl_a263dcd9b2534491d68fd529a7309aec3}.



Referenced by S\-I\-O\-::\-S\-I\-O\-Sim\-Cal\-Hit\-Handler\-::write().



The documentation for this class was generated from the following file\-:\begin{DoxyCompactItemize}
\item 
Sim\-Calorimeter\-Hit.\-h\end{DoxyCompactItemize}
