\section{marlintpc\-:\-:Constant\-Unidirectional\-Magnetic\-Field Class Reference}
\label{classmarlintpc_1_1ConstantUnidirectionalMagneticField}\index{marlintpc\-::\-Constant\-Unidirectional\-Magnetic\-Field@{marlintpc\-::\-Constant\-Unidirectional\-Magnetic\-Field}}


\doxyref{Constant\-Unidirectional\-Magnetic\-Field}{p.}{classmarlintpc_1_1ConstantUnidirectionalMagneticField} \-: A constant magnetic field.  




{\ttfamily \#include $<$Constant\-Unidirectional\-Magnetic\-Field.\-h$>$}

Inheritance diagram for marlintpc\-:\-:Constant\-Unidirectional\-Magnetic\-Field\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classmarlintpc_1_1ConstantUnidirectionalMagneticField}
\end{center}
\end{figure}
\subsection*{Classes}
\begin{DoxyCompactItemize}
\item 
struct {\bf Field\-Map\-Entry}
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
{\bf Constant\-Unidirectional\-Magnetic\-Field} ()\label{classmarlintpc_1_1ConstantUnidirectionalMagneticField_ac077f9b700326cfffee2176cad880dc8}

\begin{DoxyCompactList}\small\item\em constructor \end{DoxyCompactList}\item 
virtual {\bf $\sim$\-Constant\-Unidirectional\-Magnetic\-Field} ()\label{classmarlintpc_1_1ConstantUnidirectionalMagneticField_a3b1dafc44693f0201bbbb448c093403f}

\begin{DoxyCompactList}\small\item\em destructor \end{DoxyCompactList}\item 
virtual {\bf Field} $\ast$ {\bf new\-\_\-field} (void)
\begin{DoxyCompactList}\small\item\em returns a new field... \end{DoxyCompactList}\item 
virtual bool {\bf construct} (E\-V\-E\-N\-T\-::\-L\-C\-Collection $\ast$)
\begin{DoxyCompactList}\small\item\em constructs the field from an L\-C\-Collection of data objects (could be anything... \end{DoxyCompactList}\item 
C\-L\-H\-E\-P\-::\-Hep3\-Vector {\bf get\-\_\-field\-\_\-value} (const C\-L\-H\-E\-P\-::\-Hep3\-Vector \&)\label{classmarlintpc_1_1ConstantUnidirectionalMagneticField_a81d7639b05b1cc4416f74dbf9f36c4ca}

\begin{DoxyCompactList}\small\item\em gets the field value at a specified point \end{DoxyCompactList}\item 
std\-::string {\bf get\-\_\-typename} ()\label{classmarlintpc_1_1ConstantUnidirectionalMagneticField_a789b3ec23e6c1fbb8da1824b14b38409}

\begin{DoxyCompactList}\small\item\em returns the typename of the field \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Additional Inherited Members}


\subsection{Detailed Description}
\doxyref{Constant\-Unidirectional\-Magnetic\-Field}{p.}{classmarlintpc_1_1ConstantUnidirectionalMagneticField} \-: A constant magnetic field. 

\begin{DoxyAuthor}{Author}
J. Abernathy (U\-Vic)\par
 
\end{DoxyAuthor}


\subsection{Member Function Documentation}
\index{marlintpc\-::\-Constant\-Unidirectional\-Magnetic\-Field@{marlintpc\-::\-Constant\-Unidirectional\-Magnetic\-Field}!construct@{construct}}
\index{construct@{construct}!marlintpc::ConstantUnidirectionalMagneticField@{marlintpc\-::\-Constant\-Unidirectional\-Magnetic\-Field}}
\subsubsection[{construct}]{\setlength{\rightskip}{0pt plus 5cm}bool marlintpc\-::\-Constant\-Unidirectional\-Magnetic\-Field\-::construct (
\begin{DoxyParamCaption}
\item[{E\-V\-E\-N\-T\-::\-L\-C\-Collection $\ast$}]{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}\label{classmarlintpc_1_1ConstantUnidirectionalMagneticField_a50bbab8f937af618546dfb6d1084f090}


constructs the field from an L\-C\-Collection of data objects (could be anything... 

field bin values or just parameters) 

Implements {\bf marlintpc\-::\-Field} \doxyref{}{p.}{classmarlintpc_1_1Field_a23cef2c3beaa60ed594ef525d72920b0}.

\index{marlintpc\-::\-Constant\-Unidirectional\-Magnetic\-Field@{marlintpc\-::\-Constant\-Unidirectional\-Magnetic\-Field}!new\-\_\-field@{new\-\_\-field}}
\index{new\-\_\-field@{new\-\_\-field}!marlintpc::ConstantUnidirectionalMagneticField@{marlintpc\-::\-Constant\-Unidirectional\-Magnetic\-Field}}
\subsubsection[{new\-\_\-field}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Field} $\ast$ marlintpc\-::\-Constant\-Unidirectional\-Magnetic\-Field\-::new\-\_\-field (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}\label{classmarlintpc_1_1ConstantUnidirectionalMagneticField_a366bc0f7d599f95eb66773dc7451e0d0}


returns a new field... 

similar to how the Marlin processor registration works 

Implements {\bf marlintpc\-::\-Field} \doxyref{}{p.}{classmarlintpc_1_1Field_a43968e590bdaab7753d92ed6f950019e}.



References Constant\-Unidirectional\-Magnetic\-Field().



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