.. oe:namespace:: OEChem


.. meta::
   :keywords: OEBondIsInRing, BondIsInRing


.. _OEChem_OEBondIsInRing:

.. oe:class:: OEBondIsInRing

   .. oe:api::

      struct OEBondIsInRing : public OESystem::OEUnaryPredicate<OEChem::OEBondBase>

   This class represents :ref:`OEBondIsInRing <OEChem_OEBondIsInRing>` functor that
   identifies ring bonds (:ref:`OEBondBase <OEChem_OEBondBase>`).

   The following methods are publicly inherited from :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`:

   ============================================================================== ============================================================================== ===============================================================================
   :oe:meth:`operator()<OESystem::OEUnaryPredicate::operator()>`                  :oe:meth:`CreateCopy<OESystem::OEUnaryPredicate::CreateCopy>`                  :oe:meth:`CreatePredicateCopy<OESystem::OEUnaryPredicate::CreatePredicateCopy>`
   ============================================================================== ============================================================================== ===============================================================================

   The following methods are publicly inherited from :ref:`OEUnaryFunction <OESystem_OEUnaryFunction>`:

   ============================================================ ============================================================
   :oe:meth:`operator()<OESystem::OEUnaryFunction::operator()>` :oe:meth:`CreateCopy<OESystem::OEUnaryFunction::CreateCopy>`
   ============================================================ ============================================================

   .. seealso::

      * :ref:`OEBondIsInChain <OEChem_OEBondIsInChain>` predicate

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEBondBase& bond) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(bond: OEBondBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEBondBase::IsInRing`
      method returns ``true`` for the given 
      :ref:`OEBondBase <OEChem_OEBondBase>` object.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OEChem::OEBondBase, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEBondIsInRing

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEBondIsInRing <OEChem_OEBondIsInRing>`
      object is dynamically allocated  and owned by the caller.

      .. oe:language:: c++ 

         The returned copy should be deallocated using C++
         delete operator in order to prevent a memory leak. 
