.. oe:namespace:: OEChem


.. meta::
   :keywords: OEHasBondInGroup, HasBondInGroup


.. _OEChem_OEHasBondInGroup:

.. oe:class:: OEHasBondInGroup

   .. oe:api::

      class OEHasBondInGroup : public OESystem::OEUnaryPredicate<OEGroupBase>

   This class represents :ref:`OEHasBondInGroup <OEChem_OEHasBondInGroup>` functor that
   identifies groups (:ref:`OEGroupBase <OEChem_OEGroupBase>`) that store a specific
   bond (: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>`
   ============================================================ ============================================================

   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHasBondInGroup(const OEBondBase* bond)

      .. oe:language:: python

         .. oe:api:: python

            OEHasBondInGroup(bond: OEBondBase) -> OEHasBondInGroup

      Constructs the functor with the given bond.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEGroupBase& group) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(group: OEGroupBase) -> bool

      Returns ``true``, if the bond with which the functor is constructed
      is stored in the group.

   .. ################################################################
      #
      ################################################################

   .. oe:method:: CreateCopy

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

         .. oe:api::

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

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryGroupBoolFunc

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