.. oe:namespace:: OESz

.. meta::
   :keywords: OELigandChargeOptions, OELigandChargeOptions


.. _OESz_OELigandChargeOptions:

.. oe:class:: OELigandChargeOptions

   .. oe:api::

      class OELigandChargeOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for assigning ligand charges.

   The :ref:`OELigandChargeOptions <OESz_OELigandChargeOptions>` class defines the following public methods:
    * :oe:meth:`GetGenerateElfConfs<OESz::OELigandChargeOptions::GetGenerateElfConfs>` and
      :oe:meth:`SetGenerateElfConfs<OESz::OELigandChargeOptions::SetGenerateElfConfs>`
    * :oe:meth:`GetLigandCharge<OESz::OELigandChargeOptions::GetLigandCharge>`,
      :oe:meth:`GetLigandChargeType<OESz::OELigandChargeOptions::GetLigandChargeType>`, and
      :oe:meth:`SetLigandCharge<OESz::OELigandChargeOptions::SetLigandCharge>`


   .. oe:method:: Constructor

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

         .. oe:api::

            OELigandChargeOptions()
            OELigandChargeOptions(const OELigandChargeOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OELigandChargeOptions() -> OELigandChargeOptions
            OELigandChargeOptions(arg2: OELigandChargeOptions) -> OELigandChargeOptions

      Default and copy constructors.

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

      .. oe:api::

         OELigandChargeOptions &operator=(const OELigandChargeOptions &)


   ..   _OESz_OELigandChargeOptions_GetGenerateElfConfs:

      Assignment operator.


   .. oe:method:: GetGenerateElfConfs

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

         .. oe:api::

            bool GetGenerateElfConfs() const

      .. oe:language:: python

         .. oe:api:: python

            GetGenerateElfConfs() -> bool

      See :oe:meth:`SetGenerateElfConfs<OESz::OELigandChargeOptions::SetGenerateElfConfs>` method.


   ..   _OESz_OELigandChargeOptions_GetLigandCharge:

   .. oe:method:: GetLigandCharge

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

         .. oe:api::

            const OEProton::OEChargeEngineBase* GetLigandCharge() const
            const OEProton::OEChargeEngineBase* GetLigandCharge() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandCharge() -> OEChargeEngineBase

      See :oe:meth:`SetLigandCharge<OESz::OELigandChargeOptions::SetLigandCharge>` method.


   ..   _OESz_OELigandChargeOptions_GetLigandChargeType:

   .. oe:method:: GetLigandChargeType

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

         .. oe:api::

            unsigned GetLigandChargeType() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandChargeType() -> int

      See :oe:meth:`SetLigandCharge<OESz::OELigandChargeOptions::SetLigandCharge>` method.


   ..   _OESz_OELigandChargeOptions_SetGenerateElfConfs:

   .. oe:method:: SetGenerateElfConfs

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

         .. oe:api::

            bool SetGenerateElfConfs(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetGenerateElfConfs(value: bool) -> bool

      Sets flag if **conformers should be generated** for ELF10 conformer selection. 
      **Default: False.**


   ..   _OESz_OELigandChargeOptions_SetLigandCharge:

   .. oe:method:: SetLigandCharge

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

         .. oe:api::

            bool SetLigandCharge(const unsigned)
            bool SetLigandCharge(const std::string&)
            bool SetLigandCharge(const OEProton::OEChargeEngineBase&)

      .. oe:language:: python

         .. oe:api:: python

            SetLigandCharge(value: int) -> bool
            SetLigandCharge(value: str) -> bool
            SetLigandCharge(value: oeistream) -> bool
            SetLigandCharge(value: OEChargeEngineBase) -> bool

      Sets the **charging method** for the ligand. The first overload takes an `unsigned` 
      from the :oe:constns:`OESz::OELigandChargeType` namespace, and the second overload
      takes corresponding string values. The final overload allows the use of a user-defined
      :ref:`OEChargeEngineBase <OEProton_OEChargeEngineBase>`. Method returns ``false`` when 
      the invalid selection is chosen, ``true`` otherwise.
      **Default:** :oe:const:`OESz::OELigandChargeType::CURRENT`
