\section{marlintpc\-:\-:Ideal\-Solenoid\-Field Class Reference}
\label{classmarlintpc_1_1IdealSolenoidField}\index{marlintpc\-::\-Ideal\-Solenoid\-Field@{marlintpc\-::\-Ideal\-Solenoid\-Field}}


\doxyref{Ideal\-Solenoid\-Field}{p.}{classmarlintpc_1_1IdealSolenoidField} \-: An ideal cylindrical solenoid field.  




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

Inheritance diagram for marlintpc\-:\-:Ideal\-Solenoid\-Field\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classmarlintpc_1_1IdealSolenoidField}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
{\bf Ideal\-Solenoid\-Field} ()\label{classmarlintpc_1_1IdealSolenoidField_a2cb46a115fa7875574ef3ab47010f9b7}

\begin{DoxyCompactList}\small\item\em constructor \end{DoxyCompactList}\item 
virtual {\bf $\sim$\-Ideal\-Solenoid\-Field} ()\label{classmarlintpc_1_1IdealSolenoidField_a82e66bcbbe29ed48ca7cb248e9147ffe}

\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_1IdealSolenoidField_a443f44c9d26d94d6c3db0b1aac524f8f}

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

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


\subsection{Detailed Description}
\doxyref{Ideal\-Solenoid\-Field}{p.}{classmarlintpc_1_1IdealSolenoidField} \-: An ideal cylindrical solenoid field. 

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


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


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\-::\-Ideal\-Solenoid\-Field@{marlintpc\-::\-Ideal\-Solenoid\-Field}!new\-\_\-field@{new\-\_\-field}}
\index{new\-\_\-field@{new\-\_\-field}!marlintpc::IdealSolenoidField@{marlintpc\-::\-Ideal\-Solenoid\-Field}}
\subsubsection[{new\-\_\-field}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Field} $\ast$ marlintpc\-::\-Ideal\-Solenoid\-Field\-::new\-\_\-field (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}\label{classmarlintpc_1_1IdealSolenoidField_a1e11e6b4acb16bc83b5ef55930d9fa21}


returns a new field... 

similar to how the Marlin processor registration works 

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



References Ideal\-Solenoid\-Field().



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