\section{marlin\-:\-:C\-C\-Processor Class Reference}
\label{classmarlin_1_1CCProcessor}\index{marlin\-::\-C\-C\-Processor@{marlin\-::\-C\-C\-Processor}}


handles information about marlin processors and their collections needed by \doxyref{Marlin\-Steer\-Check}{p.}{classmarlin_1_1MarlinSteerCheck}  




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

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
{\bfseries C\-C\-Processor} (bool status, const std\-::string \&name, const std\-::string \&type, {\bf String\-Parameters} $\ast$p=N\-U\-L\-L)\label{classmarlin_1_1CCProcessor_a6db296f081638331dc27ad2be7665c96}

\item 
{\bfseries C\-C\-Processor} ({\bf C\-C\-Processor} \&p)\label{classmarlin_1_1CCProcessor_ae79c6c89260c8a1c115b732d4c256af6}

\item 
bool {\bf has\-Errors} ()\label{classmarlin_1_1CCProcessor_a5c90888926c038d672ecb27d624f1ce0}

\begin{DoxyCompactList}\small\item\em Returns true if the processor has errors. \end{DoxyCompactList}\item 
bool {\bf has\-Parameters} ()\label{classmarlin_1_1CCProcessor_a8ef947afdf0943eff9ffb684bab8f704}

\begin{DoxyCompactList}\small\item\em Returns true if the processor has parameters. \end{DoxyCompactList}\item 
bool {\bf has\-Error\-Cols} ()\label{classmarlin_1_1CCProcessor_af5318f2d896f552463cca46ba7490dde}

\begin{DoxyCompactList}\small\item\em Returns true if the processor has collection errors. \end{DoxyCompactList}\item 
bool {\bf is\-Installed} ()\label{classmarlin_1_1CCProcessor_a2f698ff37c5cbb8d775393fe07ec6786}

\begin{DoxyCompactList}\small\item\em Returns true if the processor is installed. \end{DoxyCompactList}\item 
bool {\bf is\-Active} ()\label{classmarlin_1_1CCProcessor_a2c0be38e63e146da8f0017c281b30902}

\begin{DoxyCompactList}\small\item\em Returns true if the processor is active. \end{DoxyCompactList}\item 
bool {\bf has\-Condition} (const std\-::string \&condition)\label{classmarlin_1_1CCProcessor_af9849a3a455e6c1cc9d3765cb4ce04e4}

\begin{DoxyCompactList}\small\item\em Returns true if the processor is constrained by the given condition. \end{DoxyCompactList}\item 
const std\-::string \& {\bf get\-Name} ()\label{classmarlin_1_1CCProcessor_ad3778dbf4377f4dd8bf77620ddc54569}

\begin{DoxyCompactList}\small\item\em Returns the Name of the processor. \end{DoxyCompactList}\item 
const std\-::string \& {\bf get\-Type} ()\label{classmarlin_1_1CCProcessor_ada53569dc4b7731e1681469350d8a4ee}

\begin{DoxyCompactList}\small\item\em Returns the Type of the processor. \end{DoxyCompactList}\item 
s\-Set \& {\bf get\-Conditions} ()\label{classmarlin_1_1CCProcessor_af50eefeb1cbafc410eba8f3e311ff6ac}

\begin{DoxyCompactList}\small\item\em Returns the Conditions of the processor. \end{DoxyCompactList}\item 
const std\-::string {\bf get\-Description} ()\label{classmarlin_1_1CCProcessor_a2ed1e57ca1540c01e9c8bfbec84dc8e3}

\begin{DoxyCompactList}\small\item\em Returns the Description of the processor. \end{DoxyCompactList}\item 
const std\-::string {\bf get\-Error} ()\label{classmarlin_1_1CCProcessor_a75192ba2e56ff0aeea41874cef38983e}

\begin{DoxyCompactList}\small\item\em Returns a string with the error of the processor. \end{DoxyCompactList}\item 
const std\-::string {\bf get\-Status\-Desc} ()\label{classmarlin_1_1CCProcessor_a452927434c9bc3c25617561a26a4504a}

