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

.. role:: raw-html(raw)
   :format: html

.. oe:namespace:: OEMedChem


.. meta::
   :keywords: OEBemisMurckoOptions, BemisMurckoOptions


.. _OEMedChem_OEBemisMurckoOptions:

.. oe:class:: OEBemisMurckoOptions

  .. oe:api::

    class OEBemisMurckoOptions : public OESystem::OEOptions

  The functions :oe:func:`OEMedChem::OEGetRingLinkerSideChainFragments` and
  :oe:func:`OEMedChem::OEGetBemisMurcko` both return sets of Bemis-Murcko fragments.
  The :ref:`OEBemisMurckoOptions <OEMedChem_OEBemisMurckoOptions>` class can be used to
  specify both the :oe:constns:`OEMedChem::OERegionType` of these fragments 
  and to add sidechains that match user-specified criteria to the main
  Bemis-Murcko framework.

  .. seealso::

     * :oe:func:`OEMedChem::OEGetBemisMurcko` function
     * :oe:func:`OEMedChem::OEGetRingLinkerSideChainFragments` function

  .. oe:method:: Constructors

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

       .. oe:api::

          OEBemisMurckoOptions()

    .. oe:language:: python

       .. oe:api:: python

          OEBemisMurckoOptions() -> OEBemisMurckoOptions
          OEBemisMurckoOptions(arg2: OEBemisMurckoOptions) -> OEBemisMurckoOptions

    Default constructor, which sets the perceived fragment type to All, as defined in the
    :ref:`OERegionType <OEMedChem_OERegionType>` namespace. No additional SMARTS substituents are set.
  
   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBemisMurckoOptions & operator=(const OEBemisMurckoOptions &)

      Assignment operator.


  .. ################################################################
     # CreateCopy 
     ################################################################

  .. oe:method:: CreateCopy 

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

       .. oe:api::

          OEBemisMurckoOptions* CreateCopy() const

    .. oe:language:: python

       .. oe:api:: python

          CreateCopy() -> OEBemisMurckoOptions

    Returns a pointer to a copy of the options object. 
  
  .. ################################################################
     # GetRegionType
     ################################################################

  .. oe:method:: GetRegionType

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

       .. oe:api::

          std::string GetRegionType() const

    .. oe:language:: python

       .. oe:api:: python

          GetRegionType() -> str

    Returns the name of the :oe:constns:`OEMedChem::OERegionType` set in the options class. 
  
  .. ###############################################################
     # GetSubstituentSearch
     ################################################################

  .. oe:method:: GetSubstituentSearch

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

       .. oe:api::

          OEChem::OESubSearch GetSubstituentSearch() const

    .. oe:language:: python

       .. oe:api:: python

          GetSubstituentSearch() -> OESubSearch

    Returns the subsearch used to add custom substituents to the Bemis-Murcko framework.  

  .. ################################################################
     # GetUnsaturatedHeteroBonds
     ################################################################

  .. oe:method:: GetUnsaturatedHeteroBonds

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

       .. oe:api::

          bool GetUnsaturatedHeteroBonds() const

    .. oe:language:: python

       .. oe:api:: python

          GetUnsaturatedHeteroBonds() -> bool

    Gets the boolean indicating whether sidechains beginning with unsaturated bonds to hetero atoms will
    be included in the main Bemis-Murcko framework.   
  
  .. ################################################################
     # SetRegionType
     ################################################################

  .. oe:method:: SetRegionType

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

       .. oe:api::

          bool SetRegionType(std::string regionType)

    .. oe:language:: python

       .. oe:api:: python

          SetRegionType(value: str) -> bool

    Sets the name of the :oe:constns:`OEMedChem::OERegionType` for fragments perceived. 
  
  .. ###############################################################
     # SetSubstituentSearch
     ################################################################

  .. oe:method:: SetSubstituentSearch

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

        .. oe:api::

           bool SetSubstituentSearch(const OEChem::OESubSearch value)

     .. oe:language:: python

        .. oe:api:: python

           SetSubstituentSearch(value: OESubSearch) -> bool

    Sets an :ref:`OESubSearch <OEChem_OESubSearch>` for custom substituents to be added to the
    Bemis-Murcko framework. 

  .. ################################################################
     # SetUnsaturatedHeteroBonds
     ################################################################

  .. oe:method:: SetUnsaturatedHeteroBonds

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

       .. oe:api::

          bool SetUnsaturatedHeteroBonds(bool includeUnsaturatedHeteroBonds)

    .. oe:language:: python

       .. oe:api:: python

          SetUnsaturatedHeteroBonds(value: bool) -> bool

    Sets whether sidechains beginning with unsaturated bonds to hetero atoms will
    be included in the main Bemis-Murcko framework. To be included in the main
    framework when this option is true, the beginning atom of the sidechain 
    must satisfy the :ref:`OEIsHetero <OEChem_OEIsHetero>` predicate and the bond from
    the framework to this sidechain must have order greater than one. 
   
  .. ################################################################
     # Validate 
     ################################################################

  .. oe:method:: Validate 

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

       .. oe:api::

          bool Validate() const

    .. oe:language:: python

       .. oe:api:: python

          Validate() -> bool

    Returns true is the current settings in the options class are valid.
