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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEExtrinsicPropOptions, ExtrinsicPropOptions


.. _OEBioisostere_OEExtrinsicPropOptions:

.. oe:class:: OEExtrinsicPropOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEExtrinsicPropOptions : public OESystem::OEOptions

   This class provides an interface to setup options related to medicinal chemistry
   property limits during fragment replacement scoring.

   The :ref:`OEExtrinsicPropOptions <OEBioisostere_OEExtrinsicPropOptions>` class defines the following public methods:
    * :oe:meth:`GetComplexity<OEBioisostere::OEExtrinsicPropOptions::GetComplexity>` and
      :oe:meth:`SetComplexity<OEBioisostere::OEExtrinsicPropOptions::SetComplexity>`
    * :oe:meth:`GetFrequency<OEBioisostere::OEExtrinsicPropOptions::GetFrequency>` and
      :oe:meth:`SetFrequency<OEBioisostere::OEExtrinsicPropOptions::SetFrequency>`
    * :oe:meth:`GetLipinski<OEBioisostere::OEExtrinsicPropOptions::GetLipinski>` and
      :oe:meth:`SetLipinski<OEBioisostere::OEExtrinsicPropOptions::SetLipinski>`
    * :oe:meth:`GetLipinskiAcc<OEBioisostere::OEExtrinsicPropOptions::GetLipinskiAcc>` and
      :oe:meth:`SetLipinskiAcc<OEBioisostere::OEExtrinsicPropOptions::SetLipinskiAcc>`
    * :oe:meth:`GetLipinskiDon<OEBioisostere::OEExtrinsicPropOptions::GetLipinskiDon>` and
      :oe:meth:`SetLipinskiDon<OEBioisostere::OEExtrinsicPropOptions::SetLipinskiDon>`
    * :oe:meth:`GetLogP<OEBioisostere::OEExtrinsicPropOptions::GetLogP>` and
      :oe:meth:`SetLogP<OEBioisostere::OEExtrinsicPropOptions::SetLogP>`
    * :oe:meth:`GetMartin<OEBioisostere::OEExtrinsicPropOptions::GetMartin>` and
      :oe:meth:`SetMartin<OEBioisostere::OEExtrinsicPropOptions::SetMartin>`
   

   .. _OEBioisostere_OEExtrinsicPropOptions_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

            OEExtrinsicPropOptions(const unsigned type = OEBroodMolPropertyType::MIN)
            OEExtrinsicPropOptions(const OEExtrinsicPropOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEExtrinsicPropOptions(type: int) -> OEExtrinsicPropOptions
            OEExtrinsicPropOptions(arg2: OEExtrinsicPropOptions) -> OEExtrinsicPropOptions

      Default and copy constructors.


   .. _OEBioisostere_OEExtrinsicPropOptions_operator=:
   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api::

            OEExtrinsicPropOptions &operator=(const OEExtrinsicPropOptions &)

      Assignment operator.


   .. _OEBioisostere_OEExtrinsicPropOptions_GetComplexity:
   .. oe:method:: GetComplexity

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

         .. oe:api::

            double GetComplexity() const

      .. oe:language:: python

         .. oe:api:: python

            GetComplexity() -> float

      See :oe:meth:`SetComplexity<OEBioisostere::OEExtrinsicPropOptions::SetComplexity>` method.


   .. _OEBioisostere_OEExtrinsicPropOptions_GetFrequency:
   .. oe:method:: GetFrequency

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

         .. oe:api::

            unsigned GetFrequency() const

      .. oe:language:: python

         .. oe:api:: python

            GetFrequency() -> int

      See :oe:meth:`SetFrequency<OEBioisostere::OEExtrinsicPropOptions::SetFrequency>` method.


   .. _OEBioisostere_OEExtrinsicPropOptions_GetLipinski:
   .. oe:method:: GetLipinski

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

         .. oe:api::

            unsigned GetLipinski() const

      .. oe:language:: python

         .. oe:api:: python

            GetLipinski() -> int

      See :oe:meth:`SetLipinski<OEBioisostere::OEExtrinsicPropOptions::SetLipinski>` method.


   .. _OEBioisostere_OEExtrinsicPropOptions_GetLipinskiAcc:
   .. oe:method:: GetLipinskiAcc

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

         .. oe:api::

            unsigned GetLipinskiAcc() const

      .. oe:language:: python

         .. oe:api:: python

            GetLipinskiAcc() -> int

      See :oe:meth:`SetLipinskiAcc<OEBioisostere::OEExtrinsicPropOptions::SetLipinskiAcc>` method.


   .. _OEBioisostere_OEExtrinsicPropOptions_GetLipinskiDon:
   .. oe:method:: GetLipinskiDon

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

         .. oe:api::

            unsigned GetLipinskiDon() const

      .. oe:language:: python

         .. oe:api:: python

            GetLipinskiDon() -> int

      See :oe:meth:`SetLipinskiDon<OEBioisostere::OEExtrinsicPropOptions::SetLipinskiDon>` method.


   .. _OEBioisostere_OEExtrinsicPropOptions_GetLogP:
   .. oe:method:: GetLogP

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

         .. oe:api::

            double GetLogP() const

      .. oe:language:: python

         .. oe:api:: python

            GetLogP() -> float

      See :oe:meth:`SetLogP<OEBioisostere::OEExtrinsicPropOptions::SetLogP>` method.


   .. _OEBioisostere_OEExtrinsicPropOptions_GetMartin:
   .. oe:method:: GetMartin

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

         .. oe:api::

            double GetMartin() const

      .. oe:language:: python

         .. oe:api:: python

            GetMartin() -> float

      See :oe:meth:`SetMartin<OEBioisostere::OEExtrinsicPropOptions::SetMartin>` method.


   .. _OEBioisostere_OEExtrinsicPropOptions_SetComplexity:
   .. oe:method:: SetComplexity

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

         .. oe:api::

            bool SetComplexity(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetComplexity(value: float) -> bool

      Sets the molecular complexity range for any selected analog.
      **Default: [Min: 0.0, Max: 1.0]**


   .. _OEBioisostere_OEExtrinsicPropOptions_SetFrequency:
   .. oe:method:: SetFrequency

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

         .. oe:api::

            bool SetFrequency(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetFrequency(value: int) -> bool

      Sets the fragment frequency in the database for any selected analog.
      The frequency is a percentile number indicating the frequency of each fragment 
      normalized relative to the frequency of fragments in the database. Frequency as assessed 
      here is a measure of how common each fragment is among the source molecules. The most 
      commonly occurring fragment would be in the 99th percentile, while the least commonly 
      occurring fragments would be in the 1st percentile.
      **Default: [Min: 0, Max: 100]**


   .. _OEBioisostere_OEExtrinsicPropOptions_SetLipinski:
   .. oe:method:: SetLipinski

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

         .. oe:api::

            bool SetLipinski(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetLipinski(value: int) -> bool

      Sets the allowed Lipinski violations for any selected analog.
      In order to segregate molecules that progressed
      through clinical trials, Lipinski determined that one violation was acceptable, but two were not [Lipinski-1997]_.
      **Default: [Min: 0  Max: 1]**


   .. _OEBioisostere_OEExtrinsicPropOptions_SetLipinskiAcc:
   .. oe:method:: SetLipinskiAcc

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

         .. oe:api::

            bool SetLipinskiAcc(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetLipinskiAcc(value: int) -> bool

      Sets the required number of Lipinski hydrogen bond acceptors for any selected analog.
      For the purpose of this measure, H-bond acceptors are determined by the method of
      Lipinski [Lipinski-1997]_.
      **Default: [Min: 2, Max: 11]**


   .. _OEBioisostere_OEExtrinsicPropOptions_SetLipinskiDon:
   .. oe:method:: SetLipinskiDon

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

         .. oe:api::

            bool SetLipinskiDon(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetLipinskiDon(value: int) -> bool

      Sets the required number of Lipinski hydrogen bond donors for any selected analog.
      For the purpose of this measure, H-bond donors are determined by the method of
      Lipinski [Lipinski-1997]_.
      **Default: [Min: 1, Max: 8]**


   .. _OEBioisostere_OEExtrinsicPropOptions_SetLogP:
   .. oe:method:: SetLogP

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

         .. oe:api::

            bool SetLogP(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetLogP(value: float) -> bool

      Sets the required calculated LogP for any selected analog.
      **Default: [Min: -1.0, Max: 5.0]**


   .. _OEBioisostere_OEExtrinsicPropOptions_SetMartin:
   .. oe:method:: SetMartin

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

         .. oe:api::

            bool SetMartin(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetMartin(value: float) -> bool

      Sets the required Abbott Bioavailability Score (ABS) for any selected analog.
      This floating point ABS parameter (range 0.0-1.0) indicates the minimum allowable 
      probability that F will be >10% in rats according the QSAR model developed and 
      published by Yvonne Martin [Martin-2005]_. A value of 0.0 will allow all compounds to pass.
      **Default: [Min: 0.2, Max: 1.0]**