\begin{DoxyCompactList}\small\item\em Returns a string with the processor status ( \char`\"{}\-Active\char`\"{}, \char`\"{}\-Inactive\char`\"{} ) \end{DoxyCompactList}\item 
bool {\bf is\-Error\-Col} (const std\-::string \&type, const std\-::string \&value)\label{classmarlin_1_1CCProcessor_a9bcda8e35be00f4c493c7fa93dabc796}

\begin{DoxyCompactList}\small\item\em Returns true if the given collection is in the unavailable or duplicate list of this processor. \end{DoxyCompactList}\item 
bool {\bf is\-Param\-Optional} (const std\-::string \&key)\label{classmarlin_1_1CCProcessor_a64c8b97cd914630dfec108f4d8a395df}

\begin{DoxyCompactList}\small\item\em Returns true if a parameter is optional (optional means the parameter will be written out as a comment) \end{DoxyCompactList}\item 
{\bf String\-Parameters} $\ast$ {\bf get\-Parameters} ()\label{classmarlin_1_1CCProcessor_abf3b4418ad83c7b048ba262cc15d795f}

\begin{DoxyCompactList}\small\item\em Returns the string parameters for this processor. \end{DoxyCompactList}\item 
const ss\-Map \& {\bf get\-Col\-Headers} (const std\-::string \&iotype)\label{classmarlin_1_1CCProcessor_a224651adc7a6cbfa9f040db56e68f1ac}

\begin{DoxyCompactList}\small\item\em Returns a map with collection names and their respective types for I\-N\-P\-U\-T/\-O\-U\-T\-P\-U\-T collections of this processor. \end{DoxyCompactList}\item 
Col\-Vec \& {\bf get\-Cols} (const std\-::string \&iotype, const std\-::string \&type\-\_\-name=\char`\"{}A\-L\-L\-\_\-\-C\-O\-L\-L\-E\-C\-T\-I\-O\-N\-S\char`\"{})\label{classmarlin_1_1CCProcessor_a8134f5841e8bb592688590951dd3f1cc}

\begin{DoxyCompactList}\small\item\em Returns collections of a given iotype ( I\-N\-P\-U\-T, O\-U\-T\-P\-U\-T, U\-N\-A\-V\-A\-I\-L\-A\-B\-L\-E, D\-U\-P\-L\-I\-C\-A\-T\-E ) for a given name or type If iotype == I\-N\-P\-U\-T/\-O\-U\-T\-P\-U\-T then type\-\_\-name is the name of the collection If iotype == U\-N\-A\-V\-A\-I\-L\-A\-B\-L\-E/\-D\-U\-P\-L\-I\-C\-A\-T\-E then type\-\_\-name is the type of the collection. \end{DoxyCompactList}\item 
s\-Set \& {\bf get\-Col\-Type\-Names} (const std\-::string \&iotype)\label{classmarlin_1_1CCProcessor_abf956228fa28d98998123e6ac84795d2}

\begin{DoxyCompactList}\small\item\em Returns collection's types/names of a given iotype found in the processor If iotype == I\-N\-P\-U\-T/\-O\-U\-T\-P\-U\-T then names are returned If iotype == U\-N\-A\-V\-A\-I\-L\-A\-B\-L\-E/\-D\-U\-P\-L\-I\-C\-A\-T\-E then types are returned. \end{DoxyCompactList}\item 
void {\bf add\-Col} (const std\-::string \&iotype, const std\-::string \&name, const std\-::string \&type, const std\-::string \&value)\label{classmarlin_1_1CCProcessor_ad5859bf1b6ce401b3d96ec4a32ca5c10}

\begin{DoxyCompactList}\small\item\em Adds a collection of the given iotype ( I\-N\-P\-U\-T / O\-U\-T\-P\-U\-T ) with the given name, type and value. \end{DoxyCompactList}\item 
void {\bf rem\-Col} (const std\-::string \&iotype, const std\-::string \&name, unsigned int index)\label{classmarlin_1_1CCProcessor_a5b81c55ee737d045d8c887d77689196e}

\begin{DoxyCompactList}\small\item\em Removes collection of the given iotype ( I\-N\-P\-U\-T / O\-U\-T\-P\-U\-T ) with the given name at the given index. \end{DoxyCompactList}\item 
void {\bf add\-U\-Col} ({\bf C\-C\-Collection} $\ast$c)\label{classmarlin_1_1CCProcessor_a1b3844255ec81368862bc2dac9f31b48}

\begin{DoxyCompactList}\small\item\em Adds an unavailable collection to this processor. \end{DoxyCompactList}\item 
void {\bf add\-D\-Col} ({\bf C\-C\-Collection} $\ast$c)\label{classmarlin_1_1CCProcessor_a22d6b80a8b334c28d5841ecebb6ad582}

\begin{DoxyCompactList}\small\item\em Adds a duplicate collection to this processor. \end{DoxyCompactList}\item 
void {\bf change\-Status} ()\label{classmarlin_1_1CCProcessor_a564c9f27943628698fbdcda27f1e03db}

\begin{DoxyCompactList}\small\item\em Changes the processor status ( A\-C\-T\-I\-V\-E-\/$>$I\-N\-A\-C\-T\-I\-V\-E or I\-N\-A\-C\-T\-I\-V\-E-\/$>$A\-C\-T\-I\-V\-E ) \end{DoxyCompactList}\item 
void {\bf set\-Name} (const std\-::string \&name)\label{classmarlin_1_1CCProcessor_a642028ce54be3987206371cf0d7b5a04}

\begin{DoxyCompactList}\small\item\em Sets the processor's name. \end{DoxyCompactList}\item 
void {\bf set\-Conditions} (const std\-::string \&conditions)\label{classmarlin_1_1CCProcessor_a354a9b96f84c776167f204e64474c28a}

\begin{DoxyCompactList}\small\item\em Sets the processor's conditions. \end{DoxyCompactList}\item 
void {\bf set\-Error} (int error)\label{classmarlin_1_1CCProcessor_a9cf557d1d5dc8923b5eb428932e21488}

\begin{DoxyCompactList}\small\item\em Activates an error flag in this processor ( N\-O\-\_\-\-P\-A\-R\-A\-M\-E\-T\-E\-R\-S=0, N\-O\-T\-\_\-\-I\-N\-S\-T\-A\-L\-L\-E\-D=1, C\-O\-L\-\_\-\-E\-R\-R\-O\-R\-S=2 ) \end{DoxyCompactList}\item 
void {\bf clear\-Error} (int error)\label{classmarlin_1_1CCProcessor_ab2571c471251829413e1f0368927c9e1}

\begin{DoxyCompactList}\small\item\em Clears an error flag in this processor ( N\-O\-\_\-\-P\-A\-R\-A\-M\-E\-T\-E\-R\-S=0, N\-O\-T\-\_\-\-I\-N\-S\-T\-A\-L\-L\-E\-D=1, C\-O\-L\-\_\-\-E\-R\-R\-O\-R\-S=2 ) \end{DoxyCompactList}\item 
void {\bf set\-Optional\-Param} (const std\-::string \&key, bool optional=true)\label{classmarlin_1_1CCProcessor_aea30c7a6b9c331e784d719358e935729}

\begin{DoxyCompactList}\small\item\em Sets a parameter as optional (if optional=true parameter is written out as a comment) \end{DoxyCompactList}\item 
void {\bf write\-To\-X\-M\-L} (std\-::ofstream \&stream)\label{classmarlin_1_1CCProcessor_a26694376d26b1b596bde00d468248982}

\begin{DoxyCompactList}\small\item\em Writes this processor to a stream using the X\-M\-L format. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
handles information about marlin processors and their collections needed by \doxyref{Marlin\-Steer\-Check}{p.}{classmarlin_1_1MarlinSteerCheck} 

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

\end{DoxyVersion}
\begin{DoxyParagraph}{Id\-:}
\doxyref{C\-C\-Processor.\-h}{p.}{CCProcessor_8h_source},v 1.\-23 2007-\/01-\/11 16\-:56\-:37 engels Exp 
\end{DoxyParagraph}


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