.. oe:namespace:: OEBio


.. _OEBio_OEIsIntramolecularHBondInteractionHint:

.. oe:class:: OEIsIntramolecularHBondInteractionHint

   .. oe:api::

      class OEIsIntramolecularHBondInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsIntramolecularHBondInteractionHint <OEBio_OEIsIntramolecularHBondInteractionHint>` functor that
   identifies **hydrogen bonding** interactions between two atoms in the same molecule.

   .. seealso::

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

      * :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>` predicate
      * :ref:`OEIsIntermolecularHBondInteractionHint <OEBio_OEIsIntermolecularHBondInteractionHint>` predicate
      * :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsIntramolecularHBondInteractionHint(bool includeNonIdeal = true)

      .. oe:language:: python

         .. oe:api:: python

            OEIsIntramolecularHBondInteractionHint(includeNonIdeal: bool = True) -> OEIsIntramolecularHBondInteractionHint
            OEIsIntramolecularHBondInteractionHint(arg2: OEIsIntramolecularHBondInteractionHint) -> OEIsIntramolecularHBondInteractionHint

      Constructor.

      :param includeNonIdeal: If ``true`` (default), non-ideal intramolecular
         hydrogen bond interactions are included in the results.


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

      .. oe:api::

         OEIsIntramolecularHBondInteractionHint & operator=(const OEIsIntramolecularHBondInteractionHint &)

      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 an intramolecular hydrogen
      bonding type *i.e.* the :oe:meth:`OEBio::OEInteractionHint::GetInteractionType`
      method returns an :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>` with the following types:

      * :oe:const:`OEBio::OEHBondInteractionHintType::IntramolecularLigand`
      * :oe:const:`OEBio::OEHBondInteractionHintType::IntramolecularProtein`

      When ``includeNonIdeal`` is ``true`` (default), the following types are
      also included:

      * :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealProteinAccepts`
      * :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealProteinDonates`
      * :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealLigandDonates`
      * :oe:const:`OEBio::OEHBondInteractionHintType::NonIdealLigandAccepts`

      Unpaired interactions are not included. Use
      :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>`
      to retrieve unpaired hydrogen bond donors and acceptors.


   .. 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:`OEIsIntramolecularHBondInteractionHint <OEBio_OEIsIntramolecularHBondInteractionHint>`
      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.


