.. oe:namespace:: OEBio


.. _OEBio_OEHasInteractionHintType:

.. oe:class:: OEHasInteractionHintType

   .. oe:api::

      class OEHasInteractionHintType : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEHasInteractionHintType <OEBio_OEHasInteractionHintType>` functor that
   identifies connections (:ref:`OEInteractionHint <OEBio_OEInteractionHint>`)
   with a specific type (:ref:`OEInteractionHintTypeBase <OEBio_OEInteractionHintTypeBase>`).

   .. seealso::

      * :oe:meth:`OEBio::OEInteractionHintContainer::GetInteractions` method

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHasInteractionHintType(const OEInteractionHintTypeBase& itype)

      .. oe:language:: python

         .. oe:api:: python

            OEHasInteractionHintType(itype: OEInteractionHintTypeBase) -> OEHasInteractionHintType

      Constructs the functor with the given interaction type.

      .. seealso::

         The following built-in interaction hint types are available:

         * :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>`
         * :ref:`OEChelatorInteractionHint <OEBio_OEChelatorInteractionHint>`
         * :ref:`OEClashInteractionHint <OEBio_OEClashInteractionHint>`
         * :ref:`OEContactInteractionHint <OEBio_OEContactInteractionHint>`
         * :ref:`OECovalentInteractionHint <OEBio_OECovalentInteractionHint>`
         * :ref:`OEHalogenBondInteractionHint <OEBio_OEHalogenBondInteractionHint>`
         * :ref:`OEHBondInteractionHint <OEBio_OEHBondInteractionHint>`
         * :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>`
         * :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>`

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

         .. oe:api::

            OEHasInteractionHintType(const OEHasInteractionHintType& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEHasInteractionHintType(arg2: OEHasInteractionHintType) -> OEHasInteractionHintType

      Copy constructor.


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

      .. oe:api::

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

      Returns ``true``, if the interaction has the same type with which the functor
      is constructed.


   .. 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:`OEHasInteractionHintType <OEBio_OEHasInteractionHintType>`
      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.
