\hypertarget{a00406}{\section{Open\+Mesh\+:\+:Python\+:\+:Circulator\+Wrapper\+T$<$ Circulator, Center\+Entity\+Handle $>$ Class Template Reference}
\label{a00406}\index{Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T$<$ Circulator, Center\+Entity\+Handle $>$@{Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T$<$ Circulator, Center\+Entity\+Handle $>$}}
}


{\ttfamily \#include $<$libs\+\_\+required/\+Open\+Mesh/src/\+Python/\+Circulator.\+hh$>$}

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{a00406_abf4ceaed2b68f3454aeb2acd4da3fc2a}{Circulator\+Wrapper\+T} (\hyperlink{a00991}{Poly\+Mesh} \&\+\_\+mesh, Center\+Entity\+Handle \+\_\+center)
\item 
\hyperlink{a00406_aecd0decc1866e24de8e69a121c0b545b}{Circulator\+Wrapper\+T} (\hyperlink{a01335}{Tri\+Mesh} \&\+\_\+mesh, Center\+Entity\+Handle \+\_\+center)
\item 
\hyperlink{a00406}{Circulator\+Wrapper\+T} \hyperlink{a00406_a7889a82c4fecf94cf312914149d452df}{iter} () const 
\item 
Circulator\+::value\+\_\+type \hyperlink{a00406_ac828352aaf9fd0715a4012e15c02bfda}{next} ()
\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{a00406_af6d1f5b7dd680beff2aa1927c7aa7b62}{Circulator {\bfseries circulator\+\_\+}}\label{a00406_af6d1f5b7dd680beff2aa1927c7aa7b62}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
\subsubsection*{template$<$class Circulator, class Center\+Entity\+Handle$>$class Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T$<$ Circulator, Center\+Entity\+Handle $>$}

Wrapper for circulators.

This class template is used to wrap circulators for Python. It implements Python's iterator protocol (the magic methods \+\_\+\+\_\+iter\+\_\+\+\_\+ and \+\_\+\+\_\+next\+\_\+\+\_\+).


\begin{DoxyTemplParams}{Template Parameters}
{\em Circulator} & A circulator type. \\
\hline
\end{DoxyTemplParams}


Definition at line 19 of file Circulator.\+hh.



\subsection{Constructor \& Destructor Documentation}
\hypertarget{a00406_abf4ceaed2b68f3454aeb2acd4da3fc2a}{\index{Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T@{Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T}!Circulator\+Wrapper\+T@{Circulator\+Wrapper\+T}}
\index{Circulator\+Wrapper\+T@{Circulator\+Wrapper\+T}!Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T@{Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T}}
\subsubsection[{Circulator\+Wrapper\+T}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Circulator, class Center\+Entity\+Handle$>$ {\bf Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T}$<$ Circulator, Center\+Entity\+Handle $>$\+::{\bf Circulator\+Wrapper\+T} (
\begin{DoxyParamCaption}
\item[{{\bf Poly\+Mesh} \&}]{\+\_\+mesh, }
\item[{Center\+Entity\+Handle}]{\+\_\+center}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}}}\label{a00406_abf4ceaed2b68f3454aeb2acd4da3fc2a}
Constructor


\begin{DoxyParams}{Parameters}
{\em \+\_\+mesh} & The mesh that contains the items to iterate over. \\
\hline
{\em \+\_\+center} & The handle to the center item. \\
\hline
\end{DoxyParams}


Definition at line 28 of file Circulator.\+hh.

\hypertarget{a00406_aecd0decc1866e24de8e69a121c0b545b}{\index{Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T@{Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T}!Circulator\+Wrapper\+T@{Circulator\+Wrapper\+T}}
\index{Circulator\+Wrapper\+T@{Circulator\+Wrapper\+T}!Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T@{Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T}}
\subsubsection[{Circulator\+Wrapper\+T}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Circulator, class Center\+Entity\+Handle$>$ {\bf Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T}$<$ Circulator, Center\+Entity\+Handle $>$\+::{\bf Circulator\+Wrapper\+T} (
\begin{DoxyParamCaption}
\item[{{\bf Tri\+Mesh} \&}]{\+\_\+mesh, }
\item[{Center\+Entity\+Handle}]{\+\_\+center}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}}}\label{a00406_aecd0decc1866e24de8e69a121c0b545b}
Constructor


\begin{DoxyParams}{Parameters}
{\em \+\_\+mesh} & The mesh that contains the items to iterate over. \\
\hline
{\em \+\_\+center} & The handle to the center item. \\
\hline
\end{DoxyParams}


Definition at line 38 of file Circulator.\+hh.



\subsection{Member Function Documentation}
\hypertarget{a00406_a7889a82c4fecf94cf312914149d452df}{\index{Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T@{Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T}!iter@{iter}}
\index{iter@{iter}!Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T@{Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T}}
\subsubsection[{iter}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Circulator, class Center\+Entity\+Handle$>$ {\bf Circulator\+Wrapper\+T} {\bf Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T}$<$ Circulator, Center\+Entity\+Handle $>$\+::iter (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily [inline]}}}\label{a00406_a7889a82c4fecf94cf312914149d452df}
Implementation of Python's \+\_\+\+\_\+iter\+\_\+\+\_\+ magic method.

\begin{DoxyReturn}{Returns}
This circulator. 
\end{DoxyReturn}


Definition at line 47 of file Circulator.\+hh.

\hypertarget{a00406_ac828352aaf9fd0715a4012e15c02bfda}{\index{Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T@{Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T}!next@{next}}
\index{next@{next}!Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T@{Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T}}
\subsubsection[{next}]{\setlength{\rightskip}{0pt plus 5cm}template$<$class Circulator, class Center\+Entity\+Handle$>$ Circulator\+::value\+\_\+type {\bf Open\+Mesh\+::\+Python\+::\+Circulator\+Wrapper\+T}$<$ Circulator, Center\+Entity\+Handle $>$\+::next (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [inline]}}}\label{a00406_ac828352aaf9fd0715a4012e15c02bfda}
Implementation of Python's \+\_\+\+\_\+next\+\_\+\+\_\+ magic method.

\begin{DoxyReturn}{Returns}
The next item. Raises a Python Stop\+Iteration exception if there are no more items. 
\end{DoxyReturn}


Definition at line 57 of file Circulator.\+hh.



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
libs\+\_\+required/\+Open\+Mesh/src/\+Python/Circulator.\+hh\end{DoxyCompactItemize}
