\section{marlintpc\-:\-:Field Class Reference}
\label{classmarlintpc_1_1Field}\index{marlintpc\-::\-Field@{marlintpc\-::\-Field}}


\doxyref{Field}{p.}{classmarlintpc_1_1Field} \-: A base interface to an electric or magnetic field.  




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

Inheritance diagram for marlintpc\-:\-:Field\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=9.893993cm]{classmarlintpc_1_1Field}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
{\bf Field} (std\-::string field\-\_\-typename)\label{classmarlintpc_1_1Field_a5cddca4ce1afaf576d7e78802e1654be}

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

\begin{DoxyCompactList}\small\item\em destructor \end{DoxyCompactList}\item 
virtual {\bf Field} $\ast$ {\bf new\-\_\-field} (void)=0
\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$)=0
\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\-::\-Hep\-Vector {\bf get\-\_\-field\-\_\-value} (const C\-L\-H\-E\-P\-::\-Hep\-Vector \&)
\begin{DoxyCompactList}\small\item\em gets the field value at a specified point (in carthesian coordinates) \end{DoxyCompactList}\item 
virtual C\-L\-H\-E\-P\-::\-Hep3\-Vector {\bf get\-\_\-field\-\_\-value} (const C\-L\-H\-E\-P\-::\-Hep3\-Vector \&)=0\label{classmarlintpc_1_1Field_addfc91053f0d28d87199d7d9e46eb01d}

\begin{DoxyCompactList}\small\item\em gets the field value at a specified point \end{DoxyCompactList}\item 
virtual C\-L\-H\-E\-P\-::\-Hep3\-Vector {\bf get\-\_\-field\-\_\-error} ()
\begin{DoxyCompactList}\small\item\em gets the field error. \end{DoxyCompactList}\item 
std\-::string {\bf get\-\_\-typename} ()\label{classmarlintpc_1_1Field_aab95d0dbda01392581d0690f7d4c183b}

\begin{DoxyCompactList}\small\item\em returns the typename of the field \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item 
C\-L\-H\-E\-P\-::\-Hep3\-Vector {\bfseries \-\_\-field\-\_\-error}\label{classmarlintpc_1_1Field_a6e1d8125608e47d366dcd0fa70f7ba04}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
\doxyref{Field}{p.}{classmarlintpc_1_1Field} \-: A base interface to an electric or magnetic field. 

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


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


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

field bin values or just parameters) 

Implemented in {\bf marlintpc\-::\-Cylindrical2\-D\-Magnetic\-Field} \doxyref{}{p.}{classmarlintpc_1_1Cylindrical2DMagneticField_a099b4012648c1b07fc7deb46b03edb7f}, {\bf marlintpc\-::\-Unit\-Bi\-Directional\-Electric\-Field} \doxyref{}{p.}{classmarlintpc_1_1UnitBiDirectionalElectricField_a3b3e05dccbe32c2dfe796c2b15528366}, {\bf marlintpc\-::\-Cylindrical3\-D\-Magnetic\-Field} \doxyref{}{p.}{classmarlintpc_1_1Cylindrical3DMagneticField_a8f377adf276fed555868b9ef510eb183}, {\bf marlintpc\-::\-Constant\-Unidirectional\-Magnetic\-Field} \doxyref{}{p.}{classmarlintpc_1_1ConstantUnidirectionalMagneticField_a50bbab8f937af618546dfb6d1084f090}, {\bf marlintpc\-::\-D\-I\-D\-Z\-Map\-Magnetic\-Field} \doxyref{}{p.}{classmarlintpc_1_1DIDZMapMagneticField_a4d596180497717f06663a158c162499c}, {\bf marlintpc\-::\-G\-E\-A\-R\-Magnetic\-Field} \doxyref{}{p.}{classmarlintpc_1_1GEARMagneticField_af64414eeb90a8948f5c1ff800927231e}, {\bf marlintpc\-::\-Ideal\-Solenoid\-Field} \doxyref{}{p.}{classmarlintpc_1_1IdealSolenoidField_aee3494e6ebded67ee19a7b3566dfc7be}, {\bf marlintpc\-::\-Solenoid\-Z\-Map\-Magnetic\-Field} \doxyref{}{p.}{classmarlintpc_1_1SolenoidZMapMagneticField_acaa05eee3e1f3f99d04ee74629a04e4b}, and {\bf marlintpc\-::\-Magnetic\-Field} \doxyref{}{p.}{classmarlintpc_1_1MagneticField_a204827dce8fb23808f887d822eaf1fe2}.



Referenced by marlintpc\-::\-Global\-Field\-Processor\-::\-Field\-Notifier\-::conditions\-Changed().

