\hypertarget{classBWAPI_1_1Order}{\section{\-B\-W\-A\-P\-I\-:\-:\-Order \-Class \-Reference}
\label{classBWAPI_1_1Order}\index{\-B\-W\-A\-P\-I\-::\-Order@{\-B\-W\-A\-P\-I\-::\-Order}}
}


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



\-Inheritance diagram for \-B\-W\-A\-P\-I\-:\-:\-Order\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=160pt]{classBWAPI_1_1Order__inherit__graph}
\end{center}
\end{figure}


\-Collaboration diagram for \-B\-W\-A\-P\-I\-:\-:\-Order\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=160pt]{classBWAPI_1_1Order__coll__graph}
\end{center}
\end{figure}
\subsection*{\-Public \-Member \-Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classBWAPI_1_1Order_a14624417a600dba438f3974cc698276f}{\-Order} ()
\item 
\hyperlink{classBWAPI_1_1Order_a8283a6adfa0f01c90196d9c68ae2eec5}{\-Order} (\hyperlink{Detours_8h_ab5a791e918b09a41addbf5b813175633}{int} id)
\item 
const std\-::string \& \hyperlink{classBWAPI_1_1Order_ad193f3b4a232fddff6e744c6f4943cad}{get\-Name} () const 
\item 
const char $\ast$ \hyperlink{classBWAPI_1_1Order_afe5c18275a807aa52acd0dd0d38e548a}{c\-\_\-str} () const 
\end{DoxyCompactItemize}


\subsection{\-Detailed \-Description}
\-To get detailed information about what a unit is doing, you can use the \hyperlink{classBWAPI_1_1Unit_a31b5096167e31ee85af6c6686956b8c1}{\-Unit\-::get\-Order} method, which will return an \hyperlink{classBWAPI_1_1Order}{\-Order} object. \-Note that a single command, like gather minerals, can consist of several orders ( \-Move\-To\-Minerals, \-Harvest\-Minerals2, \-Mining\-Minerals, \-Return\-Minerals, etc) which will indicate what state the unit is in while executing the command. \-For information about how to issue commands to units, go to \hyperlink{classBWAPI_1_1Unit}{\-Unit}. 

\subsection{\-Constructor \& \-Destructor \-Documentation}
\hypertarget{classBWAPI_1_1Order_a14624417a600dba438f3974cc698276f}{\index{\-B\-W\-A\-P\-I\-::\-Order@{\-B\-W\-A\-P\-I\-::\-Order}!\-Order@{\-Order}}
\index{\-Order@{\-Order}!BWAPI::Order@{\-B\-W\-A\-P\-I\-::\-Order}}
\subsubsection[{\-Order}]{\setlength{\rightskip}{0pt plus 5cm}{\bf \-B\-W\-A\-P\-I\-::\-Order\-::\-Order} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{classBWAPI_1_1Order_a14624417a600dba438f3974cc698276f}
\hypertarget{classBWAPI_1_1Order_a8283a6adfa0f01c90196d9c68ae2eec5}{\index{\-B\-W\-A\-P\-I\-::\-Order@{\-B\-W\-A\-P\-I\-::\-Order}!\-Order@{\-Order}}
\index{\-Order@{\-Order}!BWAPI::Order@{\-B\-W\-A\-P\-I\-::\-Order}}
\subsubsection[{\-Order}]{\setlength{\rightskip}{0pt plus 5cm}{\bf \-B\-W\-A\-P\-I\-::\-Order\-::\-Order} (
\begin{DoxyParamCaption}
\item[{{\bf int}}]{id}
\end{DoxyParamCaption}
)}}\label{classBWAPI_1_1Order_a8283a6adfa0f01c90196d9c68ae2eec5}


\subsection{\-Member \-Function \-Documentation}
\hypertarget{classBWAPI_1_1Order_afe5c18275a807aa52acd0dd0d38e548a}{\index{\-B\-W\-A\-P\-I\-::\-Order@{\-B\-W\-A\-P\-I\-::\-Order}!c\-\_\-str@{c\-\_\-str}}
\index{c\-\_\-str@{c\-\_\-str}!BWAPI::Order@{\-B\-W\-A\-P\-I\-::\-Order}}
\subsubsection[{c\-\_\-str}]{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ {\bf \-B\-W\-A\-P\-I\-::\-Order\-::c\-\_\-str} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}\label{classBWAPI_1_1Order_afe5c18275a807aa52acd0dd0d38e548a}


\-Here is the call graph for this function\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=332pt]{classBWAPI_1_1Order_afe5c18275a807aa52acd0dd0d38e548a_cgraph}
\end{center}
\end{figure}




\-Here is the caller graph for this function\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classBWAPI_1_1Order_afe5c18275a807aa52acd0dd0d38e548a_icgraph}
\end{center}
\end{figure}


\hypertarget{classBWAPI_1_1Order_ad193f3b4a232fddff6e744c6f4943cad}{\index{\-B\-W\-A\-P\-I\-::\-Order@{\-B\-W\-A\-P\-I\-::\-Order}!get\-Name@{get\-Name}}
\index{get\-Name@{get\-Name}!BWAPI::Order@{\-B\-W\-A\-P\-I\-::\-Order}}
\subsubsection[{get\-Name}]{\setlength{\rightskip}{0pt plus 5cm}const std\-::string \& {\bf \-B\-W\-A\-P\-I\-::\-Order\-::get\-Name} (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}\label{classBWAPI_1_1Order_ad193f3b4a232fddff6e744c6f4943cad}
\-Returns the name of this order. 

\-Here is the call graph for this function\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classBWAPI_1_1Order_ad193f3b4a232fddff6e744c6f4943cad_cgraph}
\end{center}
\end{figure}




\-Here is the caller graph for this function\-:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classBWAPI_1_1Order_ad193f3b4a232fddff6e744c6f4943cad_icgraph}
\end{center}
\end{figure}




\-The documentation for this class was generated from the following files\-:\begin{DoxyCompactItemize}
\item 
trunk/bwapi/include/\-B\-W\-A\-P\-I/\hyperlink{include_2BWAPI_2Order_8h}{\-Order.\-h}\item 
trunk/bwapi/\-B\-W\-A\-P\-I\-L\-I\-B/\-Source/\hyperlink{Order_8cpp}{\-Order.\-cpp}\end{DoxyCompactItemize}
