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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodBuildOptions, BroodBuildOptions


.. _OEBioisostere_OEBroodBuildOptions:

.. oe:class:: OEBroodBuildOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodBuildOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for building molecules
   with replaced fragments. These options are used both from 
   :ref:`OEBroodMolBuilder<OEBioisostere_OEBroodMolBuilder>` and
   :ref:`OEHitlistBuilder<OEBioisostere_OEHitlistBuilder>`.

   The :ref:`OEBroodBuildOptions <OEBioisostere_OEBroodBuildOptions>` class defines the following public methods:
    * :oe:meth:`GetBuildType<OEBioisostere::OEBroodBuildOptions::GetBuildType>` and
      :oe:meth:`SetBuildType<OEBioisostere::OEBroodBuildOptions::SetBuildType>`
    * :oe:meth:`GetNeutralPH<OEBioisostere::OEBroodBuildOptions::GetNeutralPH>` and
      :oe:meth:`SetNeutralPH<OEBioisostere::OEBroodBuildOptions::SetNeutralPH>`
    * :oe:meth:`GetTautomers<OEBioisostere::OEBroodBuildOptions::GetTautomers>` and
      :oe:meth:`SetTautomers<OEBioisostere::OEBroodBuildOptions::SetTautomers>`
    * :oe:meth:`GetCheckBond<OEBioisostere::OEBroodBuildOptions::GetCheckBond>` and
      :oe:meth:`SetCheckBond<OEBioisostere::OEBroodBuildOptions::SetCheckBond>`
    * :oe:meth:`GetMaxLocalStrain<OEBioisostere::OEBroodBuildOptions::GetMaxLocalStrain>` and
      :oe:meth:`SetMaxLocalStrain<OEBioisostere::OEBroodBuildOptions::SetMaxLocalStrain>`
    * :oe:meth:`GetDeltaLocalStrain<OEBioisostere::OEBroodBuildOptions::GetDeltaLocalStrain>` and
      :oe:meth:`SetDeltaLocalStrain<OEBioisostere::OEBroodBuildOptions::SetDeltaLocalStrain>`

   

   .. _OEBioisostere_OEBroodBuildOptions_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

            OEBroodBuildOptions()
            OEBroodBuildOptions(const OEBroodBuildOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodBuildOptions() -> OEBroodBuildOptions
            OEBroodBuildOptions(arg2: OEBroodBuildOptions) -> OEBroodBuildOptions

      Default and copy constructors.


   .. _OEBioisostere_OEBroodBuildOptions_operator=:
   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api::

            OEBroodBuildOptions &operator=(const OEBroodBuildOptions &)

      Assignment operator.

   .. _OEBioisostere_OEBroodBuildOptions_GetBuildType:

   .. oe:method:: GetBuildType

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

         .. oe:api::

            unsigned GetBuildType() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuildType() -> int

      See :oe:meth:`SetBuildType<OEBioisostere::OEBroodBuildOptions::SetBuildType>` method.

   .. _OEBioisostere_OEBroodBuildOptions_GetNeutralPH:

   .. oe:method:: GetNeutralPH

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

         .. oe:api::

            bool GetNeutralPH() const

      .. oe:language:: python

         .. oe:api:: python

            GetNeutralPH() -> bool

      See :oe:meth:`SetNeutralPH<OEBioisostere::OEBroodBuildOptions::SetNeutralPH>` method.

   .. _OEBioisostere_OEBroodBuildOptions_GetTautomers:

   .. oe:method:: GetTautomers

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

         .. oe:api::

            bool GetTautomers() const

      .. oe:language:: python

         .. oe:api:: python

            GetTautomers() -> bool

      See :oe:meth:`SetTautomers<OEBioisostere::OEBroodBuildOptions::SetTautomers>` method.

   .. _OEBioisostere_OEBroodBuildOptions_GetCheckBond:

   .. oe:method:: GetCheckBond

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

         .. oe:api::

            bool GetCheckBond() const

      .. oe:language:: python

         .. oe:api:: python

            GetCheckBond() -> bool

      See :oe:meth:`SetCheckBond<OEBioisostere::OEBroodBuildOptions::SetCheckBond>` method.

   .. _OEBioisostere_OEBroodBuildOptions_GetMaxLocalStrain:

   .. oe:method:: GetMaxLocalStrain

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

         .. oe:api::

            double GetMaxLocalStrain() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxLocalStrain() -> float

      See :oe:meth:`SetMaxLocalStrain<OEBioisostere::OEBroodBuildOptions::SetMaxLocalStrain>` method.

   .. _OEBioisostere_OEBroodBuildOptions_SetBuildType:

   .. oe:method:: SetBuildType

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

         .. oe:api::

            bool SetBuildType(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetBuildType(value: int) -> bool

      Sets if **Build Type** to be applied in constructing the new analogs.
      Possible choices of methods are described in
      :ref:`OEBroodBuildType <OEBioisostere_OEBroodBuildType>`.
      Default: :ref:`Optimize3D <OEBioisostere_OEBroodBuildType_Optimize3D>`.

   .. _OEBioisostere_OEBroodBuildOptions_SetNeutralPH:

   .. oe:method:: SetNeutralPH

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

         .. oe:api::

            bool SetNeutralPH(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetNeutralPH(value: bool) -> bool

      Sets if **Neutral pH model** to be applied on newly constructed analogs.
      **Default: True.**

   .. _OEBioisostere_OEBroodBuildOptions_SetTautomers:

   .. oe:method:: SetTautomers

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

         .. oe:api::

            bool SetTautomers(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetTautomers(value: bool) -> bool

      Sets if **Reasonable tautomer model** to be applied on newly constructed analogs.
      **Default: False.**

   .. _OEBioisostere_OEBroodBuildOptions_SetCheckBond:

   .. oe:method:: SetCheckBond

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

         .. oe:api::

            bool SetCheckBond(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetCheckBond(value: bool) -> bool

      Sets if **Bond stability should be checked** in generating hitlist.
      **Default: True.**

   .. _OEBioisostere_OEBroodBuildOptions_SetMaxLocalStrain:

   .. oe:method:: SetMaxLocalStrain

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

         .. oe:api::

            bool SetMaxLocalStrain(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxLocalStrain(value: float) -> bool

      Sets the **Number allowable local strain** in the generated hits.
      **Default: 6.5.**

   .. _OEBioisostere_OEBroodBuildOptions_GetDeltaLocalStrain:

   .. oe:method:: GetDeltaLocalStrain

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

         .. oe:api::

            bool GetDeltaLocalStrain() const

      .. oe:language:: python

         .. oe:api:: python

            GetDeltaLocalStrain() -> bool

      See :oe:meth:`SetDeltaLocalStrain<OEBioisostere::OEBroodBuildOptions::SetDeltaLocalStrain>` method.

   .. _OEBioisostere_OEBroodBuildOptions_SetDeltaLocalStrain:

   .. oe:method:: SetDeltaLocalStrain

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

         .. oe:api::

            bool SetDeltaLocalStrain(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetDeltaLocalStrain(value: bool) -> bool

      Sets if **relative local strain** between the query fragment and the analog
      should be used as a measure of strain, rather than the absolute local strain
      of the analog alone.
      **Default: False.**