\index{marlintpc\-::\-Field@{marlintpc\-::\-Field}!get\-\_\-field\-\_\-error@{get\-\_\-field\-\_\-error}}
\index{get\-\_\-field\-\_\-error@{get\-\_\-field\-\_\-error}!marlintpc::Field@{marlintpc\-::\-Field}}
\subsubsection[{get\-\_\-field\-\_\-error}]{\setlength{\rightskip}{0pt plus 5cm}C\-L\-H\-E\-P\-::\-Hep3\-Vector marlintpc\-::\-Field\-::get\-\_\-field\-\_\-error (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}\label{classmarlintpc_1_1Field_a32534daa2f863eb455f5b519f297c932}


gets the field error. 

Assumes that the error is symmetric and independent of position 

Reimplemented in {\bf marlintpc\-::\-Magnetic\-Field} \doxyref{}{p.}{classmarlintpc_1_1MagneticField_a6f6313401c76bc3cbbf3ef6c7065e4fa}.

\index{marlintpc\-::\-Field@{marlintpc\-::\-Field}!get\-\_\-field\-\_\-value@{get\-\_\-field\-\_\-value}}
\index{get\-\_\-field\-\_\-value@{get\-\_\-field\-\_\-value}!marlintpc::Field@{marlintpc\-::\-Field}}
\subsubsection[{get\-\_\-field\-\_\-value}]{\setlength{\rightskip}{0pt plus 5cm}C\-L\-H\-E\-P\-::\-Hep\-Vector marlintpc\-::\-Field\-::get\-\_\-field\-\_\-value (
\begin{DoxyParamCaption}
\item[{const C\-L\-H\-E\-P\-::\-Hep\-Vector \&}]{position}
\end{DoxyParamCaption}
)}\label{classmarlintpc_1_1Field_ad4cde3804b97fa280bc932197cf22f08}


gets the field value at a specified point (in carthesian coordinates) 

\begin{DoxyRefDesc}{Deprecated}
\item[{\bf Deprecated}]replaced by \doxyref{get\-\_\-field\-\_\-value(const C\-L\-H\-E\-P\-::\-Hep3\-Vector\&)}{p.}{classmarlintpc_1_1Field_addfc91053f0d28d87199d7d9e46eb01d}\} \end{DoxyRefDesc}
\index{marlintpc\-::\-Field@{marlintpc\-::\-Field}!new\-\_\-field@{new\-\_\-field}}
\index{new\-\_\-field@{new\-\_\-field}!marlintpc::Field@{marlintpc\-::\-Field}}
\subsubsection[{new\-\_\-field}]{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf Field}$\ast$ marlintpc\-::\-Field\-::new\-\_\-field (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [pure virtual]}}\label{classmarlintpc_1_1Field_a43968e590bdaab7753d92ed6f950019e}


returns a new field... 

similar to how the Marlin processor registration works 

Implemented in {\bf marlintpc\-::\-C\-G\-A\-Magnetic\-Field} \doxyref{}{p.}{classmarlintpc_1_1CGAMagneticField_adf07b1aeb9d1abb310ad0874adfe1c89}, {\bf marlintpc\-::\-Cylindrical2\-D\-Magnetic\-Field} \doxyref{}{p.}{classmarlintpc_1_1Cylindrical2DMagneticField_a6465515ae104fd1107790f3ff0598d40}, {\bf marlintpc\-::\-C\-G\-A\-Electric\-Field} \doxyref{}{p.}{classmarlintpc_1_1CGAElectricField_a07d139186b8b1d4dd0a313665700f0e1}, {\bf marlintpc\-::\-Unit\-Bi\-Directional\-Electric\-Field} \doxyref{}{p.}{classmarlintpc_1_1UnitBiDirectionalElectricField_ae30fe47dff18c09ba295506e68c321e3}, {\bf marlintpc\-::\-Cylindrical3\-D\-Magnetic\-Field} \doxyref{}{p.}{classmarlintpc_1_1Cylindrical3DMagneticField_a4422cefd0a36a05631f514591efc26f6}, {\bf marlintpc\-::\-Constant\-Unidirectional\-Magnetic\-Field} \doxyref{}{p.}{classmarlintpc_1_1ConstantUnidirectionalMagneticField_a366bc0f7d599f95eb66773dc7451e0d0}, {\bf marlintpc\-::\-D\-I\-D\-Z\-Map\-Magnetic\-Field} \doxyref{}{p.}{classmarlintpc_1_1DIDZMapMagneticField_a932faca633640bc22520d221d61cfd53}, {\bf marlintpc\-::\-G\-E\-A\-R\-Magnetic\-Field} \doxyref{}{p.}{classmarlintpc_1_1GEARMagneticField_a287525d40cd07a05b7b9085b6967de7f}, {\bf marlintpc\-::\-Ideal\-Solenoid\-Field} \doxyref{}{p.}{classmarlintpc_1_1IdealSolenoidField_a1e11e6b4acb16bc83b5ef55930d9fa21}, {\bf marlintpc\-::\-Solenoid\-Z\-Map\-Magnetic\-Field} \doxyref{}{p.}{classmarlintpc_1_1SolenoidZMapMagneticField_aab2620ed9d8746158e391bfdba992186}, and {\bf marlintpc\-::\-Magnetic\-Field} \doxyref{}{p.}{classmarlintpc_1_1MagneticField_a77c3c5349528ec2aac1bf59cbdfd60cd}.



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