.. oe:namespace:: OEBio


.. _OEBio_OEIsIntermolecularHalogenBondInteractionHint:

.. oe:class:: OEIsIntermolecularHalogenBondInteractionHint

   .. oe:api::

      class OEIsIntermolecularHalogenBondInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsIntermolecularHalogenBondInteractionHint <OEBio_OEIsIntermolecularHalogenBondInteractionHint>` functor that
   identifies **halogen bond** interactions between atoms in different molecules
   (i.e. between the ligand and the protein).

   .. seealso::

      * :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>` class
      * :oe:constns:`OEBio::OEHalogenBondInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsHalogenBondInteractionHint <OEBio_OEIsHalogenBondInteractionHint>` predicate
      * :ref:`OEIsIntramolecularHalogenBondInteractionHint <OEBio_OEIsIntramolecularHalogenBondInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsIntermolecularHalogenBondInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsIntermolecularHalogenBondInteractionHint() -> OEIsIntermolecularHalogenBondInteractionHint
            OEIsIntermolecularHalogenBondInteractionHint(arg2: OEIsIntermolecularHalogenBondInteractionHint) -> OEIsIntermolecularHalogenBondInteractionHint

      Default constructor.


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

      .. oe:api::

         OEIsIntermolecularHalogenBondInteractionHint & operator=(const OEIsIntermolecularHalogenBondInteractionHint &)

      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 given interaction has an intermolecular
      halogen bond type *i.e.* the
      :oe:meth:`OEBio::OEInteractionHint::GetInteractionType` method returns an
      :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>` with
      one of the following types:

      * :oe:const:`OEBio::OEHalogenBondInteractionHintType::LigandElectrophile`
      * :oe:const:`OEBio::OEHalogenBondInteractionHintType::LigandNucleophile`
      * :oe:const:`OEBio::OEHalogenBondInteractionHintType::ProteinElectrophile`
      * :oe:const:`OEBio::OEHalogenBondInteractionHintType::ProteinNucleophile`


   .. 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:`OEIsIntermolecularHalogenBondInteractionHint <OEBio_OEIsIntermolecularHalogenBondInteractionHint>`
      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.
