.. oe:namespace:: OEChem

.. meta::
   :keywords: OEIsNonRingAtomDoubleBondedToRing, IsNonRingAtomDoubleBondedToRing


.. _OEChem_OEIsNonRingAtomDoubleBondedToRing:

.. oe:class:: OEIsNonRingAtomDoubleBondedToRing

   .. oe:api::


      struct OEIsNonRingAtomDoubleBondedToRing : public OESystem::OEUnaryPredicate<OEChem::OEAtomBase>

   This class represents the :ref:`OEIsNonRingAtomDoubleBondedToRing <OEChem_OEIsNonRingAtomDoubleBondedToRing>` functor that
   identifies non-ring atoms double bonded to a ring.

   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>`                                                            
   ============================================================ ============================================================ ===========================================================


   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEAtomBase& atom) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(atom: OEAtomBase) -> bool

      Returns ``true``, if the  :oe:meth:`OEChem::OEAtomBase::IsInRing`
      method returns ``false`` for the given 
      :ref:`OEAtomBase <OEChem_OEAtomBase>` object, and the atom is bonded to an atom
      where the  :oe:meth:`OEChem::OEAtomBase::IsInRing`
      method returns ``true`` and the order of the bond as determined by the
      :oe:meth:`OEChem::OEBondBase::GetOrder` method is 2.

   .. oe:method:: CreateCopy

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

         .. oe:api::

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

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEIsNonRingAtomDoubleBondedToRing

      Deep copy constructor that returns a copy of the object.
      The memory for the returned :ref:`OEIsNonRingAtomDoubleBondedToRing <OEChem_OEIsNonRingAtomDoubleBondedToRing>`
      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. 

.. seealso::

  .. oe:language:: c++

      * Example program :ref:`ringsubset.cpp<section_example_oechem_ringsubset>`
      * Example program :ref:`extractscaffold.cpp<section_example_oechem_extractscaffold>`

  .. oe:language:: python

      * Example program :ref:`ringsubset.py<section_example_oechem_ringsubset>`
      * Example program :ref:`extractscaffold.py<section_example_oechem_extractscaffold>`

  .. oe:language:: java

      * Example program :ref:`RingSubset.java<section_example_oechem_ringsubset>`
      * Example program :ref:`ExtractScaffold.java<section_example_oechem_extractscaffold>`

  .. oe:language:: csharp

      * Example program :ref:`RingSubset.cs<section_example_oechem_ringsubset>`
      * Example program :ref:`ExtractScaffold.cs<section_example_oechem_extractscaffold>`
