.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEBio

..  _oebio_oesaltbridgeinteractionhinttype:

.. oe:constnamespace:: OESaltBridgeInteractionHintType

   This namespace contains constants for the
   :ref:`OESaltBridgeInteractionHint <OEBio_OESaltBridgeInteractionHint>` interaction type.

   .. seealso::

      * :ref:`OEInteractionHint <OEBio_OEInteractionHint>` class
      * :ref:`OEIsSaltBridgeInteractionHint <OEBio_OEIsSaltBridgeInteractionHint>` functor

   .. oe:constant: Clash CURRENTLY NOT USED

   .. oe:constant:: LigandNegative

      A salt-bridge interaction with the :oe:const:`OEBio::OESaltBridgeInteractionHintType::LigandNegative`
      type represents an interaction where the 'ligand' component of an active site has **negative**
      charge and the 'protein' component of an active site has **positive** charge.

   .. oe:constant:: LigandPositive

      A salt-bridge interaction with the :oe:const:`OEBio::OESaltBridgeInteractionHintType::LigandPositive`
      type represents an interaction where the 'ligand' component of an active site has **positive**
      charge and the 'protein' component of an active site has **negative** charge.

   .. oe:constant:: ProteinNegative

      Same as the :oe:const:`OEBio::OESaltBridgeInteractionHintType::LigandPositive` constant.

   .. oe:constant:: ProteinPositive

      Same as the :oe:const:`OEBio::OESaltBridgeInteractionHintType::LigandNegative` constant.

   .. oe:constant:: UnpairedLigand

      .. warning::

         |DEPRECATED-API|
         Please use :oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedLigandPositive` or
         :oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedLigandNegative` instead.

   .. oe:constant:: UnpairedLigandPositive

      A **positively** charged ligand atom or group near the protein without a significant 
      interaction with the protein.

   .. oe:constant:: UnpairedLigandNegative

      A **negatively** charged ligand atom or group near the protein without a significant 
      interaction with the protein.

   .. oe:constant:: UnpairedProtein

      .. warning::

         |DEPRECATED-API|
         Please use :oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedProteinPositive` or
         :oe:const:`OEBio::OESaltBridgeInteractionHintType::UnpairedProteinNegative` instead.

   .. oe:constant:: UnpairedProteinPositive

      A **positively** charged protein atom or group near the ligand without a significant 
      interaction with the ligand.

   .. oe:constant:: UnpairedProteinNegative

      A **negatively** charged protein atom or group near the ligand without a significant 
      interaction with the ligand.

   .. oe:constant:: IntramolecularLigand

      An intramolecular ligand saltbridge.

   .. oe:constant:: IntramolecularProtein

      An intramolecular protein saltbridge.

