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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodGeneralOptions, BroodGeneralOptions


.. _OEBioisostere_OEBroodGeneralOptions:

.. oe:class:: OEBroodGeneralOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodGeneralOptions : public OESystem::OEOptions

   This class provides an interface to setup basic options related to 
   bioisosteric fragment replacement.

   The :ref:`OEBroodGeneralOptions <OEBioisostere_OEBroodGeneralOptions>` class defines the following public methods:
    * :oe:meth:`GetAttachScale<OEBioisostere::OEBroodGeneralOptions::GetAttachScale>` and
      :oe:meth:`SetAttachScale<OEBioisostere::OEBroodGeneralOptions::SetAttachScale>`
    * :oe:meth:`GetBumpRadius<OEBioisostere::OEBroodGeneralOptions::GetBumpRadius>` and
      :oe:meth:`SetBumpRadius<OEBioisostere::OEBroodGeneralOptions::SetBumpRadius>`
    * :oe:meth:`GetScoreType<OEBioisostere::OEBroodGeneralOptions::GetScoreType>` and
      :oe:meth:`SetScoreType<OEBioisostere::OEBroodGeneralOptions::SetScoreType>`
    * :oe:meth:`GetIgnoreProtein<OEBioisostere::OEBroodGeneralOptions::GetIgnoreProtein>` and
      :oe:meth:`SetIgnoreProtein<OEBioisostere::OEBroodGeneralOptions::SetIgnoreProtein>`
    * :oe:meth:`GetIgnoreSelectionProtein<OEBioisostere::OEBroodGeneralOptions::GetIgnoreSelectionProtein>` and
      :oe:meth:`SetIgnoreSelectionProtein<OEBioisostere::OEBroodGeneralOptions::SetIgnoreSelectionProtein>`
    * :oe:meth:`GetRangeSize<OEBioisostere::OEBroodGeneralOptions::GetRangeSize>` and
      :oe:meth:`SetRangeSize<OEBioisostere::OEBroodGeneralOptions::SetRangeSize>`
    * :oe:meth:`GetRangeOffset<OEBioisostere::OEBroodGeneralOptions::GetRangeOffset>` and
      :oe:meth:`SetRangeOffset<OEBioisostere::OEBroodGeneralOptions::SetRangeOffset>`
    * :oe:meth:`GetRingOnly<OEBioisostere::OEBroodGeneralOptions::GetRingOnly>` and
      :oe:meth:`SetRingOnly<OEBioisostere::OEBroodGeneralOptions::SetRingOnly>`

   

   .. _OEBioisostere_OEBroodGeneralOptions_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

            OEBroodGeneralOptions()
            OEBroodGeneralOptions(const OEBroodGeneralOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodGeneralOptions() -> OEBroodGeneralOptions
            OEBroodGeneralOptions(arg2: OEBroodGeneralOptions) -> OEBroodGeneralOptions

      Default and copy constructors.


   .. _OEBioisostere_OEBroodGeneralOptions_operator=:
   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api::

            OEBroodGeneralOptions &operator=(const OEBroodGeneralOptions &)

      Assignment operator.


   .. _OEBioisostere_OEBroodGeneralOptions_GetAttachScale:
   .. oe:method:: GetAttachScale

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

         .. oe:api::

            double GetAttachScale() const

      .. oe:language:: python

         .. oe:api:: python

            GetAttachScale() -> float

      See :oe:meth:`SetAttachScale<OEBioisostere::OEBroodGeneralOptions::SetAttachScale>` method.


   .. _OEBioisostere_OEBroodGeneralOptions_GetBumpRadius:
   .. oe:method:: GetBumpRadius

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

         .. oe:api::

            double GetBumpRadius() const

      .. oe:language:: python

         .. oe:api:: python

            GetBumpRadius() -> float

      See :oe:meth:`SetBumpRadius<OEBioisostere::OEBroodGeneralOptions::SetBumpRadius>` method.


   .. _OEBioisostere_OEBroodGeneralOptions_GetScoreType:
   .. oe:method:: GetScoreType

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

         .. oe:api::

            unsigned GetScoreType() const

      .. oe:language:: python

         .. oe:api:: python

            GetScoreType() -> int

      See :oe:meth:`SetScoreType<OEBioisostere::OEBroodGeneralOptions::SetScoreType>` method.


   .. _OEBioisostere_OEBroodGeneralOptions_SetAttachScale:
   .. oe:method:: SetAttachScale

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

         .. oe:api::

            bool SetAttachScale(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetAttachScale(value: float) -> bool

      Sets the **scaling factor** for attachment point scores. This value determines the 
      balance between the chemical color score and the attachment point scores. Higher values 
      indicate more weighting for the attachment-point alignment.
      **Default: 1.5.**


   .. _OEBioisostere_OEBroodGeneralOptions_SetBumpRadius:
   .. oe:method:: SetBumpRadius

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

         .. oe:api::

            bool SetBumpRadius(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetBumpRadius(value: float) -> bool

      Sets the **minimum distance defining clash** between ligand heavy atoms and protein 
      heavy atoms. New analogs with atoms closer than this cutoff to the active-site protein 
      are marked as clashing, and eventually discarded from the hitlist.
      **Default: 2.25.**


   .. _OEBioisostere_OEBroodGeneralOptions_SetScoreType:
   .. oe:method:: SetScoreType

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

         .. oe:api::

            bool SetScoreType(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetScoreType(value: int) -> bool

      Sets the **method** to be used for scoring overlap between the query fragment and the
      replacement fragment. Possible choices of methods are described in
      :ref:`OEBroodScoreType <OEBioisostere_OEBroodScoreType>`.
      Default: :ref:`ROCS <OEBioisostere_OEBroodScoreType_ROCS>`.

   .. oe:method:: GetIgnoreProtein

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

         .. oe:api::

            bool GetIgnoreProtein() const

      .. oe:language:: python

         .. oe:api:: python

            GetIgnoreProtein() -> bool

      See :oe:meth:`SetIgnoreProtein<OEBioisostere::OEBroodGeneralOptions::SetIgnoreProtein>` method.

   .. oe:method:: GetIgnoreSelectionProtein

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

         .. oe:api::

            bool GetIgnoreSelectionProtein() const

      .. oe:language:: python

         .. oe:api:: python

            GetIgnoreSelectionProtein() -> bool

      See :oe:meth:`SetIgnoreSelectionProtein<OEBioisostere::OEBroodGeneralOptions::SetIgnoreSelectionProtein>` method.

   .. oe:method:: GetRangeSize

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

         .. oe:api::

            unsigned GetRangeSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetRangeSize() -> int

      See :oe:meth:`SetRangeSize<OEBioisostere::OEBroodGeneralOptions::SetRangeSize>` method.

   .. oe:method:: GetRangeOffset

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

         .. oe:api::

            unsigned GetRangeOffset() const

      .. oe:language:: python

         .. oe:api:: python

            GetRangeOffset() -> int

      See :oe:meth:`SetRangeOffset<OEBioisostere::OEBroodGeneralOptions::SetRangeOffset>` method.

   .. oe:method:: GetRingOnly

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

         .. oe:api::

            int GetRingOnly() const

      .. oe:language:: python

         .. oe:api:: python

            GetRingOnly() -> int

      See :oe:meth:`SetRingOnly<OEBioisostere::OEBroodGeneralOptions::SetRingOnly>` method.

   .. oe:method:: SetIgnoreProtein

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

         .. oe:api::

            bool SetIgnoreProtein(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetIgnoreProtein(value: bool) -> bool

      Sets whether the **protein associated with the query** should be ignored during scoring.
      When true, receptor clash and protein-select checks are skipped even if a protein
      was provided to :oe:func:`OEBioisostere::OECreateBroodQuery`.
      **Default: False.**

   .. oe:method:: SetIgnoreSelectionProtein

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

         .. oe:api::

            bool SetIgnoreSelectionProtein(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetIgnoreSelectionProtein(value: bool) -> bool

      Sets whether the **selectivity protein associated with the query** should be ignored
      during scoring. When true, protein-select scoring is skipped even if a selectivity
      protein was provided to :oe:func:`OEBioisostere::OECreateBroodQuery`.
      **Default: False.**

   .. _OEBioisostere_OEBroodGeneralOptions_SetRangeSize:

   .. oe:method:: SetRangeSize

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

         .. oe:api::

            bool SetRangeSize(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetRangeSize(value: int) -> bool

      Sets the **range of heavy atom counts** around the query fragment heavy atom count
      to examine from the database. Fragments whose heavy atom count falls outside
      ``[queryHeavy - rangeOffset - rangeSize, queryHeavy - rangeOffset + rangeSize]``
      are skipped.
      **Default: 6.**

   .. _OEBioisostere_OEBroodGeneralOptions_SetRangeOffset:

   .. oe:method:: SetRangeOffset

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

         .. oe:api::

            bool SetRangeOffset(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetRangeOffset(value: int) -> bool

      Sets a **bias toward smaller or larger fragments** relative to the query. A positive
      offset shifts the search window toward larger fragments; a negative offset toward
      smaller fragments. Works together with
      :oe:meth:`SetRangeSize<OEBioisostere::OEBroodGeneralOptions::SetRangeSize>`.
      **Default: 0.**

   .. oe:method:: SetRingOnly

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

         .. oe:api::

            bool SetRingOnly(const int)

      .. oe:language:: python

         .. oe:api:: python

            SetRingOnly(value: int) -> bool

      Sets the **requirement for rings** in selecting a fragment.
      This flag has to do with a count of the number of ring atoms in the shortest path between
      attachment points in a fragment. In cases with more than 2 attachment points, all shortest
      paths are calculated and the number of ring atoms is summed.
      **Default: -2**
