.. oe:namespace:: OEProton


.. meta::
   :keywords: OEFormalChargeOptions, FormalChargeOptions, ChargeEngine


.. _OEProton_OEFormalChargeOptions:

.. oe:class:: OEFormalChargeOptions

   .. oe:api::


      class OEFormalChargeOptions

   This class is used for setting options during tautomer enumeration
   with :oe:func:`OEProton::OEEnumerateFormalCharges`.


   .. oe:method:: Constructors

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

         .. oe:api::

            OEFormalChargeOptions(const OEFormalChargeOptions& rhs)
            OEFormalChargeOptions(unsigned int maxCount = 0u,
                                  bool verbose = false, bool warts = true)

      .. oe:language:: python

         .. oe:api:: python

            OEFormalChargeOptions(maxCount: int = 0, verbose: bool = False,
                                  warts: bool = True) -> OEFormalChargeOptions
            OEFormalChargeOptions(rhs: OEFormalChargeOptions) -> OEFormalChargeOptions

      Default and copy constructors.

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

      .. oe:api::

         OEFormalChargeOptions &operator=(const OEFormalChargeOptions &rhs)

      Assignment operator.

   .. oe:method:: GetMaxCount

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

         .. oe:api::

            unsigned int GetMaxCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxCount() -> int

      Get the maximum number of charge states to be enumerated.

   .. oe:method:: GetVerbose

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

         .. oe:api::

            bool GetVerbose() const

      .. oe:language:: python

         .. oe:api:: python

            GetVerbose() -> bool

      Get whether detailed info will be printed during charge enumeration.

   .. oe:method:: GetWarts

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

         .. oe:api::

            bool GetWarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetWarts() -> bool

      Get whether to add ``wart`` to the title of each charge state.

   .. oe:method:: SetMaxCount

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

         .. oe:api::

            void SetMaxCount(unsigned int max)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxCount(max: int) -> None

      Set the maximum number of charge states to be enumerated.

   .. oe:method:: SetVerbose

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

         .. oe:api::

            void SetVerbose(bool verbose)

      .. oe:language:: python

         .. oe:api:: python

            SetVerbose(verbose: bool) -> None

      Set whether detailed info is to be printed during charge enumeration.
      The default is ``false``.

   .. oe:method:: SetWarts

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

         .. oe:api::

            void SetWarts(bool warts)

      .. oe:language:: python

         .. oe:api:: python

            SetWarts(warts: bool) -> None

      Set whether to add ``wart`` to the title of each charge state.
      The default is ``true``.
