.. include:: ../../common/cookbook/cookbook-hyperlinks

.. oe:namespace:: OEBio


.. _OEBio_OEHasResidueInteractionHint:

.. oe:class:: OEHasResidueInteractionHint

   .. oe:api::

      class OEHasResidueInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEHasResidueInteractionHint <OEBio_OEHasResidueInteractionHint>` functor that
   identifies connections (:ref:`OEInteractionHint <OEBio_OEInteractionHint>`)
   with a specific residue (:ref:`OEResidue <OEChem_OEResidue>`).

   .. admonition:: Code Examples

      * :ref:`section_example_oebio_printinteractions` **OEChem TK** example
      * `Accessing Interaction Hint Information`_  **OpenEye Python Cookbook** recipe

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHasResidueInteractionHint(const OEChem::OEResidue& res)

      .. oe:language:: python

         .. oe:api:: python

            OEHasResidueInteractionHint(arg2: OEResidue) -> OEHasResidueInteractionHint

      Constructs the functor with the given residue.

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

         .. oe:api::

            OEHasResidueInteractionHint(const OEChem::OEResidue& res,
                                        const OEInteractionHintComponentTypeBase& ctype)

      .. oe:language:: python

         .. oe:api:: python

            OEHasResidueInteractionHint(arg2: OEResidue,
                                        ctype: OEInteractionHintComponentTypeBase) -> OEHasResidueInteractionHint

      Constructs the functor with the given residue and component type.

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

         .. oe:api::

            OEHasResidueInteractionHint(const OEHasResidueInteractionHint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHasResidueInteractionHint(rhs: OEHasResidueInteractionHint) -> OEHasResidueInteractionHint

      Copy constructor.


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

      .. oe:api::

         OEHasResidueInteractionHint &operator=(const OEHasResidueInteractionHint &rhs)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEInteractionHint& i) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(i: OEInteractionHint) -> bool

      Returns ``true``, if the residue with which the functor is constructed
      identifies any atom stored in the given interaction.
      If a component type is defined at construction than that
      is also checked.

      .. seealso::

         The following built-in component types are available:

         * :ref:`OELigandInteractionHintComponent <OEBio_OELigandInteractionHintComponent>`
         * :ref:`OEProteinInteractionHintComponent <OEBio_OEProteinInteractionHintComponent>`


   .. 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:`OEHasResidueInteractionHint <OEBio_OEHasResidueInteractionHint>`
      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.
