.. oe:namespace:: OESystem



.. meta::
   :keywords: OEIterBase, IterBase


.. _OESystem_OEIterBase:

.. oe:class:: OEIterBase

   .. oe:api::


      template<class A>
      class OEIterBase

   This class represents `OEIterBase`.

   The :ref:`OEIterBase <OESystem_OEIterBase>` class is an internal abstract
   template class. All iterators returned by *OESystem* and *OEChem*
   are pointers to instances derived from this class. However, users
   should not use or access this class/template directly. Instead the
   :ref:`OEIterBase <OESystem_OEIterBase>` pointer should be assigned to an
   :ref:`OEIter <OESystem_OEIter>`. The :ref:`OEIter <OESystem_OEIter>`, for
   example, ensures that the contents of the
   :ref:`OEIterBase <OESystem_OEIterBase>` will be destroyed when the
   :ref:`OEIter <OESystem_OEIter>` goes out of scope, thus preventing
   potential memory leaks.

   The following classes derive from this class:
    * :ref:`OEConcatIter <OESystem_OEConcatIter>`
    * :ref:`OEPredIter <OESystem_OEPredIter>`
   
   .. oe:method:: Constructors

      .. oe:api::

         OEIterBase()

      Default and copy constructors.

   .. oe:method:: operator*
      :language: c++

      .. oe:api::

         A& operator*() const = 0

   .. oe:method:: operator++
      :language: c++

      .. oe:api::

         OEIterBase<A>& operator++()=0

   .. oe:method:: operator+=
      :language: c++

      .. oe:api::

         OEIterBase<A>& operator+=(int)=0
         OEIterBase<A>& operator+=(unsigned int)=0

   .. oe:method:: operator--
      :language: c++

      .. oe:api::

         OEIterBase<A>& operator--()=0

   .. oe:method:: operator-=
      :language: c++

      .. oe:api::

         OEIterBase<A>& operator-=(int)=0
         OEIterBase<A>& operator-=(unsigned int)=0

   .. oe:method:: operator->
      :language: c++ java csharp

      .. oe:api::

         A* operator->() const = 0

   .. oe:method:: operator A *
      :language: c++

      .. oe:api::

         operator A *() const

   .. oe:method:: operator bool

      .. oe:language:: c++ java csharp

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

   .. oe:method:: Copy

      .. oe:api::

         OEIterBase<A> *Copy() const = 0

   .. oe:method:: Push

      .. oe:api::

         OEIterBase<A> *Push(OEIterBase<A> *ib)

   .. oe:method:: ToFirst

      .. oe:api::

         OEIterBase<A> &ToFirst()=0

   .. oe:method:: ToLast

      .. oe:api::

         OEIterBase<A> &ToLast()=0

