\section{TPProto::Command Class Reference}
\label{classTPProto_1_1Command}\index{TPProto::Command@{TPProto::Command}}
An administration command frame.  


{\tt \#include $<$command.h$>$}

Inheritance diagram for TPProto::Command::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2cm]{classTPProto_1_1Command}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Command} ()\label{classTPProto_1_1Command_dde295743f69b0d464ae61cd2978b717}

\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
virtual {\bf $\sim$Command} ()
\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item 
void {\bf pack\-Buffer} ({\bf Buffer} $\ast$buf)
\begin{CompactList}\small\item\em Pack this \doxyref{Command}{p.}{classTPProto_1_1Command} \doxyref{Frame}{p.}{classTPProto_1_1Frame} into a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}. \item\end{CompactList}\item 
bool {\bf unpack\-Buffer} ({\bf Buffer} $\ast$buf)
\begin{CompactList}\small\item\em Unpack from a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}, fails always. \doxyref{Command}{p.}{classTPProto_1_1Command} frames are only sent to the server, so unpacking is not needed. \item\end{CompactList}\item 
std::string {\bf get\-Name} ()
\begin{CompactList}\small\item\em Gets the name of this command type. \item\end{CompactList}\item 
std::string {\bf get\-Description} ()
\begin{CompactList}\small\item\em Gets the text description of this command type. \item\end{CompactList}\item 
unsigned int {\bf get\-Command\-Type} ()
\begin{CompactList}\small\item\em Gets the command type number of this command. \item\end{CompactList}\item 
unsigned int {\bf get\-Num\-Parameters} ()
\begin{CompactList}\small\item\em Gets the number of Command\-Parameters this command has. \item\end{CompactList}\item 
Command\-Parameter $\ast$ {\bf get\-Parameter} (unsigned int which)
\begin{CompactList}\small\item\em Gets a Command\-Parameter. \item\end{CompactList}\item 
void {\bf set\-Command\-Type} (boost::shared\_\-ptr$<$ {\bf Command\-Description} $>$ cd)
\begin{CompactList}\small\item\em Sets the command type using a \doxyref{Command\-Description}{p.}{classTPProto_1_1CommandDescription}. \item\end{CompactList}\item 
void {\bf fill\-Parameter\-List} (std::list$<$ Command\-Parameter $\ast$ $>$ plist)
\begin{CompactList}\small\item\em Fills the parameter list with valued parameters. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
An administration command frame. 



\subsection{Constructor \& Destructor Documentation}
\index{TPProto::Command@{TPProto::Command}!~Command@{$\sim$Command}}
\index{~Command@{$\sim$Command}!TPProto::Command@{TPProto::Command}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}TPProto::Command::$\sim$Command ()\hspace{0.3cm}{\tt  [virtual]}}\label{classTPProto_1_1Command_47cd4e5cb40f942f400c58ad79d70bd3}


Destructor. 

Deletes the Command\-Parameters it contains. 

\subsection{Member Function Documentation}
\index{TPProto::Command@{TPProto::Command}!packBuffer@{packBuffer}}
\index{packBuffer@{packBuffer}!TPProto::Command@{TPProto::Command}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Command::pack\-Buffer ({\bf Buffer} $\ast$ {\em buf})\hspace{0.3cm}{\tt  [virtual]}}\label{classTPProto_1_1Command_e6d8736b9cfd752fc90a6319fdde2aaa}


Pack this \doxyref{Command}{p.}{classTPProto_1_1Command} \doxyref{Frame}{p.}{classTPProto_1_1Frame} into a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buf}]The \doxyref{Buffer}{p.}{classTPProto_1_1Buffer} to pack into. \end{description}
\end{Desc}


Implements {\bf TPProto::Frame} \doxyref{}{p.}{classTPProto_1_1Frame_67b50ee76e90385e56f04202ce1da67e}.\index{TPProto::Command@{TPProto::Command}!unpackBuffer@{unpackBuffer}}
\index{unpackBuffer@{unpackBuffer}!TPProto::Command@{TPProto::Command}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool TPProto::Command::unpack\-Buffer ({\bf Buffer} $\ast$ {\em buf})\hspace{0.3cm}{\tt  [virtual]}}\label{classTPProto_1_1Command_60f7322de54935491e50e81a36bf9c79}


