.. oe:namespace:: OEBio


.. _OEBio_OEIsCationPiInteractionHint:

.. oe:class:: OEIsCationPiInteractionHint

   .. oe:api::

      class OEIsCationPiInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsCationPiInteractionHint <OEBio_OEIsCationPiInteractionHint>` functor that
   identifies **cation-Pi** interactions.

   .. seealso::

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

      * :ref:`OEIsIntermolecularCationPiInteractionHint <OEBio_OEIsIntermolecularCationPiInteractionHint>` predicate
      * :ref:`OEIsIntramolecularCationPiInteractionHint <OEBio_OEIsIntramolecularCationPiInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsCationPiInteractionHint(bool includeIntra = true)

      .. oe:language:: python

         .. oe:api:: python

            OEIsCationPiInteractionHint(includeIntra: bool = True) -> OEIsCationPiInteractionHint
            OEIsCationPiInteractionHint(arg2: OEIsCationPiInteractionHint) -> OEIsCationPiInteractionHint

      Constructor.

      :param includeIntra: If ``true`` (default), intramolecular cation-pi
         interactions are included in the results.


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

      .. oe:api::

         OEIsCationPiInteractionHint & operator=(const OEIsCationPiInteractionHint &)

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

   .. 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:`OEIsCationPiInteractionHint <OEBio_OEIsCationPiInteractionHint>`
      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.

