.. oe:namespace:: OEBio


.. _OEBio_OEIsIntermolecularCationPiInteractionHint:

.. oe:class:: OEIsIntermolecularCationPiInteractionHint

   .. oe:api::

      class OEIsIntermolecularCationPiInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsIntermolecularCationPiInteractionHint <OEBio_OEIsIntermolecularCationPiInteractionHint>` functor that
   identifies **cation-pi** interactions between atoms in different molecules
   (i.e. between the ligand and the protein).

   .. seealso::

      * :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>` class
      * :oe:constns:`OEBio::OECationPiInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsCationPiInteractionHint <OEBio_OEIsCationPiInteractionHint>` predicate
      * :ref:`OEIsIntramolecularCationPiInteractionHint <OEBio_OEIsIntramolecularCationPiInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsIntermolecularCationPiInteractionHint()

      .. oe:language:: python

         .. oe:api:: python

            OEIsIntermolecularCationPiInteractionHint() -> OEIsIntermolecularCationPiInteractionHint
            OEIsIntermolecularCationPiInteractionHint(arg2: OEIsIntermolecularCationPiInteractionHint) -> OEIsIntermolecularCationPiInteractionHint

      Default constructor.


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

      .. oe:api::

         OEIsIntermolecularCationPiInteractionHint & operator=(const OEIsIntermolecularCationPiInteractionHint &)

      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 intermolecular
      cation-pi type *i.e.* the
      :oe:meth:`OEBio::OEInteractionHint::GetInteractionType` method returns an
      :ref:`OECationPiInteractionHint <OEBio_OECationPiInteractionHint>` with
      one of the following types:

      * :oe:const:`OEBio::OECationPiInteractionHintType::LigandPi`
      * :oe:const:`OEBio::OECationPiInteractionHintType::ProteinPi`


   .. 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:`OEIsIntermolecularCationPiInteractionHint <OEBio_OEIsIntermolecularCationPiInteractionHint>`
      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.
