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

.. oe:namespace:: OESpruce



.. _OESpruce_OEProtonateDesignUnitOptions:

.. oe:class:: OEProtonateDesignUnitOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OEProtonateDesignUnitOptions : public OESystem::OEOptions

   This class stores the optional parameter sets used in design unit protonation for use in the :oe:func:`OESpruce::OEProtonateDesignUnit` function.


   .. oe:method:: Constructors

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

         .. oe:api::

            OEProtonateDesignUnitOptions()
            OEProtonateDesignUnitOptions(const OEBio::OEPlaceHydrogensOptions& placeHOpts)
            OEProtonateDesignUnitOptions(const OEProtonateDesignUnitOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEProtonateDesignUnitOptions() -> OEProtonateDesignUnitOptions
            OEProtonateDesignUnitOptions(placeHOpts: OEPlaceHydrogensOptions) -> OEProtonateDesignUnitOptions
            OEProtonateDesignUnitOptions(rhs: OEProtonateDesignUnitOptions) -> OEProtonateDesignUnitOptions

      Default and copy constructors.

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

      .. oe:api::

         OEProtonateDesignUnitOptions &operator=(const OEProtonateDesignUnitOptions &rhs)

      Assignment operator.

   .. oe:method:: GetGenerateTautomers

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

         .. oe:api::

            bool GetGenerateTautomers() const

      .. oe:language:: python

         .. oe:api:: python

            GetGenerateTautomers() -> bool

      Returns the boolean whether or not to generate tautomers for the ligand and cofactors.

   .. oe:method:: GetHetGroupNbrDist

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

         .. oe:api::

            double GetHetGroupNbrDist() const

      .. oe:language:: python

         .. oe:api:: python

            GetHetGroupNbrDist() -> float

      Returns the distance cutoff for two groups to be considered within the same cluster.

   .. oe:method:: GetOptimizeExpProtons

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

         .. oe:api::

            bool GetOptimizeExpProtons() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptimizeExpProtons() -> bool

      Returns the boolean whether or not to optimize the position of experimental protons.

   .. oe:method:: GetPlaceHydrogensOptions

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

         .. oe:api::

            OEBio::OEPlaceHydrogensOptions& GetPlaceHydrogensOptions()
            const OEBio::OEPlaceHydrogensOptions& GetPlaceHydrogensOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetPlaceHydrogensOptions() -> OEPlaceHydrogensOptions

      Returns a reference to the stored place hydrogen options (:ref:`OEPlaceHydrogensOptions <OEBio_OEPlaceHydrogensOptions>`) class.

.. _OESpruce_OEProtonateDesignUnitOptions_SetGenerateTautomers:

   .. oe:method:: SetGenerateTautomers

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

         .. oe:api::

            bool SetGenerateTautomers(const bool generateTautomers)

      .. oe:language:: python

         .. oe:api:: python

            SetGenerateTautomers(value: bool) -> bool

      Sets the boolean of whether or not to generate tautomers.

.. _OESpruce_OEProtonateDesignUnitOptions_SetHetGroupNbrDist:

   .. oe:method:: SetHetGroupNbrDist

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

         .. oe:api::

            bool SetHetGroupNbrDist(const double hetGroupNbrDist)

      .. oe:language:: python

         .. oe:api:: python

            SetHetGroupNbrDist(value: float) -> bool

      Sets the distance cutoff for two groups to be considered within the same cluster.

.. _OESpruce_OEProtonateDesignUnitOptions_SetOptimizeExpProtons:

   .. oe:method:: SetOptimizeExpProtons

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

         .. oe:api::

            bool SetOptimizeExpProtons(const bool optimizeExpProtons)

      .. oe:language:: python

         .. oe:api:: python

            SetOptimizeExpProtons(value: bool) -> bool

      Sets the boolean whether or not to optimize the position of experimental protons.

.. _OESpruce_OEProtonateDesignUnitOptions_SetPlaceHydrogensOptions:

   .. oe:method:: SetPlaceHydrogensOptions

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

         .. oe:api::

            void SetPlaceHydrogensOptions(const OEBio::OEPlaceHydrogensOptions& value)

      .. oe:language:: python

         .. oe:api:: python

            SetPlaceHydrogensOptions(opts: OEPlaceHydrogensOptions) -> None

      Sets the place hydrogens options class (:ref:`OEPlaceHydrogensOptions <OEBio_OEPlaceHydrogensOptions>`).

   .. seealso::

      * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class
      * :ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>` class
      * :ref:`OEPlaceHydrogensOptions <OEBio_OEPlaceHydrogensOptions>` class
