\section{TPProto::Command\-Description Class Reference}
\label{classTPProto_1_1CommandDescription}\index{TPProto::CommandDescription@{TPProto::CommandDescription}}
A description of a command.  


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

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

\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
virtual {\bf $\sim$Command\-Description} ()
\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item 
void {\bf pack\-Buffer} ({\bf Buffer} $\ast$buf)
\begin{CompactList}\small\item\em Pack into a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}, assert(0). \item\end{CompactList}\item 
bool {\bf unpack\-Buffer} ({\bf Buffer} $\ast$buf)
\begin{CompactList}\small\item\em Unpack this \doxyref{Command\-Description}{p.}{classTPProto_1_1CommandDescription} from a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}. \item\end{CompactList}\item 
unsigned int {\bf get\-Command\-Type} ()
\begin{CompactList}\small\item\em Gets the command type number of this command description. \item\end{CompactList}\item 
std::string {\bf get\-Name} ()
\begin{CompactList}\small\item\em Gets the name of this command description. \item\end{CompactList}\item 
std::string {\bf get\-Description} ()
\begin{CompactList}\small\item\em Gets the text description of this command description. \item\end{CompactList}\item 
std::list$<$ Command\-Parameter $\ast$ $>$ {\bf get\-Parameters} ()
\begin{CompactList}\small\item\em Gets a copy of the Command\-Parameters in this command description. \item\end{CompactList}\item 
uint64\_\-t {\bf get\-Last\-Modified\-Time} ()
\begin{CompactList}\small\item\em Returns the timestamp of the last time this order description was modified. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
A description of a command. 



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


Destructor. 

Deletes the Command\-Parameters it contains. 

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


Pack into a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}, assert(0). 

This \doxyref{Frame}{p.}{classTPProto_1_1Frame} is only received from the server and therefore does not get packed on the client side. assert(0) is called. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buf}]The \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}, ignored. \end{description}
\end{Desc}


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


Unpack this \doxyref{Command\-Description}{p.}{classTPProto_1_1CommandDescription} from a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buf}]The \doxyref{Buffer}{p.}{classTPProto_1_1Buffer} to unpack out of. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]True if successful. \end{Desc}


Implements {\bf TPProto::Frame} \doxyref{}{p.}{classTPProto_1_1Frame_fe220a4229f471a3cc6a143f7a27e321}.\index{TPProto::CommandDescription@{TPProto::Command\-Description}!getCommandType@{getCommandType}}
\index{getCommandType@{getCommandType}!TPProto::CommandDescription@{TPProto::Command\-Description}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}unsigned int TPProto::Command\-Description::get\-Command\-Type ()}\label{classTPProto_1_1CommandDescription_5cfd00df39fc0e4c90d4f3945ca4b7be}


Gets the command type number of this command description. 

\begin{Desc}
\item[Returns:]The command type number. \end{Desc}
\index{TPProto::CommandDescription@{TPProto::Command\-Description}!getName@{getName}}
\index{getName@{getName}!TPProto::CommandDescription@{TPProto::Command\-Description}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}std::string TPProto::Command\-Description::get\-Name ()}\label{classTPProto_1_1CommandDescription_6c1d61d503e41ec68b9e345603df6ddf}


Gets the name of this command description. 

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


Gets the text description of this command description. 

\begin{Desc}
\item[Returns:]The text description of the command description. \end{Desc}
\index{TPProto::CommandDescription@{TPProto::Command\-Description}!getParameters@{getParameters}}
\index{getParameters@{getParameters}!TPProto::CommandDescription@{TPProto::Command\-Description}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}std::list$<$ Command\-Parameter $\ast$ $>$ TPProto::Command\-Description::get\-Parameters ()}\label{classTPProto_1_1CommandDescription_54c272f14e8e3a736cc2d7071d5b645a}


Gets a copy of the Command\-Parameters in this command description. 

\begin{Desc}
\item[Returns:]A copy of the list of Command\-Parameters. \end{Desc}
\index{TPProto::CommandDescription@{TPProto::Command\-Description}!getLastModifiedTime@{getLastModifiedTime}}
\index{getLastModifiedTime@{getLastModifiedTime}!TPProto::CommandDescription@{TPProto::Command\-Description}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint64\_\-t TPProto::Command\-Description::get\-Last\-Modified\-Time ()}\label{classTPProto_1_1CommandDescription_985789730deed6655d4582a4638c72a3}


Returns the timestamp of the last time this order description was modified. 

\begin{Desc}
\item[Returns:]The timestamp of the modification time. \end{Desc}


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