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


.. oe:namespace:: OEProton

.. meta::
  :keywords: OEMultistatepKaModelOptions, OEMultistatepKaModel, pKaModel


.. _OEProton_OEMultistatepKaModelOptions:

.. oe:class:: OEMultistatepKaModelOptions

  .. attention::

    |PRELIMINARY-API|

  .. oe:api::

     class OEMultistatepKaModelOptions

  This class provides an interface to set up options required for
  :ref:`OEMultistatepKaModel <OEProton_OEMultistatepKaModel>`.
  

  The :ref:`OEMultistatepKaModelOptions <OEProton_OEMultistatepKaModelOptions>` class defines the following public methods:

    * :oe:meth:`GetpH<OEProton::OEMultistatepKaModelOptions::GetpH>` and 
      :oe:meth:`SetpH<OEProton::OEMultistatepKaModelOptions::SetpH>`
    * :oe:meth:`GetProcessCarbons<OEProton::OEMultistatepKaModelOptions::GetProcessCarbons>` and
      :oe:meth:`SetProcessCarbons<OEProton::OEMultistatepKaModelOptions::SetProcessCarbons>`
    * :oe:meth:`GetMaxNumMicrostates<OEProton::OEMultistatepKaModelOptions::GetMaxNumMicrostates>` and
      :oe:meth:`SetMaxNumMicrostates<OEProton::OEMultistatepKaModelOptions::SetMaxNumMicrostates>`

   
  .. oe:method:: Constructors

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

       .. oe:api::

          OEMultistatepKaModelOptions()
          OEMultistatepKaModelOptions(unsigned int maxnummicrostates,
                                      bool processcarbons)

    .. oe:language:: python

       .. oe:api:: python

          OEMultistatepKaModelOptions() -> OEMultistatepKaModelOptions
          OEMultistatepKaModelOptions(maxmicrostates: int, pc: bool) -> OEMultistatepKaModelOptions

    Copy constructor.

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

       .. oe:api::

          OEMultistatepKaModelOptions(const OEMultistatepKaModelOptions&)

    .. oe:language:: python

       .. oe:api:: python

          OEMultistatepKaModelOptions(rhs: OEMultistatepKaModelOptions) -> OEMultistatepKaModelOptions

    Copy assignment constructor.

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

       .. oe:api::

          OEMultistatepKaModelOptions& operator=(const OEMultistatepKaModelOptions& rhs)

    .. oe:language:: python

       .. oe:api:: python

          OEMultistatepKaModelOptions(rhs: OEMultistatepKaModelOptions) -> OEMultistatepKaModelOptions


  .. oe:method:: GetpH

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

       .. oe:api::

          unsigned int GetpH()

    .. oe:language:: python

       .. oe:api:: python

          GetpH() -> int

    Gets the value of the pH parameters at which a user wants to assess ionization states of the molecule.
    Only a neutral pH can be set.
    This option is defined in anticipation of a wider pKa model at different pH environments.


  .. oe:method:: SetpH

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

       .. oe:api::

          bool SetpH(unsigned ph)

    .. oe:language:: python

       .. oe:api:: python

          SetpH(ph: int) -> bool

    Sets the pH to be used to assess the ionization states of the molecule. Only a neutral pH can be set.
    This option is defined in anticipation of a wider pKa model at different pH environments.


  .. oe:method:: GetProcessCarbons

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

       .. oe:api::

          bool GetProcessCarbons()

    .. oe:language:: python

       .. oe:api:: python

          GetProcessCarbons() -> bool

    Returns the parameter setting requesting the pKa assessment of carbon atoms.
    Default is true.


  .. oe:method:: SetProcessCarbons

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

       .. oe:api::

          bool SetProcessCarbons(bool pc)

    .. oe:language:: python

       .. oe:api:: python

          SetProcessCarbons(pc: bool) -> bool

    Sets whether a user wants to assess the pKa of carbon atoms, true or false.

  .. oe:method:: GetMaxNumMicrostates

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

         .. oe:api::

            unsigned int GetMaxNumMicrostates()

      .. oe:language:: python

         .. oe:api:: python

            GetMaxNumMicrostates() -> int

      Gets the value of maximum number of microstates to generate; the parameter is set by default or by the method
      :oe:meth:`SetMaxNumMicrostates<OEProton::OEMultistatepKaModelOptions::SetMaxNumMicrostates>`. 


  .. oe:method:: SetMaxNumMicrostates

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

         .. oe:api::

            bool SetMaxNumMicrostates(unsigned int maxnummicrostates)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxNumMicrostates(maxnummicrostates: int) -> bool

      Sets the maximum number of microstates to generate. If the projected number of
      microstates is more than the maximum limit set by this function, the model will not generate any microstates.
