\section{TPProto::Get\-Id\-Sequence Class Reference} \label{classTPProto_1_1GetIdSequence}\index{TPProto::GetIdSequence@{TPProto::GetIdSequence}} The \doxyref{Get\-Id\-Sequence}{p.}{classTPProto_1_1GetIdSequence} baseframe is used to get long lists of Ids from the server. {\tt \#include $<$getidsequence.h$>$} Inheritance diagram for TPProto::Get\-Id\-Sequence::\begin{figure}[H] \begin{center} \leavevmode \includegraphics[height=12cm]{classTPProto_1_1GetIdSequence} \end{center} \end{figure} \subsection*{Public Member Functions} \begin{CompactItemize} \item {\bf Get\-Id\-Sequence} ()\label{classTPProto_1_1GetIdSequence_85a210e005b5198ca92d7e05c2fd5fe8} \begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item virtual {\bf $\sim$Get\-Id\-Sequence} ()\label{classTPProto_1_1GetIdSequence_f76fa697b4fa515efc2d92141c02f105} \begin{CompactList}\small\item\em Required virtual 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}. \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. Since \doxyref{Get\-Id\-Sequence}{p.}{classTPProto_1_1GetIdSequence} baseframes are only sent to the server, unpacking one doesn't make sence, and therefore always returns false. \item\end{CompactList}\item void {\bf set\-Seq\-Key} (uint32\_\-t key) \begin{CompactList}\small\item\em Sets the \doxyref{Sequence}{p.}{classTPProto_1_1Sequence} Key. \item\end{CompactList}\item void {\bf set\-Offset} (uint32\_\-t os) \begin{CompactList}\small\item\em Sets the Offset to start at. \item\end{CompactList}\item void {\bf set\-Count} (uint32\_\-t c) \begin{CompactList}\small\item\em Sets the number of ids to get. \item\end{CompactList}\item void {\bf set\-Serial\-Start} (uint64\_\-t ss) \begin{CompactList}\small\item\em Sets the lowest serial number to get. \item\end{CompactList}\item uint32\_\-t {\bf get\-Seq\-Key} () const \begin{CompactList}\small\item\em Gets the \doxyref{Sequence}{p.}{classTPProto_1_1Sequence} Key. \item\end{CompactList}\item uint32\_\-t {\bf get\-Offset} () const \begin{CompactList}\small\item\em Gets the offset to start the id sequence at. \item\end{CompactList}\item uint32\_\-t {\bf get\-Count} () const \begin{CompactList}\small\item\em Gets the number of ids to get. \item\end{CompactList}\item uint64\_\-t {\bf get\-Serial\-Start} () const \begin{CompactList}\small\item\em Gets the minimum serial number that the reply will have. \item\end{CompactList}\end{CompactItemize} \subsection*{Protected Attributes} \begin{CompactItemize} \item uint32\_\-t {\bf seqkey}\label{classTPProto_1_1GetIdSequence_2f97544a3121740499a61b4bb44d3376} \begin{CompactList}\small\item\em The sequence key of the sequence to continue. Set to 0 if not know and to get a new one. \item\end{CompactList}\item uint32\_\-t {\bf offset}\label{classTPProto_1_1GetIdSequence_baeb36878d377cd2657b3cf899265c26} \begin{CompactList}\small\item\em The offset in the sequence to get from. \item\end{CompactList}\item uint32\_\-t {\bf count}\label{classTPProto_1_1GetIdSequence_f70ceafedf56a63b298ad223483a1b70} \begin{CompactList}\small\item\em The number of ids to get. \item\end{CompactList}\item uint64\_\-t {\bf serial}\label{classTPProto_1_1GetIdSequence_90e8eaaf4cc5a90d89bfb12fdbf51e47} \begin{CompactList}\small\item\em The lowest serial number to start with. \item\end{CompactList}\end{CompactItemize} \subsection{Detailed Description} The \doxyref{Get\-Id\-Sequence}{p.}{classTPProto_1_1GetIdSequence} baseframe is used to get long lists of Ids from the server. \subsection{Member Function Documentation} \index{TPProto::GetIdSequence@{TPProto::Get\-Id\-Sequence}!packBuffer@{packBuffer}} \index{packBuffer@{packBuffer}!TPProto::GetIdSequence@{TPProto::Get\-Id\-Sequence}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Get\-Id\-Sequence::pack\-Buffer ({\bf Buffer} $\ast$ {\em buf})\hspace{0.3cm}{\tt [virtual]}}\label{classTPProto_1_1GetIdSequence_976c93d1321c10d2aba7c8b43c91630c} Pack into a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}. Packs this \doxyref{Get\-Id\-Sequence}{p.}{classTPProto_1_1GetIdSequence} frame into the buffer. \begin{Desc} \item[Parameters:] \begin{description} \item[{\em buf}]\doxyref{Buffer}{p.}{classTPProto_1_1Buffer} to pack into. \end{description} \end{Desc} Implements {\bf TPProto::Frame} \doxyref{}{p.}{classTPProto_1_1Frame_67b50ee76e90385e56f04202ce1da67e}. Reimplemented in {\bf TPProto::Get\-Board\-Ids\-List} \doxyref{}{p.}{classTPProto_1_1GetBoardIdsList_95b89ca4fba530fb20182d4563f22811}, {\bf TPProto::Get\-Category\-Ids\-List} \doxyref{}{p.}{classTPProto_1_1GetCategoryIdsList_e104921d3765994df4a646fa79b37a7c}, {\bf TPProto::Get\-Command\-Types\-List} \doxyref{}{p.}{classTPProto_1_1GetCommandTypesList_c89351802cbf988bc76508751432add8}, {\bf TPProto::Get\-Component\-Ids\-List} \doxyref{}{p.}{classTPProto_1_1GetComponentIdsList_8ec7e78caa051890d4c6afaa848e59bb}, {\bf TPProto::Get\-Design\-Ids\-List} \doxyref{}{p.}{classTPProto_1_1GetDesignIdsList_10cbb137f282c17ce1d37d5889837b05}, {\bf TPProto::Get\-Object\-Ids\-List} \doxyref{}{p.}{classTPProto_1_1GetObjectIdsList_ae38436707954c34bc57d845d79e5dd3}, {\bf TPProto::Get\-Object\-Types\-List} \doxyref{}{p.}{classTPProto_1_1GetObjectTypesList_aae4e28047ea19014efc66caaf50512f}, {\bf TPProto::Get\-Order\-Types\-List} \doxyref{}{p.}{classTPProto_1_1GetOrderTypesList_c6706ff8111fc2bd882b7660da3ce18b}, {\bf TPProto::Get\-Property\-Ids\-List} \doxyref{}{p.}{classTPProto_1_1GetPropertyIdsList_88b1c7c95d1696a4b19589a027e070fd}, and {\bf TPProto::Get\-Resource\-Types\-List} \doxyref{}{p.}{classTPProto_1_1GetResourceTypesList_0061923dc4e795c5f6ea2dcc165b0ab8}.\index{TPProto::GetIdSequence@{TPProto::Get\-Id\-Sequence}!unpackBuffer@{unpackBuffer}} \index{unpackBuffer@{unpackBuffer}!TPProto::GetIdSequence@{TPProto::Get\-Id\-Sequence}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool TPProto::Get\-Id\-Sequence::unpack\-Buffer ({\bf Buffer} $\ast$ {\em buf})\hspace{0.3cm}{\tt [virtual]}}\label{classTPProto_1_1GetIdSequence_0382eac8969effea0e9493b1e0c8b328} Unpack from a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}, fails always. Since \doxyref{Get\-Id\-Sequence}{p.}{classTPProto_1_1GetIdSequence} baseframes are only sent to the server, unpacking one doesn't make sence, and therefore always returns false. \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::GetIdSequence@{TPProto::Get\-Id\-Sequence}!setSeqKey@{setSeqKey}} \index{setSeqKey@{setSeqKey}!TPProto::GetIdSequence@{TPProto::Get\-Id\-Sequence}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Get\-Id\-Sequence::set\-Seq\-Key (uint32\_\-t {\em key})}\label{classTPProto_1_1GetIdSequence_ce894a224155d0188830988b6a1c6ca3} Sets the \doxyref{Sequence}{p.}{classTPProto_1_1Sequence} Key. Sets the value of the sequence key to use. Set to 0xffffffff (-1) to get the server to give you a new key. \begin{Desc} \item[Parameters:] \begin{description} \item[{\em key}]The value of the seqkey. \end{description} \end{Desc} \index{TPProto::GetIdSequence@{TPProto::Get\-Id\-Sequence}!setOffset@{setOffset}} \index{setOffset@{setOffset}!TPProto::GetIdSequence@{TPProto::Get\-Id\-Sequence}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Get\-Id\-Sequence::set\-Offset (uint32\_\-t {\em os})}\label{classTPProto_1_1GetIdSequence_486c13d6dd8a08b2d73f8b1520df4e64} Sets the Offset to start at. Sets the value of the offset to start the id sequence at. \begin{Desc} \item[Parameters:] \begin{description} \item[{\em os}]The value of the offset. \end{description} \end{Desc} \index{TPProto::GetIdSequence@{TPProto::Get\-Id\-Sequence}!setCount@{setCount}} \index{setCount@{setCount}!TPProto::GetIdSequence@{TPProto::Get\-Id\-Sequence}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Get\-Id\-Sequence::set\-Count (uint32\_\-t {\em c})}\label{classTPProto_1_1GetIdSequence_dd01b6060d942653566f932f02f5332c} Sets the number of ids to get. Sets the value of the number of ids to get. \begin{Desc} \item[Parameters:] \begin{description} \item[{\em c}]The value of the number of ids to get. \end{description} \end{Desc} \index{TPProto::GetIdSequence@{TPProto::Get\-Id\-Sequence}!setSerialStart@{setSerialStart}} \index{setSerialStart@{setSerialStart}!TPProto::GetIdSequence@{TPProto::Get\-Id\-Sequence}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Get\-Id\-Sequence::set\-Serial\-Start (uint64\_\-t {\em ss})}\label{classTPProto_1_1GetIdSequence_bafd17ccd7d8ecec5d44a1b027f181ac} Sets the lowest serial number to get. If -1 (default) all objects will be fetched. If this is not -1, no serial number (modtime) will be lower that this value, and ID's that no longer exist will be in the list. \begin{Desc} \item[Parameters:] \begin{description} \item[{\em ss}]The minimum value of the serial. \end{description} \end{Desc} \index{TPProto::GetIdSequence@{TPProto::Get\-Id\-Sequence}!getSeqKey@{getSeqKey}} \index{getSeqKey@{getSeqKey}!TPProto::GetIdSequence@{TPProto::Get\-Id\-Sequence}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint32\_\-t TPProto::Get\-Id\-Sequence::get\-Seq\-Key () const}\label{classTPProto_1_1GetIdSequence_1439f6db8749693989d6ca1af4833523} Gets the \doxyref{Sequence}{p.}{classTPProto_1_1Sequence} Key. Gets the value of the sequence key to use. If is 0xffffffff (-1) the server will generate a new key. \begin{Desc} \item[Returns:]The value of the seqkey. \end{Desc} \index{TPProto::GetIdSequence@{TPProto::Get\-Id\-Sequence}!getOffset@{getOffset}} \index{getOffset@{getOffset}!TPProto::GetIdSequence@{TPProto::Get\-Id\-Sequence}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint32\_\-t TPProto::Get\-Id\-Sequence::get\-Offset () const}\label{classTPProto_1_1GetIdSequence_c63d9dc23e09f78834e562064f400584} Gets the offset to start the id sequence at. Gets the value of the offset the id sequence will be started at. \begin{Desc} \item[Returns:]The value of the offset. \end{Desc} \index{TPProto::GetIdSequence@{TPProto::Get\-Id\-Sequence}!getCount@{getCount}} \index{getCount@{getCount}!TPProto::GetIdSequence@{TPProto::Get\-Id\-Sequence}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint32\_\-t TPProto::Get\-Id\-Sequence::get\-Count () const}\label{classTPProto_1_1GetIdSequence_35fe2375367f7232ffd54ab1c8157514} Gets the number of ids to get. Gets the value of the number of ids this frame will get. \begin{Desc} \item[Returns:]The value of the number of ids to get. \end{Desc} \index{TPProto::GetIdSequence@{TPProto::Get\-Id\-Sequence}!getSerialStart@{getSerialStart}} \index{getSerialStart@{getSerialStart}!TPProto::GetIdSequence@{TPProto::Get\-Id\-Sequence}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint64\_\-t TPProto::Get\-Id\-Sequence::get\-Serial\-Start () const}\label{classTPProto_1_1GetIdSequence_702c744e5fa93a28e11baf286eac5236} Gets the minimum serial number that the reply will have. \begin{Desc} \item[Returns:]The value of the starting serial number. \end{Desc} The documentation for this class was generated from the following files:\begin{CompactItemize} \item tpproto/{\bf getidsequence.h}\item tpproto/getidsequence.cpp\end{CompactItemize}