.. oe:namespace:: OEBio


.. _OEBio_OEIsSaltBridgeInteractionHint:

.. oe:class:: OEIsSaltBridgeInteractionHint

   .. oe:api::

      class OEIsSaltBridgeInteractionHint : public OESystem::OEUnaryPredicate<OEInteractionHint>

   This class represents :ref:`OEIsSaltBridgeInteractionHint <OEBio_OEIsSaltBridgeInteractionHint>` functor that
   identifies **salt-bridge** interactions.

   .. seealso::

      * :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>` class
      * :oe:constns:`OEBio::OESaltBridgeInteractionHintType` namespace
      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class

      * :ref:`OEIsIntermolecularSaltBridgeInteractionHint <OEBio_OEIsIntermolecularSaltBridgeInteractionHint>` predicate
      * :ref:`OEIsIntramolecularSaltBridgeInteractionHint <OEBio_OEIsIntramolecularSaltBridgeInteractionHint>` predicate
      * :ref:`OEIsUnpairedInteractionHint <OEBio_OEIsUnpairedInteractionHint>` predicate

   .. oe:method:: Constructors

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

         .. oe:api::

            OEIsSaltBridgeInteractionHint(bool includeIntra = true)

      .. oe:language:: python

         .. oe:api:: python

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

      Constructor.

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


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

      .. oe:api::

         OEIsSaltBridgeInteractionHint & operator=(const OEIsSaltBridgeInteractionHint &)

      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 salt-bridge
      type *i.e.* the :oe:meth:`OEBio::OEInteractionHint::GetInteractionType`
      method returns an :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>`
      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:`OEIsSaltBridgeInteractionHint <OEBio_OEIsSaltBridgeInteractionHint>`
      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.
