\section{TPProto::Id\-Sequence Class Reference} \label{classTPProto_1_1IdSequence}\index{TPProto::IdSequence@{TPProto::IdSequence}} The \doxyref{Id\-Sequence}{p.}{classTPProto_1_1IdSequence} baseframe is the basis for receiving long lists of ids. {\tt \#include $<$idsequence.h$>$} Inheritance diagram for TPProto::Id\-Sequence::\begin{figure}[H] \begin{center} \leavevmode \includegraphics[height=12cm]{classTPProto_1_1IdSequence} \end{center} \end{figure} \subsection*{Public Member Functions} \begin{CompactItemize} \item {\bf Id\-Sequence} ()\label{classTPProto_1_1IdSequence_40c55a747dd299a1f302c91c282614e1} \begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item virtual {\bf $\sim$Id\-Sequence} ()\label{classTPProto_1_1IdSequence_62342d78e5e56128a0a6dc96155e1f81} \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}, asserts. \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}. Unpacks the \doxyref{Id\-Sequence}{p.}{classTPProto_1_1IdSequence} frame from the buffer. \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\-Remaining} () const \begin{CompactList}\small\item\em Gets the number of remaining ids to get. \item\end{CompactList}\item std::map$<$ uint32\_\-t, uint64\_\-t $>$ {\bf get\-Ids} () const \begin{CompactList}\small\item\em Gets the ids and modified time map. \item\end{CompactList}\item uint64\_\-t {\bf get\-Serial\-Start} () const \begin{CompactList}\small\item\em Gets the minimum serial number of the ids list. \item\end{CompactList}\end{CompactItemize} \subsection*{Protected Attributes} \begin{CompactItemize} \item uint32\_\-t {\bf seqkey}\label{classTPProto_1_1IdSequence_698b16e63ff3b30b03c2cfef45066727} \begin{CompactList}\small\item\em The sequence key for this sequence. \item\end{CompactList}\item uint32\_\-t {\bf remaining}\label{classTPProto_1_1IdSequence_aaa13997cc22c8e0eb45c2946eee5422} \begin{CompactList}\small\item\em The number of items remaining in the sequence to be fetched. \item\end{CompactList}\item std::map$<$ uint32\_\-t, uint64\_\-t $>$ {\bf idlist}\label{classTPProto_1_1IdSequence_d6f1aa7f77f532602c8c6ceb8a5d285b} \begin{CompactList}\small\item\em The map of ids and modification times. \item\end{CompactList}\item uint64\_\-t {\bf serial}\label{classTPProto_1_1IdSequence_ad936f7deb69882d24c1b5eff61f03a0} \begin{CompactList}\small\item\em The minimum serial number of the idlist. \item\end{CompactList}\end{CompactItemize} \subsection{Detailed Description} The \doxyref{Id\-Sequence}{p.}{classTPProto_1_1IdSequence} baseframe is the basis for receiving long lists of ids. \subsection{Member Function Documentation} \index{TPProto::IdSequence@{TPProto::Id\-Sequence}!packBuffer@{packBuffer}} \index{packBuffer@{packBuffer}!TPProto::IdSequence@{TPProto::Id\-Sequence}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void TPProto::Id\-Sequence::pack\-Buffer ({\bf Buffer} $\ast$ {\em buf})\hspace{0.3cm}{\tt [virtual]}}\label{classTPProto_1_1IdSequence_2255cea6f7cbe7204b6f5a500c6b3448} Pack into a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}, asserts. Packs this \doxyref{Id\-Sequence}{p.}{classTPProto_1_1IdSequence} frame into the buffer. Since the frame only comes from the server, this method assert(0). \begin{Desc} \item[Parameters:] \begin{description} \item[{\em buf}]\doxyref{Buffer}{p.}{classTPProto_1_1Buffer} to pack into, ignored. \end{description} \end{Desc} Implements {\bf TPProto::Frame} \doxyref{}{p.}{classTPProto_1_1Frame_67b50ee76e90385e56f04202ce1da67e}.\index{TPProto::IdSequence@{TPProto::Id\-Sequence}!unpackBuffer@{unpackBuffer}} \index{unpackBuffer@{unpackBuffer}!TPProto::IdSequence@{TPProto::Id\-Sequence}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool TPProto::Id\-Sequence::unpack\-Buffer ({\bf Buffer} $\ast$ {\em buf})\hspace{0.3cm}{\tt [virtual]}}\label{classTPProto_1_1IdSequence_742f69ba2a1d6cc0dde3c2c879faba2f} Unpack from a \doxyref{Buffer}{p.}{classTPProto_1_1Buffer}. Unpacks the \doxyref{Id\-Sequence}{p.}{classTPProto_1_1IdSequence} frame from the buffer. \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 sucessful, false otherwise. \end{Desc} Implements {\bf TPProto::Frame} \doxyref{}{p.}{classTPProto_1_1Frame_fe220a4229f471a3cc6a143f7a27e321}. Reimplemented in {\bf TPProto::Board\-Ids\-List} \doxyref{}{p.}{classTPProto_1_1BoardIdsList_402a22576d6caf410eb25c8f1524ac3e}, {\bf TPProto::Category\-Ids\-List} \doxyref{}{p.}{classTPProto_1_1CategoryIdsList_8657bea9358efff3447d391330942ca1}, {\bf TPProto::Command\-Types\-List} \doxyref{}{p.}{classTPProto_1_1CommandTypesList_46f6792fa90d349869073703c8ebd7e0}, {\bf TPProto::Component\-Ids\-List} \doxyref{}{p.}{classTPProto_1_1ComponentIdsList_776c94c0a6f72d8d0590793b6bfaf139}, {\bf TPProto::Design\-Ids\-List} \doxyref{}{p.}{classTPProto_1_1DesignIdsList_fe69eb24009509394cb788f4a887269c}, {\bf TPProto::Object\-Ids\-List} \doxyref{}{p.}{classTPProto_1_1ObjectIdsList_14120d7d2a7a250f67b8051e7c24477f}, {\bf TPProto::Object\-Types\-List} \doxyref{}{p.}{classTPProto_1_1ObjectTypesList_6faa2105397feff53f9d429182f12634}, {\bf TPProto::Order\-Types\-List} \doxyref{}{p.}{classTPProto_1_1OrderTypesList_7b0f515b52cac7ad75e3eb9d0ddad4ae}, {\bf TPProto::Property\-Ids\-List} \doxyref{}{p.}{classTPProto_1_1PropertyIdsList_fcea7a25e5b6b3d3d712a795b2e3bab2}, and {\bf TPProto::Resource\-Types\-List} \doxyref{}{p.}{classTPProto_1_1ResourceTypesList_29196fb78f2586a5b8006c9ec50fbd5e}.\index{TPProto::IdSequence@{TPProto::Id\-Sequence}!getSeqKey@{getSeqKey}} \index{getSeqKey@{getSeqKey}!TPProto::IdSequence@{TPProto::Id\-Sequence}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint32\_\-t TPProto::Id\-Sequence::get\-Seq\-Key () const}\label{classTPProto_1_1IdSequence_9cff36dbddbf8efaa49327ab3b7b912e} Gets the \doxyref{Sequence}{p.}{classTPProto_1_1Sequence} Key. Gets the value of the sequence key in use. \begin{Desc} \item[Returns:]The value of the seqkey. \end{Desc} \index{TPProto::IdSequence@{TPProto::Id\-Sequence}!getRemaining@{getRemaining}} \index{getRemaining@{getRemaining}!TPProto::IdSequence@{TPProto::Id\-Sequence}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint32\_\-t TPProto::Id\-Sequence::get\-Remaining () const}\label{classTPProto_1_1IdSequence_8f5d8cc46664cf36060949ea5d7f504e} Gets the number of remaining ids to get. Gets the value of the number of ids that remain in this sequence to get. \begin{Desc} \item[Returns:]The value of the number of ids remaining. \end{Desc} \index{TPProto::IdSequence@{TPProto::Id\-Sequence}!getIds@{getIds}} \index{getIds@{getIds}!TPProto::IdSequence@{TPProto::Id\-Sequence}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}std::map$<$ uint32\_\-t, uint64\_\-t $>$ TPProto::Id\-Sequence::get\-Ids () const}\label{classTPProto_1_1IdSequence_fb91514256b01b7aa43aa5a3a79b50ee} Gets the ids and modified time map. Gets the map of ids and modified time values that are in this part of the sequence.. \begin{Desc} \item[Returns:]The map of ids and modified time. \end{Desc} \index{TPProto::IdSequence@{TPProto::Id\-Sequence}!getSerialStart@{getSerialStart}} \index{getSerialStart@{getSerialStart}!TPProto::IdSequence@{TPProto::Id\-Sequence}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}uint64\_\-t TPProto::Id\-Sequence::get\-Serial\-Start () const}\label{classTPProto_1_1IdSequence_f8d8bca4f61f5c1eeca407ef1742c299} Gets the minimum serial number of the ids list. If -1, then only existing ids are in the list. If not, then ids that have changed (including disappearing) since the serial (modtime) given are in the list. \begin{Desc} \item[Returns:]The minimum serial number. \end{Desc} The documentation for this class was generated from the following files:\begin{CompactItemize} \item tpproto/{\bf idsequence.h}\item tpproto/idsequence.cpp\end{CompactItemize}