.. oe:namespace:: OESz

.. meta::
   :keywords: OEBoundEntropyOptions, BoundEntropyOptions


.. _OESz_OEBoundEntropyOptions:

.. oe:class:: OEBoundEntropyOptions: public OELigandChargeOptions

   .. oe:api::

      class OEBoundEntropyOptions : public OESystem::OEOptions

   Configuration options for :oe:func:`OESz::OEBoundLigandEntropy`
   bound-ligand entropy calculations.

   .. seealso::

      * :ref:`OEEntropyResults <OESz_OEEntropyResults>` class
      * :oe:func:`OESz::OEBoundLigandEntropy` function

   The following methods are publicly inherited from :ref:`OELigandChargeOptions <OESz_OELigandChargeOptions>`:
    * :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>`

   The :ref:`OEBoundEntropyOptions <OESz_OEBoundEntropyOptions>` class defines the following public methods:
    * :ref:`GetForceField<OESz_OEBoundEntropyOptions_GetForceField>`,
      :ref:`GetForceFieldType<OESz_OEBoundEntropyOptions_GetForceFieldType>` and
      :ref:`SetForceField<OESz_OEBoundEntropyOptions_SetForceField>`


   .. oe:method:: Constructors

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

         .. oe:api::

            OEBoundEntropyOptions()
            OEBoundEntropyOptions(const OEBoundEntropyOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEBoundEntropyOptions() -> OEBoundEntropyOptions
            OEBoundEntropyOptions(arg2: OEBoundEntropyOptions) -> OEBoundEntropyOptions

      Default and copy constructors.

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

      .. oe:api::

         OEBoundEntropyOptions &operator=(const OEBoundEntropyOptions &)

      Assignment operator.


   .. _OESz_OEBoundEntropyOptions_GetForceField:

   .. oe:method:: GetForceField

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

         .. oe:api::

            const OEFF::OEComplexFF* GetForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceField() -> OEComplexFF

      See :oe:meth:`SetForceField<OESz::OEProteinLigandOptOptions::SetForceField>` method.


   .. _OESz_OEBoundEntropyOptions_GetForceFieldType:

   .. oe:method:: GetForceFieldType

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

         .. oe:api::

            unsigned GetForceFieldType() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceFieldType() -> int

      See :oe:meth:`SetForceField<OESz::OEProteinLigandOptOptions::SetForceField>` method.


   .. _OESz_OEBoundEntropyOptions_SetForceField:
   
   .. oe:method:: SetForceField

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

         .. oe:api::

            bool SetForceField(const unsigned)
            bool SetForceField(const std::string&)
            bool SetForceField(const OEFF::OEComplexFF&)

      .. oe:language:: python

         .. oe:api:: python

            SetForceField(value: int) -> bool
            SetForceField(value: str) -> bool
            SetForceField(value: oeistream) -> bool
            SetForceField(value: OEComplexFF) -> bool

      Sets the **force field** for optimization.  The first overload takes an `unsigned` 
      from the :oe:constns:`OESz::OEComplexFFType` namespace, and the second overload
      takes corresponding string values. The final overload allows the use of a user-defined
      :ref:`OEComplexFF <OEFF_OEComplexFF>`. Method returns ``false`` when the invalid selection
      is chosen, ``true`` otherwise.
      **Default:** :oe:const:`OESz::OEComplexFFType::FF14SB_SAGE`
