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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodScoreOptions, BroodScoreOptions


.. _OEBioisostere_OEBroodScoreOptions:

.. oe:class:: OEBroodScoreOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodScoreOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for finding bioisosteric 
   fragment replacement matches, used with scoring fragments while performing overlay 
   optimization with :ref:`OEBroodOverlay<OEBioisostere_OEBroodOverlay>`.

   The :ref:`OEBroodScoreOptions <OEBioisostere_OEBroodScoreOptions>` class defines the following public methods:
    * :oe:meth:`GetUseBondOrder<OEBioisostere::OEBroodScoreOptions::GetUseBondOrder>` and
      :oe:meth:`SetUseBondOrder<OEBioisostere::OEBroodScoreOptions::SetUseBondOrder>`
    * :oe:meth:`GetUseProperty<OEBioisostere::OEBroodScoreOptions::GetUseProperty>` and
      :oe:meth:`SetUseProperty<OEBioisostere::OEBroodScoreOptions::SetUseProperty>`
    * :oe:meth:`GetCheckGeometry<OEBioisostere::OEBroodScoreOptions::GetCheckGeometry>` and
      :oe:meth:`SetCheckGeometry<OEBioisostere::OEBroodScoreOptions::SetCheckGeometry>`
    * :oe:meth:`GetAttachCutoff<OEBioisostere::OEBroodScoreOptions::GetAttachCutoff>` and
      :oe:meth:`SetAttachCutoff<OEBioisostere::OEBroodScoreOptions::SetAttachCutoff>`
    * :oe:meth:`GetShapeCutoff<OEBioisostere::OEBroodScoreOptions::GetShapeCutoff>` and
      :oe:meth:`SetShapeCutoff<OEBioisostere::OEBroodScoreOptions::SetShapeCutoff>`
    * :oe:meth:`GetChargeType<OEBioisostere::OEBroodScoreOptions::GetChargeType>` and
      :oe:meth:`SetChargeType<OEBioisostere::OEBroodScoreOptions::SetChargeType>`
    * :oe:meth:`GetPropertyOptions<OEBioisostere::OEBroodScoreOptions::GetPropertyOptions>` and
      :oe:meth:`SetPropertyOptions<OEBioisostere::OEBroodScoreOptions::SetPropertyOptions>`

   
   .. _OEBioisostere_OEBroodScoreOptions_Constructors:

   .. oe:method:: Constructors

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

         .. oe:api::

            OEBroodScoreOptions()
            OEBroodScoreOptions(const OEBroodScoreOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodScoreOptions() -> OEBroodScoreOptions
            OEBroodScoreOptions(arg2: OEBroodScoreOptions) -> OEBroodScoreOptions

      Default and copy constructors.

   .. _OEBioisostere_OEBroodScoreOptions_operator=:

   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api::

            OEBroodScoreOptions &operator=(const OEBroodScoreOptions &)

      Assignment operator.

   .. _OEBioisostere_OEBroodScoreOptions_GetUseBondOrder:

   .. oe:method:: GetUseBondOrder

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

         .. oe:api::

            bool GetUseBondOrder() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseBondOrder() -> bool

      See :oe:meth:`SetUseBondOrder<OEBioisostere::OEBroodScoreOptions::SetUseBondOrder>` method.

   .. _OEBioisostere_OEBroodScoreOptions_GetUseProperty:

   .. oe:method:: GetUseProperty

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

         .. oe:api::

            bool GetUseProperty() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseProperty() -> bool

      See :oe:meth:`SetUseProperty<OEBioisostere::OEBroodScoreOptions::SetUseProperty>` method.

   .. _OEBioisostere_OEBroodScoreOptions_GetCheckGeometry:

   .. oe:method:: GetCheckGeometry

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

         .. oe:api::

            bool GetCheckGeometry() const

      .. oe:language:: python

         .. oe:api:: python

            GetCheckGeometry() -> bool

      See :oe:meth:`SetCheckGeometry<OEBioisostere::OEBroodScoreOptions::SetCheckGeometry>` method.

   .. _OEBioisostere_OEBroodScoreOptions_GetAttachCutoff:

   .. oe:method:: GetAttachCutoff

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

         .. oe:api::

            double GetAttachCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetAttachCutoff() -> float

      See :oe:meth:`SetAttachCutoff<OEBioisostere::OEBroodScoreOptions::SetAttachCutoff>` method.

   .. _OEBioisostere_OEBroodScoreOptions_GetShapeCutoff:

   .. oe:method:: GetShapeCutoff

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

         .. oe:api::

            double GetShapeCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeCutoff() -> float

      See :oe:meth:`SetShapeCutoff<OEBioisostere::OEBroodScoreOptions::SetShapeCutoff>` method.

   .. _OEBioisostere_OEBroodScoreOptions_GetChargeType:

   .. oe:method:: GetChargeType

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

         .. oe:api::

            unsigned GetChargeType() const

      .. oe:language:: python

         .. oe:api:: python

            GetChargeType() -> int

      See :oe:meth:`SetChargeType<OEBioisostere::OEBroodScoreOptions::SetChargeType>` method.


   .. _OEBioisostere_OEBroodScoreOptions_GetPropertyOptions:

   .. oe:method:: GetPropertyOptions

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

         .. oe:api::

            OEMolPropertyOptions& GetPropertyOptions()
            const OEMolPropertyOptions& GetPropertyOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetPropertyOptions() -> OEMolPropertyOptions

      See :oe:meth:`SetPropertyOptions<OEBioisostere::OEBroodScoreOptions::SetPropertyOptions>` method.

   .. _OEBioisostere_OEBroodScoreOptions_SetUseBondOrder:

   .. oe:method:: SetUseBondOrder

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

         .. oe:api::

            bool SetUseBondOrder(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseBondOrder(value: bool) -> bool

      Sets if **Same attachment bond order** should be required for a possible match.
      **Default: True.**

   .. _OEBioisostere_OEBroodScoreOptions_SetUseProperty:

   .. oe:method:: SetUseProperty

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

         .. oe:api::

            bool SetUseProperty(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseProperty(value: bool) -> bool

      Sets if **Fragment property should be checked** for a possible match.
      **Default: False.**

   .. _OEBioisostere_OEBroodScoreOptions_SetCheckGeometry:

   .. oe:method:: SetCheckGeometry

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

         .. oe:api::

            bool SetCheckGeometry(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetCheckGeometry(value: bool) -> bool

      Sets if **Minimal geometric difference should be required** for a possible match.
      **Default: True.**

   .. _OEBioisostere_OEBroodScoreOptions_SetAttachCutoff:

   .. oe:method:: SetAttachCutoff

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

         .. oe:api::

            bool SetAttachCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetAttachCutoff(value: float) -> bool

      Sets the **Minimum acceptable attachment tanimoto** for a possible match.
      **Default: 0.78.**

   .. _OEBioisostere_OEBroodScoreOptions_SetShapeCutoff:

   .. oe:method:: SetShapeCutoff

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

         .. oe:api::

            bool SetShapeCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetShapeCutoff(value: float) -> bool

      Sets the **Minimum acceptable shape tanimoto** for a possible match.
      **Default: 0.6.**

   .. _OEBioisostere_OEBroodScoreOptions_SetPropertyOptions:

   .. oe:method:: SetPropertyOptions

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

         .. oe:api::

            void SetPropertyOptions(const OEMolPropertyOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetPropertyOptions(opts: OEMolPropertyOptions) -> None

      Sets :oe:cls:`options <OEBioisostere::OEMolPropertyOptions>` related to required molecular property values.

   .. oe:method:: SetChargeType

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

         .. oe:api::

            bool SetChargeType(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetChargeType(value: int) -> bool

      Sets the **partial charge model** to use for electrostatic Tanimoto calculations
      when scoring with the :ref:`ET <OEBioisostere_OEBroodScoreType_ET>` score type.
      Legal values: :ref:`MMFF94 <OEProton_OECharges_MMFF94>` and
      :ref:`NoOp <OEProton_OECharges_NoOp>`. (NoOp means to  use charges already on the molecule, as with the BROOD
      option fileChrg.)
      **Default:** :ref:`MMFF94 <OEProton_OECharges_MMFF94>`.
