\hypertarget{class_qore_1_1_object_reverse_iterator}{}\doxysection{Qore\+::Object\+Reverse\+Iterator Class Reference} \label{class_qore_1_1_object_reverse_iterator}\index{Qore::ObjectReverseIterator@{Qore::ObjectReverseIterator}} This class an iterator class for objects. Inheritance diagram for Qore\+::Object\+Reverse\+Iterator\+: % FIG 0 \doxysubsection*{Public Member Functions} \begin{DoxyCompactItemize} \item \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a4e5a5820ca50ccb9bf9be17fd54b42c1}{constructor}} (object o) \begin{DoxyCompactList}\small\item\em Creates the object iterator object. \end{DoxyCompactList}\item \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a6856126a844e025d8dbf5d4c7bcc84a5}{constructor}} () \begin{DoxyCompactList}\small\item\em Creates an empty iterator object. \end{DoxyCompactList}\item \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a5aceac3b1555506bb8d641f884c56058}{copy}} () \begin{DoxyCompactList}\small\item\em Creates a copy of the \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator}{Object\+Reverse\+Iterator}} object, iterating the same object as the original and in the same position. \end{DoxyCompactList}\item bool \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a6f053540cbbc574c438e6201b713f7dd}{first}} () \begin{DoxyCompactList}\small\item\em returns \mbox{\hyperlink{basic_data_types_True}{True}} if on the last element of the object \end{DoxyCompactList}\item bool \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a96a5d6b421ccbe6875ca2f3fbfe7576d}{last}} () \begin{DoxyCompactList}\small\item\em returns \mbox{\hyperlink{basic_data_types_True}{True}} if on the first element of the object \end{DoxyCompactList}\item bool \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a0c9460024246ef2742b9937cb0e3da4d}{next}} () \begin{DoxyCompactList}\small\item\em Moves the current position to the previous element in the object; returns \mbox{\hyperlink{basic_data_types_False}{False}} if there are no more elements; if the iterator is not pointing at a valid element before this call, the iterator will be positioned on the last element in the object if the object is not empty. \end{DoxyCompactList}\item bool \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a8eb6d967f85d306e897e08deadd63c92}{prev}} () \begin{DoxyCompactList}\small\item\em Moves the current position to the next element in the object; returns \mbox{\hyperlink{basic_data_types_False}{False}} if there are no more elements; if the iterator is not pointing at a valid element before this call, the iterator will be positioned on the first element in the object if the object is not empty. \end{DoxyCompactList}\end{DoxyCompactItemize} \doxysubsection{Detailed Description} This class an iterator class for objects. Call \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a0c9460024246ef2742b9937cb0e3da4d}{Object\+Reverse\+Iterator\+::next()}} to iterate through the object in reverse order; do not use the iterator if \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a0c9460024246ef2742b9937cb0e3da4d}{Object\+Reverse\+Iterator\+::next()}} returns \mbox{\hyperlink{basic_data_types_False}{False}}. An object can be iterated in reverse order by calling \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a8eb6d967f85d306e897e08deadd63c92}{Object\+Reverse\+Iterator\+::prev()}} instead of \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a0c9460024246ef2742b9937cb0e3da4d}{Object\+Reverse\+Iterator\+::next()}} \begin{DoxyParagraph}{Example\+: Object\+Reverse\+Iterator basic usage} \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{keyword}{class }Class1 \{} \DoxyCodeLine{ public \{} \DoxyCodeLine{ int attr1;} \DoxyCodeLine{ date attr2;} \DoxyCodeLine{ \}} \DoxyCodeLine{ constructor() \{} \DoxyCodeLine{ attr1 = 1;} \DoxyCodeLine{ attr2 = \mbox{\hyperlink{group__date__and__time__functions_ga23f067a4f82596346d4fef09782e1945}{now}}();} \DoxyCodeLine{ \}} \DoxyCodeLine{\}} \DoxyCodeLine{Class1 o();} \DoxyCodeLine{} \DoxyCodeLine{ObjectReverseIterator it(o);} \DoxyCodeLine{\textcolor{keywordflow}{while} (it.next()) \{} \DoxyCodeLine{ \mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"{}iter: \%n\(\backslash\)n"{}}, it.getValue());} \DoxyCodeLine{\}} \DoxyCodeLine{} \DoxyCodeLine{iter: 2013-\/04-\/17 16:31:03 Wed +02:00 (CEST)} \DoxyCodeLine{iter: 1} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} \begin{DoxyItemize} \item In general, the \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator}{Object\+Reverse\+Iterator}} class is not designed to be accessed from multiple threads; it was created without locking for fast and efficient use when used from a single thread. For methods that would be unsafe to use in another thread, any use of such methods in threads other than the thread where the constructor was called will cause an {\ttfamily ITERATOR-\/\+THREAD-\/\+ERROR} to be thrown. \item \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator}{Object\+Reverse\+Iterator}} is functionally equivalent to \mbox{\hyperlink{class_qore_1_1_object_iterator}{Object\+Iterator}}, but the effect of \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a0c9460024246ef2742b9937cb0e3da4d}{Object\+Reverse\+Iterator\+::next()}} and \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a8eb6d967f85d306e897e08deadd63c92}{Object\+Reverse\+Iterator\+::prev()}} are the opposite of \mbox{\hyperlink{class_qore_1_1_hash_iterator_ae1c8221cd1002edbb93ec41a333900ae}{Object\+Iterator\+::next()}} and \mbox{\hyperlink{class_qore_1_1_hash_iterator_a9df83a19c89100056c875b2ca40f6ed3}{Object\+Iterator\+::prev()}}; that is \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a0c9460024246ef2742b9937cb0e3da4d}{Object\+Reverse\+Iterator\+::next()}} will iterate through the object in reverse order, while \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a8eb6d967f85d306e897e08deadd63c92}{Object\+Reverse\+Iterator\+::prev()}} iterates in forward order. Additionally the meanings of the return values for \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a6f053540cbbc574c438e6201b713f7dd}{Object\+Reverse\+Iterator\+::first()}} and \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a96a5d6b421ccbe6875ca2f3fbfe7576d}{Object\+Reverse\+Iterator\+::last()}} are swapped in respect to \mbox{\hyperlink{class_qore_1_1_hash_iterator_a1d639332a9f27f97a830994b1a68ada2}{Object\+Iterator\+::first()}} and \mbox{\hyperlink{class_qore_1_1_hash_iterator_a40b7935be4791e186dba782e091084e5}{Object\+Iterator\+::last()}}. \end{DoxyItemize} \end{DoxyNote} \begin{DoxySeeAlso}{See also} \mbox{\hyperlink{class_qore_1_1_object_iterator}{Object\+Iterator}} \end{DoxySeeAlso} \doxysubsection{Member Function Documentation} \mbox{\Hypertarget{class_qore_1_1_object_reverse_iterator_a6856126a844e025d8dbf5d4c7bcc84a5}\label{class_qore_1_1_object_reverse_iterator_a6856126a844e025d8dbf5d4c7bcc84a5}} \index{Qore::ObjectReverseIterator@{Qore::ObjectReverseIterator}!constructor@{constructor}} \index{constructor@{constructor}!Qore::ObjectReverseIterator@{Qore::ObjectReverseIterator}} \doxysubsubsection{\texorpdfstring{constructor()}{constructor()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}} {\footnotesize\ttfamily Qore\+::\+Object\+Reverse\+Iterator\+::constructor (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} Creates an empty iterator object. \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{*object obj = get\_object\_or\_nothing();} \DoxyCodeLine{ObjectReverseIterator i(obj);} \end{DoxyCode} \end{DoxyParagraph} \mbox{\Hypertarget{class_qore_1_1_object_reverse_iterator_a4e5a5820ca50ccb9bf9be17fd54b42c1}\label{class_qore_1_1_object_reverse_iterator_a4e5a5820ca50ccb9bf9be17fd54b42c1}} \index{Qore::ObjectReverseIterator@{Qore::ObjectReverseIterator}!constructor@{constructor}} \index{constructor@{constructor}!Qore::ObjectReverseIterator@{Qore::ObjectReverseIterator}} \doxysubsubsection{\texorpdfstring{constructor()}{constructor()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}} {\footnotesize\ttfamily Qore\+::\+Object\+Reverse\+Iterator\+::constructor (\begin{DoxyParamCaption}\item[{object}]{o }\end{DoxyParamCaption})} Creates the object iterator object. \begin{DoxyParams}{Parameters} {\em o} & the object to iterate\\ \hline \end{DoxyParams} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{ObjectReverseIterator i(obj);} \end{DoxyCode} \end{DoxyParagraph} \mbox{\Hypertarget{class_qore_1_1_object_reverse_iterator_a5aceac3b1555506bb8d641f884c56058}\label{class_qore_1_1_object_reverse_iterator_a5aceac3b1555506bb8d641f884c56058}} \index{Qore::ObjectReverseIterator@{Qore::ObjectReverseIterator}!copy@{copy}} \index{copy@{copy}!Qore::ObjectReverseIterator@{Qore::ObjectReverseIterator}} \doxysubsubsection{\texorpdfstring{copy()}{copy()}} {\footnotesize\ttfamily Qore\+::\+Object\+Reverse\+Iterator\+::copy (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})} Creates a copy of the \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator}{Object\+Reverse\+Iterator}} object, iterating the same object as the original and in the same position. \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{ObjectReverseIterator ni = i.copy();} \end{DoxyCode} \end{DoxyParagraph} \mbox{\Hypertarget{class_qore_1_1_object_reverse_iterator_a6f053540cbbc574c438e6201b713f7dd}\label{class_qore_1_1_object_reverse_iterator_a6f053540cbbc574c438e6201b713f7dd}} \index{Qore::ObjectReverseIterator@{Qore::ObjectReverseIterator}!first@{first}} \index{first@{first}!Qore::ObjectReverseIterator@{Qore::ObjectReverseIterator}} \doxysubsubsection{\texorpdfstring{first()}{first()}} {\footnotesize\ttfamily bool Qore\+::\+Object\+Reverse\+Iterator\+::first (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} returns \mbox{\hyperlink{basic_data_types_True}{True}} if on the last element of the object \begin{DoxyReturn}{Returns} \mbox{\hyperlink{basic_data_types_True}{True}} if on the last element of the object \end{DoxyReturn} \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{keywordflow}{while} (i.next()) \{} \DoxyCodeLine{ \textcolor{keywordflow}{if} (i.first())} \DoxyCodeLine{ \mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"{}START:\(\backslash\)n"{}});} \DoxyCodeLine{\}} \end{DoxyCode} \end{DoxyParagraph} Reimplemented from \mbox{\hyperlink{class_qore_1_1_hash_iterator_a1d639332a9f27f97a830994b1a68ada2}{Qore\+::\+Hash\+Iterator}}. \mbox{\Hypertarget{class_qore_1_1_object_reverse_iterator_a96a5d6b421ccbe6875ca2f3fbfe7576d}\label{class_qore_1_1_object_reverse_iterator_a96a5d6b421ccbe6875ca2f3fbfe7576d}} \index{Qore::ObjectReverseIterator@{Qore::ObjectReverseIterator}!last@{last}} \index{last@{last}!Qore::ObjectReverseIterator@{Qore::ObjectReverseIterator}} \doxysubsubsection{\texorpdfstring{last()}{last()}} {\footnotesize\ttfamily bool Qore\+::\+Object\+Reverse\+Iterator\+::last (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} returns \mbox{\hyperlink{basic_data_types_True}{True}} if on the first element of the object \begin{DoxyReturn}{Returns} \mbox{\hyperlink{basic_data_types_True}{True}} if on the first element of the object \end{DoxyReturn} \begin{DoxyParagraph}{Code Flags\+:} \mbox{\hyperlink{code_flags_CONSTANT}{CONSTANT}} \end{DoxyParagraph} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{keywordflow}{while} (i.next()) \{} \DoxyCodeLine{ \textcolor{keywordflow}{if} (i.last())} \DoxyCodeLine{ \mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"{}END.\(\backslash\)n"{}});} \DoxyCodeLine{\}} \end{DoxyCode} \end{DoxyParagraph} Reimplemented from \mbox{\hyperlink{class_qore_1_1_hash_iterator_a40b7935be4791e186dba782e091084e5}{Qore\+::\+Hash\+Iterator}}. \mbox{\Hypertarget{class_qore_1_1_object_reverse_iterator_a0c9460024246ef2742b9937cb0e3da4d}\label{class_qore_1_1_object_reverse_iterator_a0c9460024246ef2742b9937cb0e3da4d}} \index{Qore::ObjectReverseIterator@{Qore::ObjectReverseIterator}!next@{next}} \index{next@{next}!Qore::ObjectReverseIterator@{Qore::ObjectReverseIterator}} \doxysubsubsection{\texorpdfstring{next()}{next()}} {\footnotesize\ttfamily bool Qore\+::\+Object\+Reverse\+Iterator\+::next (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} Moves the current position to the previous element in the object; returns \mbox{\hyperlink{basic_data_types_False}{False}} if there are no more elements; if the iterator is not pointing at a valid element before this call, the iterator will be positioned on the last element in the object if the object is not empty. This method will return \mbox{\hyperlink{basic_data_types_True}{True}} again after it returns \mbox{\hyperlink{basic_data_types_False}{False}} once if the object is not empty, otherwise it will always return \mbox{\hyperlink{basic_data_types_False}{False}}. The iterator object should not be used after this method returns \mbox{\hyperlink{basic_data_types_False}{False}} \begin{DoxyReturn}{Returns} \mbox{\hyperlink{basic_data_types_False}{False}} if there are no more elements in the object (in which case the iterator object is invalid and should not be used); \mbox{\hyperlink{basic_data_types_True}{True}} if successful (meaning that the iterator object is valid) \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{keywordflow}{while} (i.prev()) \{} \DoxyCodeLine{ \mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"{} + \%y\(\backslash\)n"{}}, i.getValue());} \DoxyCodeLine{\}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a0c9460024246ef2742b9937cb0e3da4d}{Object\+Reverse\+Iterator\+::next()}} is the opposite of \mbox{\hyperlink{class_qore_1_1_hash_iterator_ae1c8221cd1002edbb93ec41a333900ae}{Object\+Iterator\+::next()}}; it is functionally equivalent to \mbox{\hyperlink{class_qore_1_1_hash_iterator_a9df83a19c89100056c875b2ca40f6ed3}{Object\+Iterator\+::prev()}}; \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a0c9460024246ef2742b9937cb0e3da4d}{Object\+Reverse\+Iterator\+::next()}} iterates through the object in reverse order \end{DoxyNote} \begin{DoxyExceptions}{Exceptions} {\em ITERATOR-\/\+THREAD-\/\+ERROR} & this exception is thrown if this method is called from any thread other than the thread that created the object \\ \hline \end{DoxyExceptions} Reimplemented from \mbox{\hyperlink{class_qore_1_1_hash_iterator_ae1c8221cd1002edbb93ec41a333900ae}{Qore\+::\+Hash\+Iterator}}. \mbox{\Hypertarget{class_qore_1_1_object_reverse_iterator_a8eb6d967f85d306e897e08deadd63c92}\label{class_qore_1_1_object_reverse_iterator_a8eb6d967f85d306e897e08deadd63c92}} \index{Qore::ObjectReverseIterator@{Qore::ObjectReverseIterator}!prev@{prev}} \index{prev@{prev}!Qore::ObjectReverseIterator@{Qore::ObjectReverseIterator}} \doxysubsubsection{\texorpdfstring{prev()}{prev()}} {\footnotesize\ttfamily bool Qore\+::\+Object\+Reverse\+Iterator\+::prev (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}} Moves the current position to the next element in the object; returns \mbox{\hyperlink{basic_data_types_False}{False}} if there are no more elements; if the iterator is not pointing at a valid element before this call, the iterator will be positioned on the first element in the object if the object is not empty. This method will return \mbox{\hyperlink{basic_data_types_True}{True}} again after it returns \mbox{\hyperlink{basic_data_types_False}{False}} once if object is not empty, otherwise it will always return \mbox{\hyperlink{basic_data_types_False}{False}}. The iterator object should not be used after this method returns \mbox{\hyperlink{basic_data_types_False}{False}} \begin{DoxyReturn}{Returns} \mbox{\hyperlink{basic_data_types_False}{False}} if there are no more elements in the object (in which case the iterator object is invalid and should not be used); \mbox{\hyperlink{basic_data_types_True}{True}} if successful (meaning that the iterator object is valid) \end{DoxyReturn} \begin{DoxyParagraph}{Example\+:} \begin{DoxyCode}{0} \DoxyCodeLine{\textcolor{keywordflow}{while} (i.next()) \{} \DoxyCodeLine{ \mbox{\hyperlink{group__string__functions_ga32070517a9f8a70a32ef48f83a6f128e}{printf}}(\textcolor{stringliteral}{"{} + \%y\(\backslash\)n"{}}, i.getValue());} \DoxyCodeLine{\}} \end{DoxyCode} \end{DoxyParagraph} \begin{DoxyNote}{Note} \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a8eb6d967f85d306e897e08deadd63c92}{Object\+Reverse\+Iterator\+::prev()}} is the opposite of \mbox{\hyperlink{class_qore_1_1_hash_iterator_a9df83a19c89100056c875b2ca40f6ed3}{Object\+Iterator\+::prev()}}; it is functionally equivalent to \mbox{\hyperlink{class_qore_1_1_hash_iterator_ae1c8221cd1002edbb93ec41a333900ae}{Object\+Iterator\+::next()}}; \mbox{\hyperlink{class_qore_1_1_object_reverse_iterator_a8eb6d967f85d306e897e08deadd63c92}{Object\+Reverse\+Iterator\+::prev()}} iterates through the object in forward order \end{DoxyNote} \begin{DoxyExceptions}{Exceptions} {\em ITERATOR-\/\+THREAD-\/\+ERROR} & this exception is thrown if this method is called from any thread other than the thread that created the object \\ \hline \end{DoxyExceptions} Reimplemented from \mbox{\hyperlink{class_qore_1_1_hash_iterator_a9df83a19c89100056c875b2ca40f6ed3}{Qore\+::\+Hash\+Iterator}}.