.. oe:namespace:: OEBio


.. _OEBio_OEHalogenBondInteractionHint:

.. oe:class:: OEHalogenBondInteractionHint

   .. oe:api::

      class OEHalogenBondInteractionHint : public OEInteractionHintTypeBase

   The :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>` class represents
   a built-in type that identifies interactions stored in an
   :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object as
   **halogen bond** interactions (inter- and intramolecular).

   .. seealso::

      * :oe:constns:`OEBio::OEHalogenBondInteractionHintType` namespace for specific **halogen-bond** interaction types
      * :ref:`OEIsHalogenBondInteractionHint <OEBio_OEIsHalogenBondInteractionHint>` predicate
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class

      To perceive **halogen bond** interactions:

      * :oe:func:`OEBio::OEPerceiveInteractionHints` function
      * :ref:`OEPerceiveInteractionOptions <OEBio_OEPerceiveInteractionOptions>` class and its methods:

        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHalogenAngle`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHalogenBondDistance`


   The following methods are publicly inherited from :ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>`:

   =================================================================== =================================================================== ===================================================================
   :oe:meth:`operator=<OEBio::OEInteractionHintTypeBase::operator=>`   :oe:meth:`operator==<OEBio::OEInteractionHintTypeBase::operator==>` :oe:meth:`GetName<OEBio::OEInteractionHintTypeBase::GetName>`
   :oe:meth:`operator!=<OEBio::OEInteractionHintTypeBase::operator!=>` :oe:meth:`CreateCopy<OEBio::OEInteractionHintTypeBase::CreateCopy>` :oe:meth:`IsValid<OEBio::OEInteractionHintTypeBase::IsValid>`
   =================================================================== =================================================================== ===================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHalogenBondInteractionHint(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            OEHalogenBondInteractionHint(type: int) -> OEHalogenBondInteractionHint

      *type*
         This value has to be from the :oe:constns:`OEBio::OEHalogenBondInteractionHintType`
         namespace.

      .. note::

         Two :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>` objects with different
         types from the :oe:constns:`OEBio::OEHalogenBondInteractionHintType`
         namespace and/or with different charge options are considered to be different.

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

         .. oe:api::

            OEHalogenBondInteractionHint(const OEHalogenBondInteractionHint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHalogenBondInteractionHint(rhs: OEHalogenBondInteractionHint) -> OEHalogenBondInteractionHint

      Copy constructor.


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

      .. oe:api::

         OEHalogenBondInteractionHint &operator=(const OEHalogenBondInteractionHint &rhs)

      Assignment operator.


   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEInteractionHintTypeBase* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEInteractionHintTypeBase

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

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid(const OEInteractionHintFragment *,
                         const OEInteractionHintFragment *) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid(arg2: OEInteractionHintFragment,
                    arg3: OEInteractionHintFragment) -> bool

      Evaluates whether the two given fragments would form a valid
      **halogen bond** interaction when added to an
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

      It checks that each fragment contains exactly one atom,
      and the fragments belong to different molecules *i.e.*
      it is an **intermolecular** interaction.
