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

.. oe:namespace:: OESz

.. meta::
   :keywords: OESzybkiProteinOptions, SzybkiProteinOptions


.. _OESz_OESzybkiProteinOptions:

.. oe:class:: OESzybkiProteinOptions

   .. oe:api::


      class OESzybkiProteinOptions : public OESystem::OEOptions

   This class represents options related to proteins in szybki.


   .. oe:method:: Constructors

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

         .. oe:api::

            OESzybkiProteinOptions()
            OESzybkiProteinOptions(const OESzybkiProteinOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OESzybkiProteinOptions() -> OESzybkiProteinOptions
            OESzybkiProteinOptions(argOpts: OESzybkiProteinOptions) -> OESzybkiProteinOptions

      Default and copy constructors.

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

      .. oe:api::

         OESzybkiProteinOptions &operator=(const OESzybkiProteinOptions &)

      Assignment operator.


   .. oe:method:: AddFlexibleResidue

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

         .. oe:api::

            bool AddFlexibleResidue(const OEChem::OEResidue&)

      .. oe:language:: python

         .. oe:api:: python

            AddFlexibleResidue(argRes: OEResidue) -> bool

      Adds a single residue to the list of residues which will be optimized together with the ligand.
      Has to be called multiple times in order to make more than one residue flexible.

      .. seealso::

         * Example in :ref:`Partially flexible protein optimization<section_flexible_residue_example>`

   .. oe:method:: ClearFlexibleResidues

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

         .. oe:api::

            void ClearFlexibleResidues()

      .. oe:language:: python

         .. oe:api:: python

            ClearFlexibleResidues() -> None

      Clears all of the currently set flexible residues.

   .. oe:method:: GetExactVdWProteinLigand

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

         .. oe:api::

            bool GetExactVdWProteinLigand() const

      .. oe:language:: python

         .. oe:api:: python

            GetExactVdWProteinLigand() -> bool

      Returns the state of the exact VdW protein-ligand flag. If true, OESzybki will be
      using analytical vdW protein-ligand interaction.

   .. oe:method:: GetIntermolecularVdWCutoff

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

         .. oe:api::

            double GetIntermolecularVdWCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetIntermolecularVdWCutoff() -> float

      Returns the value of the intermolecular vdW interactions cutoff in |A|. The intermolecular VdW interactions
      are considered to be zero between atoms that are separated by distances larger than the cutoff.

   .. oe:method:: GetProteinDielectric

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

         .. oe:api::

            double GetProteinDielectric() const

      .. oe:language:: python

         .. oe:api:: python

            GetProteinDielectric() -> float

      Returns the value of protein dielectric constant.

   .. oe:method:: GetProteinElectrostaticModel

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

         .. oe:api::

            unsigned int GetProteinElectrostaticModel() const

      .. oe:language:: python

         .. oe:api:: python

            GetProteinElectrostaticModel() -> int

      Returns the protein electrostatics model to be used for OESzybki calculations, as `unsigned int`
      from the :oe:constns:`OESz::OEProteinElectrostatics` namespace.

   .. oe:method:: GetProteinFlexibilityRange

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

         .. oe:api::

            double GetProteinFlexibilityRange() const

      .. oe:language:: python

         .. oe:api:: python

            GetProteinFlexibilityRange() -> float

      Returns the value of partial protein flexibility distance from the ligand.

   .. oe:method:: GetProteinFlexibilityType

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

         .. oe:api::

            unsigned int GetProteinFlexibilityType() const

      .. oe:language:: python

         .. oe:api:: python

            GetProteinFlexibilityType() -> int

      Returns the type of partial protein flexibility to be used for OESzybki calculations, as `unsigned int`
      from the :oe:constns:`OESz::OEProtFlex` namespace.

   .. oe:method:: HasFlexibleResidues

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

         .. oe:api::

            bool HasFlexibleResidues() const

      .. oe:language:: python

         .. oe:api:: python

            HasFlexibleResidues() -> bool

      Returns the state of flexible residues. If true, some flexible residues are currently set.

   .. oe:method:: SetExactVdWProteinLigand

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

         .. oe:api::

            bool SetExactVdWProteinLigand(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetExactVdWProteinLigand(value: bool) -> bool

      Sets the state of the exact VdW protein-ligand flag. If ``true`` is passed, OESzybki will be
      using analytical vdW protein-ligand interaction.

   .. oe:method:: SetIntermolecularVdWCutoff

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

         .. oe:api::

            bool SetIntermolecularVdWCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetIntermolecularVdWCutoff(value: float) -> bool

      Sets the value of the intermolecular vdW interactions cutoff in |A|. The intermolecular VdW interactions
      are considered to be zero between atoms that are separated by distances larger than the cutoff.
      The default value is 18 |A|, however when Newton-Raphson optimization is used (see method
      :oe:meth:`OESz::OESzybkiOptOptions::SetOptimizerType`) the default cutoff of 50 |A| is used.

   .. oe:method:: SetProteinDielectric

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

         .. oe:api::

            bool SetProteinDielectric(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetProteinDielectric(value: float) -> bool

      Sets the value of protein dielectric constant for the calculation of protein-ligand interaction.
      The default value of the protein dielectric constant is 1.0.

   .. oe:method:: SetProteinElectrostaticModel

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

         .. oe:api::

            bool SetProteinElectrostaticModel(unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetProteinElectrostaticModel(value: int) -> bool

      Sets the protein electrostatics model to be used for OESzybki calculations, as `unsigned int`
      from the :oe:constns:`OESz::OEProteinElectrostatics` namespace.
      Method returns ``false`` when the invalid selection is chosen, ``true`` otherwise.

   .. oe:method:: SetProteinFlexibilityRange

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

         .. oe:api::

            bool SetProteinFlexibilityRange(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetProteinFlexibilityRange(value: float) -> bool

      Sets the value of partial protein flexibility distance from the ligand.

   .. oe:method:: SetProteinFlexibilityType

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

         .. oe:api::

            bool SetProteinFlexibilityType(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetProteinFlexibilityType(value: int) -> bool

      Sets the type of partial protein flexibility to be used for OESzybki calculations, as `unsigned int`
      from the :oe:constns:`OESz::OEProtFlex` namespace.
      Method returns ``false`` when the invalid selection is chosen, ``true`` otherwise.

