.. oe:namespace:: OEBio


.. _OEBio_OEChelatorInteractionHint:

.. oe:class:: OEChelatorInteractionHint

   .. oe:api::

      class OEChelatorInteractionHint : public OEInteractionHintTypeBase

   The :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>` class represents
   a built-in type that identifies interactions stored in an
   :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` object as
   **chelator (metal)** interactions (inter- and intramolecular).

   .. seealso::

      * :oe:constns:`OEBio::OEChelatorInteractionHintType` namespace for specific **chelator** interaction types
      * :ref:`OEIsChelatorInteractionHint <OEBio_OEIsChelatorInteractionHint>` predicate
      * :ref:`OEIsIntramolecularChelatorInteractionHint <OEBio_OEIsIntramolecularChelatorInteractionHint>` predicate
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEInteractionHintContainer <OEBio_OEInteractionHintContainer>` class

      To perceive **chelator** interactions:

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


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

            OEChelatorInteractionHint(unsigned int type)

      .. oe:language:: python

         .. oe:api:: python

            OEChelatorInteractionHint(type: int) -> OEChelatorInteractionHint

      Constructor to create a **chelator** interaction type with the
      given parameter.

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

      .. note::

         Two :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>` objects with different
         types from the :oe:constns:`OEBio::OEChelatorInteractionHintType`
         namespace are considered to be different.

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

         .. oe:api::

            OEChelatorInteractionHint(const OEChelatorInteractionHint& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEChelatorInteractionHint(rhs: OEChelatorInteractionHint) -> OEChelatorInteractionHint

      Copy Constructor.


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

      .. oe:api::

         OEChelatorInteractionHint &operator=(const OEChelatorInteractionHint &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:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`
      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:: GetChelatorType

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

         .. oe:api::

            unsigned int GetChelatorType() const

      .. oe:language:: python

         .. oe:api:: python

            GetChelatorType() -> int

      Returns the type of the :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`
      object.
      The return value is taken from the :oe:constns:`OEBio::OEChelatorInteractionHintType`
      namespace.


   .. 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
      **chelator** 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.
