\section{marlin\-:\-:Marlin\-Steer\-Check Class Reference}
\label{classmarlin_1_1MarlinSteerCheck}\index{marlin\-::\-Marlin\-Steer\-Check@{marlin\-::\-Marlin\-Steer\-Check}}


this class is a Marlin Steering File consistency check Tool.  




{\ttfamily \#include $<$Marlin\-Steer\-Check.\-h$>$}

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
{\bfseries Marlin\-Steer\-Check} (const char $\ast$steer\-File\-Name=N\-U\-L\-L, const Command\-Line\-Parameters\-Map $\ast$cmdlineparams=N\-U\-L\-L)\label{classmarlin_1_1MarlinSteerCheck_a99795c024094219317effd4089724760}

\item 
{\bf C\-M\-Processor} $\ast$ {\bf get\-M\-Procs} ()\label{classmarlin_1_1MarlinSteerCheck_aa9319c425a1648a7d6c05856f6fa730e}

\begin{DoxyCompactList}\small\item\em Returns the Marlin Processors. \end{DoxyCompactList}\item 
Proc\-Vec \& {\bf get\-A\-Procs} ()\label{classmarlin_1_1MarlinSteerCheck_a3bf9806edabfd52bebc0525f29fb5aeb}

\begin{DoxyCompactList}\small\item\em Returns the Active Processors. \end{DoxyCompactList}\item 
Proc\-Vec \& {\bf get\-I\-Procs} ()\label{classmarlin_1_1MarlinSteerCheck_a8ab928d0a131618c0f009ca9a487b52f}

\begin{DoxyCompactList}\small\item\em Returns the Inactive Processors. \end{DoxyCompactList}\item 
int {\bf exists\-Processor} (const std\-::string \&type, const std\-::string \&name=\char`\"{}\char`\"{})\label{classmarlin_1_1MarlinSteerCheck_af8b942193e1d753ea8075d2332053b18}

\begin{DoxyCompactList}\small\item\em Check if a processor of the given type with the given name already exists Returns 0 if the processor does not exist Returns 1 if the processor exists and is active Returns 2 if the processor exists and is inactive. \end{DoxyCompactList}\item 
Col\-Vec \& {\bf get\-L\-C\-I\-O\-Cols} () const \label{classmarlin_1_1MarlinSteerCheck_a878bc6658965eedc573091d067e17b76}

\begin{DoxyCompactList}\small\item\em Returns the collections read from L\-C\-I\-O files. \end{DoxyCompactList}\item 
String\-Vec \& {\bf get\-L\-C\-I\-O\-Files} ()\label{classmarlin_1_1MarlinSteerCheck_afd907aba16781bb02263cbfaf4f44709}

\begin{DoxyCompactList}\small\item\em Returns the names of the L\-C\-I\-O files found in the global section. \end{DoxyCompactList}\item 
s\-Set \& {\bf get\-Cols\-Set} (const std\-::string \&type, const std\-::string \&name, {\bf C\-C\-Processor} $\ast$proc)\label{classmarlin_1_1MarlinSteerCheck_a3efd1104aa1ee3ad5680646d23822f4d}

\begin{DoxyCompactList}\small\item\em Returns a list of all available Collections for a given type, name and processor (to use in a Combo\-Box) \end{DoxyCompactList}\item 
{\bf String\-Parameters} $\ast$ {\bf get\-Global\-Parameters} ()\label{classmarlin_1_1MarlinSteerCheck_afdaa5ff035408642909ae9d562eb6793}

\begin{DoxyCompactList}\small\item\em Returns the \doxyref{Global}{p.}{classmarlin_1_1Global} Parameters. \end{DoxyCompactList}\item 
void {\bf dump\-Col\-Errors} (unsigned int i, std\-::ostream \&stream, bool separators=false)\label{classmarlin_1_1MarlinSteerCheck_a5221f867da1046da9f63e26b9c9b0427}

\begin{DoxyCompactList}\small\item\em Writes the collection errors for the active processor with given index to the given stream. \end{DoxyCompactList}\item 
int {\bf add\-L\-C\-I\-O\-File} (const std\-::string \&file)\label{classmarlin_1_1MarlinSteerCheck_a27cd4325d1c7bbc0a3e0e81f5e0bf649}

\begin{DoxyCompactList}\small\item\em Add L\-C\-I\-O file and read all collections inside it. \end{DoxyCompactList}\item 
void {\bf rem\-L\-C\-I\-O\-File} (const std\-::string \&file)\label{classmarlin_1_1MarlinSteerCheck_ad49802458166ee91554bf8e3c147be06}

\begin{DoxyCompactList}\small\item\em Remove L\-C\-I\-O file and all collections associated to it. \end{DoxyCompactList}\item 
void {\bf change\-L\-C\-I\-O\-File\-Pos} (unsigned int pos, unsigned int new\-Pos)\label{classmarlin_1_1MarlinSteerCheck_ae72a06f18d6575cdb7ad7cee13163ddb}

\begin{DoxyCompactList}\small\item\em Change the L\-C\-I\-O File at the given index to the new given position. \end{DoxyCompactList}\item 
void {\bf add\-Processor} (bool status, const std\-::string \&name, const std\-::string \&type, {\bf String\-Parameters} $\ast$p=N\-U\-L\-L)\label{classmarlin_1_1MarlinSteerCheck_a8bb12361d983603ee41b61f5ac652e7e}

\begin{DoxyCompactList}\small\item\em Add a new processor. \end{DoxyCompactList}\item 
void {\bf rem\-Processor} (unsigned int index, bool status)\label{classmarlin_1_1MarlinSteerCheck_aa2b41cc008518ba695736e4806140611}

\begin{DoxyCompactList}\small\item\em Remove processor with the given status at the given index. \end{DoxyCompactList}\item 
void {\bf activate\-Processor} (unsigned int index)\label{classmarlin_1_1MarlinSteerCheck_afb1b28c3c39394fa33e10f9e667f97d6}

\begin{DoxyCompactList}\small\item\em Activate processor at the given index. \end{DoxyCompactList}\item 
void {\bf deactivate\-Processor} (unsigned int index)\label{classmarlin_1_1MarlinSteerCheck_a3eb71458e02d1126d55e1644678d3c48}

\begin{DoxyCompactList}\small\item\em Deactivate processor at the given index. \end{DoxyCompactList}\item 
void {\bf change\-Processor\-Pos} (unsigned int pos, unsigned int new\-Pos)\label{classmarlin_1_1MarlinSteerCheck_abc096d93e5c619a7ffc5f71624de005e}

\begin{DoxyCompactList}\small\item\em Change the active processor at the given index to the new given position. \end{DoxyCompactList}\item 
void {\bf consistency\-Check} ()\label{classmarlin_1_1MarlinSteerCheck_a5e7fcbd10ca71b353b42e0b1ddb5f0b1}

\begin{DoxyCompactList}\small\item\em Performs a check at all active processors to search for unavailable collections. \end{DoxyCompactList}\item 
bool {\bf save\-As\-X\-M\-L\-File} (const std\-::string \&file)\label{classmarlin_1_1MarlinSteerCheck_a0f8f022285c1d365eab288accea4a3d2}

\begin{DoxyCompactList}\small\item\em Saves the data to an X\-M\-L file with the given name Returns false if error occured. \end{DoxyCompactList}\item 
const std\-::string {\bfseries get\-X\-M\-L\-File\-Rel\-Path} ()\label{classmarlin_1_1MarlinSteerCheck_ab712c506c49c07e40ad00db17cb12f6d}

\item 
const std\-::string {\bfseries get\-X\-M\-L\-File\-Abs\-Path} ()\label{classmarlin_1_1MarlinSteerCheck_a7009cb30c9a051bac3bbd11acb390f69}

\item 
const std\-::string {\bfseries get\-X\-M\-L\-File\-Name} ()\label{classmarlin_1_1MarlinSteerCheck_a14e215ad2a120fedc257b95725b0c440}

\item 
const std\-::string {\bfseries get\-X\-M\-L\-File} ()\label{classmarlin_1_1MarlinSteerCheck_a5587a4b592c89471533dcdc17c07f26c}

\item 
void {\bf dump\-\_\-information} ()\label{classmarlin_1_1MarlinSteerCheck_a90d512090ee9fa472ac4de7a15785533}

\begin{DoxyCompactList}\small\item\em Dumps all information read from the steering file to stdout. \end{DoxyCompactList}\item 
s\-Set \& {\bf get\-Errors} ()\label{classmarlin_1_1MarlinSteerCheck_a6d97393111a4d93d2b9a896898ae8243}

\begin{DoxyCompactList}\small\item\em Returns a set with all the errors found after performing a consistency check. \end{DoxyCompactList}\item 
s\-Set \& {\bf get\-P\-Conditions} ()\label{classmarlin_1_1MarlinSteerCheck_a1b5cff95ae4cca218fbc2d7aeb96068e}

\begin{DoxyCompactList}\small\item\em Returns a set with all the processor's conditions. \end{DoxyCompactList}\item 
const std\-::string {\bf get\-Condition} (unsigned int index)\label{classmarlin_1_1MarlinSteerCheck_a3eeb0eae81185d961082bb127438a2d5}

\begin{DoxyCompactList}\small\item\em Returns the condition for a given index. \end{DoxyCompactList}\item 
void {\bf add\-Condition} (const std\-::string \&condition)\label{classmarlin_1_1MarlinSteerCheck_ab25f87b2e2573ec95f38d2d977881ad6}

\begin{DoxyCompactList}\small\item\em Add a new Condition. \end{DoxyCompactList}\item 
void {\bf rep\-Condition} (const std\-::string \&old\-Cond, const std\-::string \&new\-Cond)\label{classmarlin_1_1MarlinSteerCheck_ad45bfdaba05e885170aebc3a650c6851}

\begin{DoxyCompactList}\small\item\em Replace a Condition. \end{DoxyCompactList}\item 
void {\bf rem\-Condition} (const std\-::string \&condition)\label{classmarlin_1_1MarlinSteerCheck_a2984e0cf056bfcc54aac238332926856}

\begin{DoxyCompactList}\small\item\em Removes the given condition. \end{DoxyCompactList}\item 
bool {\bf save\-As\-D\-O\-T\-File} (const std\-::string \&file)\label{classmarlin_1_1MarlinSteerCheck_ae0f5e383337219ac418e6dd66bee880e}

\begin{DoxyCompactList}\small\item\em Saves steering file in dot format. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
this class is a Marlin Steering File consistency check Tool. 

It can parse X\-M\-L steering files using the marlin parser and search the lcio file(s) specified at the global section for available collections. Together with the active and inactive processors specified in the steering file and their respective collections it can perform a full consistency check and check for unavailable collections. The Program checks if an adequate available collection exists for every input collection of a processor.

(where input collection means a collection the processor requires as input, and output collections mean a collection that is created in the processor and marked as available for the upcoming processors)

Information about the consistency check can be dumped.

\begin{DoxyAuthor}{Author}
Jan Engels, Benjamin Eberhardt, D\-E\-S\-Y 
\end{DoxyAuthor}
\begin{DoxyVersion}{Version}

\end{DoxyVersion}
\begin{DoxyParagraph}{Id\-:}
\doxyref{Marlin\-Steer\-Check.\-h}{p.}{MarlinSteerCheck_8h_source},v 1.\-32 2007-\/04-\/23 16\-:21\-:01 gaede Exp 
\end{DoxyParagraph}


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