.. oe:namespace:: OEBio


.. _OEBio_OEIsIntramolecularStackingInteractionHint:

.. oe:class:: OEIsIntramolecularStackingInteractionHint

   .. oe:api::

      class OEIsIntramolecularStackingInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsIntramolecularStackingInteractionHint <OEBio_OEIsIntramolecularStackingInteractionHint>` functor that
   identifies **intramolecular stacking** interactions between aromatic rings
   within the same molecule (ligand or protein).

   .. seealso::

      * :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>` class
      * :oe:constns:`OEBio::OEStackingInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsStackingInteractionHint <OEBio_OEIsStackingInteractionHint>` predicate
      * :ref:`OEIsIntermolecularStackingInteractionHint <OEBio_OEIsIntermolecularStackingInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsIntramolecularStackingInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsIntramolecularStackingInteractionHint() -> OEIsIntramolecularStackingInteractionHint
            OEIsIntramolecularStackingInteractionHint(arg2: OEIsIntramolecularStackingInteractionHint) -> OEIsIntramolecularStackingInteractionHint

      Default constructor.


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

      .. oe:api::

         OEIsIntramolecularStackingInteractionHint & operator=(const OEIsIntramolecularStackingInteractionHint &)

      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 intramolecular
      stacking type *i.e.* the
      :oe:meth:`OEBio::OEInteractionHint::GetInteractionType` method returns an
      :ref:`OEStackingInteractionHint <OEBio_OEStackingInteractionHint>` with
      one of the following types:

      * :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularLigandPi`
      * :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularLigandT`
      * :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularProteinPi`
      * :oe:const:`OEBio::OEStackingInteractionHintType::IntramolecularProteinT`


   .. 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:`OEIsIntramolecularStackingInteractionHint <OEBio_OEIsIntramolecularStackingInteractionHint>`
      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.
