\section{Marlin\-Trk\-:\-:I\-Marlin\-Trk\-System Class Reference}
\label{classMarlinTrk_1_1IMarlinTrkSystem}\index{Marlin\-Trk\-::\-I\-Marlin\-Trk\-System@{Marlin\-Trk\-::\-I\-Marlin\-Trk\-System}}


Base class for tracking system implementations in \doxyref{Marlin\-Trk}{p.}{namespaceMarlinTrk}.  




{\ttfamily \#include $<$I\-Marlin\-Trk\-System.\-h$>$}

Inheritance diagram for Marlin\-Trk\-:\-:I\-Marlin\-Trk\-System\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classMarlinTrk_1_1IMarlinTrkSystem}
\end{center}
\end{figure}
\subsection*{Classes}
\begin{DoxyCompactItemize}
\item 
struct {\bf C\-F\-G}
\begin{DoxyCompactList}\small\item\em 'Enums' for configuration options to be used with \doxyref{set\-Option()}{p.}{classMarlinTrk_1_1IMarlinTrkSystem_a8904a4bd9551a283873bf4ac815a8828}. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual {\bf $\sim$\-I\-Marlin\-Trk\-System} ()
\begin{DoxyCompactList}\small\item\em D'tor -\/ cleans up any allocated resources. \end{DoxyCompactList}\item 
void {\bf set\-Option} (unsigned C\-F\-G\-Option, bool val)\label{classMarlinTrk_1_1IMarlinTrkSystem_a8904a4bd9551a283873bf4ac815a8828}

\begin{DoxyCompactList}\small\item\em Sets the specified option ( one of the constants defined in \doxyref{I\-Marlin\-Trk\-System\-::\-C\-F\-G}{p.}{structMarlinTrk_1_1IMarlinTrkSystem_1_1CFG} ) to the given value. \end{DoxyCompactList}\item 
bool {\bf get\-Option} (unsigned C\-F\-G\-Option)\label{classMarlinTrk_1_1IMarlinTrkSystem_adad81966484708179636afe0ac715de4}

\begin{DoxyCompactList}\small\item\em Return the option's current value -\/ false if option not defined. \end{DoxyCompactList}\item 
std\-::string {\bf get\-Options} ()\label{classMarlinTrk_1_1IMarlinTrkSystem_a010a6556fb44c37071c7cc22c624a996}

\begin{DoxyCompactList}\small\item\em String with all configuration options and their current values. \end{DoxyCompactList}\item 
virtual std\-::string {\bf name} ()\label{classMarlinTrk_1_1IMarlinTrkSystem_adb5b2552fc02ae743a3de6e2b2db9c9e}

\begin{DoxyCompactList}\small\item\em the name of the implementation \end{DoxyCompactList}\item 
virtual void {\bf init} ()=0\label{classMarlinTrk_1_1IMarlinTrkSystem_a01b278fb8b1e4aca3eb8cb71fba1652e}

\begin{DoxyCompactList}\small\item\em Initialise tracking system -\/ to be called after configuration with \doxyref{set\-Option()}{p.}{classMarlinTrk_1_1IMarlinTrkSystem_a8904a4bd9551a283873bf4ac815a8828} -\/ \doxyref{I\-Marlin\-Trk\-System}{p.}{classMarlinTrk_1_1IMarlinTrkSystem} cannot be used before a call to \doxyref{init()}{p.}{classMarlinTrk_1_1IMarlinTrkSystem_a01b278fb8b1e4aca3eb8cb71fba1652e}. \end{DoxyCompactList}\item 
virtual {\bf Marlin\-Trk\-::\-I\-Marlin\-Track} $\ast$ {\bf create\-Track} ()=0\label{classMarlinTrk_1_1IMarlinTrkSystem_af92f743fffd15962c5ddb307050112df}

\begin{DoxyCompactList}\small\item\em Return an instance of \doxyref{I\-Marlin\-Track}{p.}{classMarlinTrk_1_1IMarlinTrack} corresponding to the current implementation. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Member Functions}
\begin{DoxyCompactItemize}
\item 
void {\bf register\-Options} ()\label{classMarlinTrk_1_1IMarlinTrkSystem_af90267ca6872f22b86b6cb881b271fb6}

\begin{DoxyCompactList}\small\item\em Register the possible configuration options. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item 
{\bf Config\-Flags} {\bfseries \-\_\-cfg}\label{classMarlinTrk_1_1IMarlinTrkSystem_a5f061f81ccc9780090a88aa10132f8b0}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
Base class for tracking system implementations in \doxyref{Marlin\-Trk}{p.}{namespaceMarlinTrk}. 

\begin{DoxyVersion}{Version}

\end{DoxyVersion}
\begin{DoxyParagraph}{Id\-:}
\doxyref{I\-Marlin\-Trk\-System.\-h}{p.}{IMarlinTrkSystem_8h_source} 5207 2015-\/10-\/26 14\-:37\-:50\-Z gaede 
\end{DoxyParagraph}
\begin{DoxyAuthor}{Author}
S.\-Aplin, F. Gaede D\-E\-S\-Y 
\end{DoxyAuthor}


\subsection{Constructor \& Destructor Documentation}
\index{Marlin\-Trk\-::\-I\-Marlin\-Trk\-System@{Marlin\-Trk\-::\-I\-Marlin\-Trk\-System}!$\sim$\-I\-Marlin\-Trk\-System@{$\sim$\-I\-Marlin\-Trk\-System}}
\index{$\sim$\-I\-Marlin\-Trk\-System@{$\sim$\-I\-Marlin\-Trk\-System}!MarlinTrk::IMarlinTrkSystem@{Marlin\-Trk\-::\-I\-Marlin\-Trk\-System}}
\subsubsection[{$\sim$\-I\-Marlin\-Trk\-System}]{\setlength{\rightskip}{0pt plus 5cm}virtual Marlin\-Trk\-::\-I\-Marlin\-Trk\-System\-::$\sim$\-I\-Marlin\-Trk\-System (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}\label{classMarlinTrk_1_1IMarlinTrkSystem_a12b3720b6b7c562027cfd57d47ebdf49}


D'tor -\/ cleans up any allocated resources. 



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