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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEIntrinsicPropOptions, IntrinsicPropOptions


.. _OEBioisostere_OEIntrinsicPropOptions:

.. oe:class:: OEIntrinsicPropOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEIntrinsicPropOptions : public OESystem::OEOptions

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

   The :ref:`OEIntrinsicPropOptions <OEBioisostere_OEIntrinsicPropOptions>` class defines the following public methods:
    * :oe:meth:`GetAromaticJCT<OEBioisostere::OEIntrinsicPropOptions::GetAromaticJCT>` and
      :oe:meth:`SetAromaticJCT<OEBioisostere::OEIntrinsicPropOptions::SetAromaticJCT>`
    * :oe:meth:`GetHeavyAtomCount<OEBioisostere::OEIntrinsicPropOptions::GetHeavyAtomCount>` and
      :oe:meth:`SetHeavyAtomCount<OEBioisostere::OEIntrinsicPropOptions::SetHeavyAtomCount>`
    * :oe:meth:`GetMolWt<OEBioisostere::OEIntrinsicPropOptions::GetMolWt>` and
      :oe:meth:`SetMolWt<OEBioisostere::OEIntrinsicPropOptions::SetMolWt>`
    * :oe:meth:`GetRotorCount<OEBioisostere::OEIntrinsicPropOptions::GetRotorCount>` and
      :oe:meth:`SetRotorCount<OEBioisostere::OEIntrinsicPropOptions::SetRotorCount>`
    * :oe:meth:`GetSp3CFrac<OEBioisostere::OEIntrinsicPropOptions::GetSp3CFrac>` and
      :oe:meth:`SetSp3CFrac<OEBioisostere::OEIntrinsicPropOptions::SetSp3CFrac>`
    * :oe:meth:`GetTPSA<OEBioisostere::OEIntrinsicPropOptions::GetTPSA>` and
      :oe:meth:`SetTPSA<OEBioisostere::OEIntrinsicPropOptions::SetTPSA>`


   .. _OEBioisostere_OEIntrinsicPropOptions_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

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

      .. oe:language:: python

         .. oe:api:: python

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

      Default and copy constructors.


   .. _OEBioisostere_OEIntrinsicPropOptions_operator=:
   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api::

            OEIntrinsicPropOptions &operator=(const OEIntrinsicPropOptions &)

      Assignment operator.


   .. _OEBioisostere_OEIntrinsicPropOptions_GetAromaticJCT:
   .. oe:method:: GetAromaticJCT

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

         .. oe:api::

            unsigned GetAromaticJCT() const

      .. oe:language:: python

         .. oe:api:: python

            GetAromaticJCT() -> int

      See :oe:meth:`SetAromaticJCT<OEBioisostere::OEIntrinsicPropOptions::SetAromaticJCT>` method.


   .. _OEBioisostere_OEIntrinsicPropOptions_GetHeavyAtomCount:
   .. oe:method:: GetHeavyAtomCount

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

         .. oe:api::

            unsigned GetHeavyAtomCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeavyAtomCount() -> int

      See :oe:meth:`SetHeavyAtomCount<OEBioisostere::OEIntrinsicPropOptions::SetHeavyAtomCount>` method.


   .. _OEBioisostere_OEIntrinsicPropOptions_GetMolWt:
   .. oe:method:: GetMolWt

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

         .. oe:api::

            double GetMolWt() const

      .. oe:language:: python

         .. oe:api:: python

            GetMolWt() -> float

      See :oe:meth:`SetMolWt<OEBioisostere::OEIntrinsicPropOptions::SetMolWt>` method.


   .. _OEBioisostere_OEIntrinsicPropOptions_GetRotorCount:
   .. oe:method:: GetRotorCount

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

         .. oe:api::

            unsigned GetRotorCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetRotorCount() -> int

      See :oe:meth:`SetRotorCount<OEBioisostere::OEIntrinsicPropOptions::SetRotorCount>` method.


   .. _OEBioisostere_OEIntrinsicPropOptions_GetSp3CFrac:
   .. oe:method:: GetSp3CFrac

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

         .. oe:api::

            double GetSp3CFrac() const

      .. oe:language:: python

         .. oe:api:: python

            GetSp3CFrac() -> float

      See :oe:meth:`SetSp3CFrac<OEBioisostere::OEIntrinsicPropOptions::SetSp3CFrac>` method.


   .. _OEBioisostere_OEIntrinsicPropOptions_GetTPSA:
   .. oe:method:: GetTPSA

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

         .. oe:api::

            unsigned GetTPSA() const

      .. oe:language:: python

         .. oe:api:: python

            GetTPSA() -> int

      See :oe:meth:`SetTPSA<OEBioisostere::OEIntrinsicPropOptions::SetTPSA>` method.


   .. _OEBioisostere_OEIntrinsicPropOptions_SetAromaticJCT:
   .. oe:method:: SetAromaticJCT

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

         .. oe:api::

            bool SetAromaticJCT(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetAromaticJCT(value: int) -> bool

      Sets the aromatic ring count for any selected analog. The number of aromatic rings
      is defined as the number of aromatic rings is #aromatic bonds - #aromatic atoms + 1
      **Default: [Min: 0, Max: 5]**


   .. _OEBioisostere_OEIntrinsicPropOptions_SetHeavyAtomCount:
   .. oe:method:: SetHeavyAtomCount

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

         .. oe:api::

            bool SetHeavyAtomCount(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetHeavyAtomCount(value: int) -> bool

      Sets the number of heavy atoms for any selected analog.
      **Default: [Min: 7, Max: 35]**


   .. _OEBioisostere_OEIntrinsicPropOptions_SetMolWt:
   .. oe:method:: SetMolWt

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

         .. oe:api::

            bool SetMolWt(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetMolWt(value: float) -> bool

      Sets the required molecular weight for any selected analog.
      **Default: [Min: 100, Max: 500]**


   .. _OEBioisostere_OEIntrinsicPropOptions_SetRotorCount:
   .. oe:method:: SetRotorCount

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

         .. oe:api::

            bool SetRotorCount(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetRotorCount(value: int) -> bool

      Sets the required number of rotatable bonds for any selected analog.
      **Default: [Min: 0, Max: 13]**


   .. _OEBioisostere_OEIntrinsicPropOptions_SetSp3CFrac:
   .. oe:method:: SetSp3CFrac

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

         .. oe:api::

            bool SetSp3CFrac(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetSp3CFrac(value: float) -> bool

      Sets the required fraction of carbons that are sp\ :sup:`3` for any selected analog.
      There is some evidence that increasing the fraction of carbons in a series that 
      are sp\ :sup:`3` (escaping from “Flatland”) improved success in clinical trials [Lovering-2009].
      **Default: [Min: 0.3, Max: 1.0]**


   .. _OEBioisostere_OEIntrinsicPropOptions_SetTPSA:
   .. oe:method:: SetTPSA

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

         .. oe:api::

            bool SetTPSA(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetTPSA(value: int) -> bool

      Sets the required topological polar surface area (TPSA) for any selected analog.
      **Default: [Min: 60, Max: 150]**
