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

.. oe:namespace:: OEBio


.. _OEBio_OEHasInteractionHint:

.. oe:class:: OEHasInteractionHint

   .. oe:api::

      class OEHasInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEHasInteractionHint <OEBio_OEHasInteractionHint>` functor that
   identifies interactions (:ref:`OEInteractionHint <OEBio_OEInteractionHint>`)
   with a specific atom (:ref:`OEAtomBase <OEChem_OEAtomBase>`).

   .. 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::

            OEHasInteractionHint(const OEChem::OEAtomBase* atom)

      .. oe:language:: python

         .. oe:api:: python

            OEHasInteractionHint(arg2: OEAtomBase) -> OEHasInteractionHint

      Constructs the functor with the given atom.

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

         .. oe:api::

            OEHasInteractionHint(const OEHasInteractionHint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHasInteractionHint(arg2: OEHasInteractionHint) -> OEHasInteractionHint

      Copy constructor.


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

      .. oe:api::

         OEHasInteractionHint &operator=(const OEHasInteractionHint &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__(c: OEInteractionHint) -> bool

      Returns ``true``, if the atom with which the functor is constructed
      is stored in the given interaction.


   .. 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:`OEHasInteractionHint <OEBio_OEHasInteractionHint>`
      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.
