\section{TPProto::Get\-Order Class Reference}
\label{classTPProto_1_1GetOrder}\index{TPProto::GetOrder@{TPProto::GetOrder}}
A \doxyref{Frame}{p.}{classTPProto_1_1Frame} to get Orders from an \doxyref{Object}{p.}{classTPProto_1_1Object} on the server.  


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

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

\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
virtual {\bf $\sim$Get\-Order} ()\label{classTPProto_1_1GetOrder_08ee8290f02be7f6384ec03ee4546f43}

\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{Get\-Order}{p.}{classTPProto_1_1GetOrder} \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}, always false. \item\end{CompactList}\item 
void {\bf set\-Object\-Id} (unsigned int obid)\label{classTPProto_1_1GetOrder_ec6390527d2b9c1c18073ca8c94abf15}

\begin{CompactList}\small\item\em Sets the \doxyref{Object}{p.}{classTPProto_1_1Object} id of the \doxyref{Object}{p.}{classTPProto_1_1Object} the Orders are on. /param obid The object id number. \item\end{CompactList}\item 
void {\bf add\-Order\-Id} (unsigned int id)
\begin{CompactList}\small\item\em Adds a signle \doxyref{Order}{p.}{classTPProto_1_1Order} id to get. \item\end{CompactList}\item 
void {\bf add\-Order\-Ids} (std::set$<$ unsigned int $>$ ids)
\begin{CompactList}\small\item\em Adds a set of \doxyref{Order}{p.}{classTPProto_1_1Order} ids to the set to request. \item\end{CompactList}\item 
void {\bf add\-Order\-Range} (unsigned int start, unsigned int end)
\begin{CompactList}\small\item\em Adds a range of \doxyref{Order}{p.}{classTPProto_1_1Order} ids to the set to request. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
A \doxyref{Frame}{p.}{classTPProto_1_1Frame} to get Orders from an \doxyref{Object}{p.}{classTPProto_1_1Object} on the server. 



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


Pack this \doxyref{Get\-Order}{p.}{classTPProto_1_1GetOrder} \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::GetOrder@{TPProto::Get\-Order}!unpackBuffer@{unpackBuffer}}
\index{unpackBuffer@{unpackBuffer}!TPProto::GetOrder@{TPProto::Get\-Order}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool TPProto::Get\-Order::unpack\-Buffer ({\bf Buffer} $\ast$ {\em buf})\hspace{0.3cm}{\tt  [virtual]}}\label{classTPProto_1_1GetOrder_d3cb3ef6362a23c94b48e9918470ebda}


Unpack from a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}, always false. 

Since \doxyref{Get\-Order}{p.}{classTPProto_1_1GetOrder} frames are only sent to the server, we should not receive them and therefore this method always returns false. \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em buf}]The \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}, 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::GetOrder@{TPProto::Get\-Order}!addOrderId@{addOrderId}}
\index{addOrderId@{addOrderId}!TPProto::GetOrder@{TPProto::Get\-Order}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Get\-Order::add\-Order\-Id (unsigned int {\em id})}\label{classTPProto_1_1GetOrder_8fc2ba63f0b7419fa61bd981538792a1}


Adds a signle \doxyref{Order}{p.}{classTPProto_1_1Order} id to get. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em id}]The order id to get. \end{description}
\end{Desc}
\index{TPProto::GetOrder@{TPProto::Get\-Order}!addOrderIds@{addOrderIds}}
\index{addOrderIds@{addOrderIds}!TPProto::GetOrder@{TPProto::Get\-Order}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Get\-Order::add\-Order\-Ids (std::set$<$ unsigned int $>$ {\em ids})}\label{classTPProto_1_1GetOrder_547954388ff6f81db2ac44fd3dc50e0c}


Adds a set of \doxyref{Order}{p.}{classTPProto_1_1Order} ids to the set to request. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ids}]The set of order ids to get. \end{description}
\end{Desc}
\index{TPProto::GetOrder@{TPProto::Get\-Order}!addOrderRange@{addOrderRange}}
\index{addOrderRange@{addOrderRange}!TPProto::GetOrder@{TPProto::Get\-Order}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Get\-Order::add\-Order\-Range (unsigned int {\em start}, unsigned int {\em end})}\label{classTPProto_1_1GetOrder_9f8cc569725b1db3c0073122754cfd85}


Adds a range of \doxyref{Order}{p.}{classTPProto_1_1Order} ids to the set to request. 

The range is inclusive of the start id, and exclusive of the end. This allows clients to get all orders by going add\-Order\-Range(0, object-$>$get\-Number\-Orders()). \begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em start}]The first message id to get. \item[{\em end}]One greater than the last message id to get. \end{description}
\end{Desc}


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