.. oe:namespace:: OEBio


.. _OEBio_OEIsHBondInteractionHint:

.. oe:class:: OEIsHBondInteractionHint

   .. oe:api::

      class OEIsHBondInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>` functor that
   identifies **hydrogen bonding** interactions.

   .. seealso::

      * :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>` class
      * :oe:constns:`OEBio::OEHBondInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsIntermolecularHBondInteractionHint <OEBio_OEIsIntermolecularHBondInteractionHint>` predicate
      * :ref:`OEIsIntramolecularHBondInteractionHint <OEBio_OEIsIntramolecularHBondInteractionHint>` predicate
      * :ref:`OEIsNonIdealHBondInteractionHint <OEBio_OEIsNonIdealHBondInteractionHint>` predicate
      * :ref:`OEIsClashingHBondInteractionHint <OEBio_OEIsClashingHBondInteractionHint>` predicate
      * :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsHBondInteractionHint(bool includeIntra = true,
                                     bool includeNonIdeal = true)

      .. oe:language:: python

         .. oe:api:: python

            OEIsHBondInteractionHint(includeIntra: bool = True,
                                     includeNonIdeal: bool = True) -> OEIsHBondInteractionHint
            OEIsHBondInteractionHint(arg2: OEIsHBondInteractionHint) -> OEIsHBondInteractionHint

      Constructor.

      :param includeIntra: If ``true`` (default), intramolecular hydrogen bond
         interactions are included in the results.
      :param includeNonIdeal: If ``true`` (default), non-ideal hydrogen bond
         interactions (long donor-acceptor distances or poor geometries) are
         included in the results.


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

      .. oe:api::

         OEIsHBondInteractionHint & operator=(const OEIsHBondInteractionHint &)

      Assignment operator.



   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& c) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(c: OEInteractionHint) -> bool

      Returns ``true``, if the given interaction has a hydrogen bonding
      type *i.e.* the :oe:meth:`OEBio::OEInteractionHint::GetInteractionType`
      method returns an :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`
      type. Clashing hydrogen bond interactions
      (:oe:const:`OEBio::OEHBondInteractionHintType::ClashAcceptorAcceptor`,
      :oe:const:`OEBio::OEHBondInteractionHintType::ClashDonorDonor`) and
      unpaired interactions
      (:oe:const:`OEBio::OEHBondInteractionHintType::UnpairedLigandDonor`,
      :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedLigandAcceptor`,
      :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedProteinDonor`,
      :oe:const:`OEBio::OEHBondInteractionHintType::UnpairedProteinAcceptor`)
      are **not** included. Use
      :ref:`OEIsClashingHBondInteractionHint <OEBio_OEIsClashingHBondInteractionHint>`
      and :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>`
      to retrieve those interaction types.


   .. oe:method:: CreateCopy

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

         .. oe:api::

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

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryInteractionHintBoolFunc

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