\hypertarget{classcore_1_1_command_list}{}\section{core\+:\+:Command\+List Class Reference}
\label{classcore_1_1_command_list}\index{core\+::\+Command\+List@{core\+::\+Command\+List}}


{\ttfamily \#include $<$Command\+List.\+h$>$}



Inheritance diagram for core\+:\+:Command\+List\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=182pt]{classcore_1_1_command_list__inherit__graph}
\end{center}
\end{figure}


Collaboration diagram for core\+:\+:Command\+List\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=182pt]{classcore_1_1_command_list__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classcore_1_1_command_list_a01b4af82ae73f41b4e8f5b587badde9d}{Command\+List} ()
\item 
\hyperlink{classcore_1_1_command_list_a2b5fdae9db6bf9876a5d51e987c49c7e}{$\sim$\+Command\+List} ()
\item 
void \hyperlink{classcore_1_1_command_list_a7a45e75e3d21a25fd3f7e887acf395e9}{add} (\hyperlink{classcore_1_1_command}{Command} \&command, std\+::string name=\char`\"{}\char`\"{})
\item 
\mbox{\Hypertarget{classcore_1_1_command_list_aaac684effb9ecf5238d23ca60d3fffaa}\label{classcore_1_1_command_list_aaac684effb9ecf5238d23ca60d3fffaa}} 
void {\bfseries remove} (\hyperlink{classcore_1_1_command}{Command} \&command)
\item 
\mbox{\Hypertarget{classcore_1_1_command_list_ac228423ab52b2b713167d6463e917871}\label{classcore_1_1_command_list_ac228423ab52b2b713167d6463e917871}} 
bool {\bfseries process\+Request} (std\+::string request, \hyperlink{classcore_1_1_session}{Session} $\ast$session, std\+::stringstream \&data)
\item 
int \hyperlink{classcore_1_1_command_list_a0e15a9fe0a156efe8eb0a03e4245c228}{process\+Command} (std\+::string request, \hyperlink{classcore_1_1_session}{Session} $\ast$session, std\+::stringstream \&data) override
\end{DoxyCompactItemize}
\subsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classcore_1_1_command_list_a435f09d15c78dad43e7bca4977d6bdf1}\label{classcore_1_1_command_list_a435f09d15c78dad43e7bca4977d6bdf1}} 
std\+::vector$<$ \hyperlink{classcore_1_1_command}{Command} $\ast$ $>$ {\bfseries commands}
\end{DoxyCompactItemize}
\subsection*{Additional Inherited Members}


\subsection{Detailed Description}
\hyperlink{classcore_1_1_command_list}{Command\+List}

This object organizes \hyperlink{classcore_1_1_command}{Command} objects into a list that is used to parse an input and run the process associated with the selected command. 

\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{classcore_1_1_command_list_a01b4af82ae73f41b4e8f5b587badde9d}\label{classcore_1_1_command_list_a01b4af82ae73f41b4e8f5b587badde9d}} 
\index{core\+::\+Command\+List@{core\+::\+Command\+List}!Command\+List@{Command\+List}}
\index{Command\+List@{Command\+List}!core\+::\+Command\+List@{core\+::\+Command\+List}}
\subsubsection{\texorpdfstring{Command\+List()}{CommandList()}}
{\footnotesize\ttfamily core\+::\+Command\+List\+::\+Command\+List (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}

The constructor for the object. \mbox{\Hypertarget{classcore_1_1_command_list_a2b5fdae9db6bf9876a5d51e987c49c7e}\label{classcore_1_1_command_list_a2b5fdae9db6bf9876a5d51e987c49c7e}} 
\index{core\+::\+Command\+List@{core\+::\+Command\+List}!````~Command\+List@{$\sim$\+Command\+List}}
\index{````~Command\+List@{$\sim$\+Command\+List}!core\+::\+Command\+List@{core\+::\+Command\+List}}
\subsubsection{\texorpdfstring{$\sim$\+Command\+List()}{~CommandList()}}
{\footnotesize\ttfamily core\+::\+Command\+List\+::$\sim$\+Command\+List (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}

The destructor for the object. 

\subsection{Member Function Documentation}
\mbox{\Hypertarget{classcore_1_1_command_list_a7a45e75e3d21a25fd3f7e887acf395e9}\label{classcore_1_1_command_list_a7a45e75e3d21a25fd3f7e887acf395e9}} 
\index{core\+::\+Command\+List@{core\+::\+Command\+List}!add@{add}}
\index{add@{add}!core\+::\+Command\+List@{core\+::\+Command\+List}}
\subsubsection{\texorpdfstring{add()}{add()}}
{\footnotesize\ttfamily void core\+::\+Command\+List\+::add (\begin{DoxyParamCaption}\item[{\hyperlink{classcore_1_1_command}{Command} \&}]{command,  }\item[{std\+::string}]{name = {\ttfamily \char`\"{}\char`\"{}} }\end{DoxyParamCaption})}

Add a new command to the command list and assign a default search value. \mbox{\Hypertarget{classcore_1_1_command_list_a0e15a9fe0a156efe8eb0a03e4245c228}\label{classcore_1_1_command_list_a0e15a9fe0a156efe8eb0a03e4245c228}} 
\index{core\+::\+Command\+List@{core\+::\+Command\+List}!process\+Command@{process\+Command}}
\index{process\+Command@{process\+Command}!core\+::\+Command\+List@{core\+::\+Command\+List}}
\subsubsection{\texorpdfstring{process\+Command()}{processCommand()}}
{\footnotesize\ttfamily int core\+::\+Command\+List\+::process\+Command (\begin{DoxyParamCaption}\item[{std\+::string}]{request,  }\item[{\hyperlink{classcore_1_1_session}{Session} $\ast$}]{session,  }\item[{std\+::stringstream \&}]{data }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [override]}, {\ttfamily [virtual]}}

This method is used to implement the functionality of the requested command. This pure virtual function must be implemented in your inheriting object.


\begin{DoxyParams}{Parameters}
{\em request} & The request that was entered by the user to invoke this command. \\
\hline
{\em session} & Specify the requesting session so that the execution of the command process can return its output to the session. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
Returns 0 if execution of the command was successful. Otherwise returns a non-\/zero value indicating an error condition. 
\end{DoxyReturn}


Reimplemented from \hyperlink{classcore_1_1_command_ab4a70ec0e419038d9cb2ea14573b7bb6}{core\+::\+Command}.



The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
/home/bradarant/barant/\+Server\+Core/Command\+List.\+h\item 
/home/bradarant/barant/\+Server\+Core/Command\+List.\+cpp\end{DoxyCompactItemize}
