\section{marlintpc\-:\-:Unit\-Bi\-Directional\-Electric\-Field Class Reference}
\label{classmarlintpc_1_1UnitBiDirectionalElectricField}\index{marlintpc\-::\-Unit\-Bi\-Directional\-Electric\-Field@{marlintpc\-::\-Unit\-Bi\-Directional\-Electric\-Field}}


\doxyref{Unit\-Bi\-Directional\-Electric\-Field}{p.}{classmarlintpc_1_1UnitBiDirectionalElectricField} \-: An electric field which is +1\-Vin the +z direction when z $>$ 0 and -\/1\-V in the -\/z direction when z $<$ 0.  




{\ttfamily \#include $<$Unit\-Bi\-Directional\-Electric\-Field.\-h$>$}

Inheritance diagram for marlintpc\-:\-:Unit\-Bi\-Directional\-Electric\-Field\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classmarlintpc_1_1UnitBiDirectionalElectricField}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
{\bf Unit\-Bi\-Directional\-Electric\-Field} ()\label{classmarlintpc_1_1UnitBiDirectionalElectricField_a8a31408d1facc54383d26cd1ef9854b9}

\begin{DoxyCompactList}\small\item\em constructor \end{DoxyCompactList}\item 
virtual {\bf $\sim$\-Unit\-Bi\-Directional\-Electric\-Field} ()\label{classmarlintpc_1_1UnitBiDirectionalElectricField_a3ad948de95955cc989e199c05462f9d9}

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

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

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


\subsection{Detailed Description}
\doxyref{Unit\-Bi\-Directional\-Electric\-Field}{p.}{classmarlintpc_1_1UnitBiDirectionalElectricField} \-: An electric field which is +1\-Vin the +z direction when z $>$ 0 and -\/1\-V in the -\/z direction when z $<$ 0. 

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


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


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


returns a new field... 

similar to how the Marlin processor registration works 

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



References Unit\-Bi\-Directional\-Electric\-Field().



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