Unpack from a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}, fails always. \doxyref{Command}{p.}{classTPProto_1_1Command} frames are only sent to the server, so unpacking is not needed. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buf}]The \doxyref{Buffer}{p.}{classTPProto_1_1Buffer} to unpack out of, ignored. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]False always. \end{Desc}


Implements {\bf TPProto::Frame} \doxyref{}{p.}{classTPProto_1_1Frame_fe220a4229f471a3cc6a143f7a27e321}.\index{TPProto::Command@{TPProto::Command}!getName@{getName}}
\index{getName@{getName}!TPProto::Command@{TPProto::Command}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}std::string TPProto::Command::get\-Name ()}\label{classTPProto_1_1Command_96b8c8b74d5ebccce82c3a680f276ebe}


Gets the name of this command type. 

\begin{Desc}
\item[Returns:]The name of the command. \end{Desc}
\index{TPProto::Command@{TPProto::Command}!getDescription@{getDescription}}
\index{getDescription@{getDescription}!TPProto::Command@{TPProto::Command}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}std::string TPProto::Command::get\-Description ()}\label{classTPProto_1_1Command_be9ad6449d7631cc9f512f15962fa626}


Gets the text description of this command type. 

\begin{Desc}
\item[Returns:]The text description of the command. \end{Desc}
\index{TPProto::Command@{TPProto::Command}!getCommandType@{getCommandType}}
\index{getCommandType@{getCommandType}!TPProto::Command@{TPProto::Command}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}unsigned int TPProto::Command::get\-Command\-Type ()}\label{classTPProto_1_1Command_2d5c06d43b57005fa271ef6b0ef6b1e0}


Gets the command type number of this command. 

\begin{Desc}
\item[Returns:]The command type number. \end{Desc}
\index{TPProto::Command@{TPProto::Command}!getNumParameters@{getNumParameters}}
\index{getNumParameters@{getNumParameters}!TPProto::Command@{TPProto::Command}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}unsigned int TPProto::Command::get\-Num\-Parameters ()}\label{classTPProto_1_1Command_a4d1797fbe159813b04db85d60e99b04}


Gets the number of Command\-Parameters this command has. 

\begin{Desc}
\item[Returns:]The number of parameters. \end{Desc}
\index{TPProto::Command@{TPProto::Command}!getParameter@{getParameter}}
\index{getParameter@{getParameter}!TPProto::Command@{TPProto::Command}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Command\-Parameter $\ast$ TPProto::Command::get\-Parameter (unsigned int {\em which})}\label{classTPProto_1_1Command_5b45804c61f9a7ee7adbc8b70918bc2e}


Gets a Command\-Parameter. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em which}]The number of the parameter to get. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The which-th Command\-Parameter on this order or NULL if which is not valid. \end{Desc}
\index{TPProto::Command@{TPProto::Command}!setCommandType@{setCommandType}}
\index{setCommandType@{setCommandType}!TPProto::Command@{TPProto::Command}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Command::set\-Command\-Type (boost::shared\_\-ptr$<$ {\bf Command\-Description} $>$ {\em cd})}\label{classTPProto_1_1Command_aa6d9692d4a34beda2007e1529ca1fcd}


Sets the command type using a \doxyref{Command\-Description}{p.}{classTPProto_1_1CommandDescription}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em cd}]The \doxyref{Command\-Description}{p.}{classTPProto_1_1CommandDescription} describing the command type required. \end{description}
\end{Desc}
\index{TPProto::Command@{TPProto::Command}!fillParameterList@{fillParameterList}}
\index{fillParameterList@{fillParameterList}!TPProto::Command@{TPProto::Command}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Command::fill\-Parameter\-List (std::list$<$ Command\-Parameter $\ast$ $>$ {\em plist})}\label{classTPProto_1_1Command_2360079bb70806d21160acfd2c77c15a}


Fills the parameter list with valued parameters. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em plist}]The valued parameter list. \end{description}
\end{Desc}


The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
tpproto/{\bf command.h}\item 
tpproto/command.cpp\end{CompactItemize}