.. oe:namespace:: OEBio


.. _OEBio_OEHBondInteractionHint:

.. oe:class:: OEHBondInteractionHint

   .. oe:api::

      class OEHBondInteractionHint : public OEInteractionHintTypeBase

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

   .. seealso::

      * :oe:constns:`OEBio::OEHBondInteractionHintType` namespace for specific **hydrogen bond** interaction types
      * :ref:`OEIsHBondInteractionHint <OEBio_OEIsHBondInteractionHint>` predicate
      * :ref:`OEIsIntermolecularHBondInteractionHint <OEBio_OEIsIntermolecularHBondInteractionHint>` predicate
      * :ref:`OEIsIntramolecularHBondInteractionHint <OEBio_OEIsIntramolecularHBondInteractionHint>` predicate
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class

      To perceive **hydrogen bond** interactions:

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

        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxAcceptorAngle`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxChargeAidedHBondDistance`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxDonorAngle`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxHBondDistance`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxUnpairedAngle`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMaxUnpairedDistance`
        * :oe:meth:`OEBio::OEPerceiveInteractionOptions::SetMinHBondContactFraction`


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

            OEHBondInteractionHint(unsigned int type, bool charged = false)

      .. oe:language:: python

         .. oe:api:: python

            OEHBondInteractionHint(type: int, charged: bool = False) -> OEHBondInteractionHint

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

      .. note::

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

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

         .. oe:api::

            OEHBondInteractionHint(const OEHBondInteractionHint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHBondInteractionHint(rhs: OEHBondInteractionHint) -> OEHBondInteractionHint

      Copy constructor.


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

      .. oe:api::

         OEHBondInteractionHint &operator=(const OEHBondInteractionHint &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:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`
      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:: GetHBondType

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

         .. oe:api::

            unsigned int GetHBondType() const

      .. oe:language:: python

         .. oe:api:: python

            GetHBondType() -> int

      Returns the type of the :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`
      object.
      The return value is taken from the :oe:constns:`OEBio::OEHBondInteractionHintType`
      namespace.


   .. oe:method:: IsCharged

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

         .. oe:api::

            bool IsCharged() const

      .. oe:language:: python

         .. oe:api:: python

            IsCharged() -> bool


      Returns whether or not the :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`
      object represents a charged interaction.


   .. 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
      **hydrogen bond** interaction when added to an
      :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object.

      Interactions with the :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>` type
      can be either **intermolecular** or **intramolecular**.
