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

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

.. oe:namespace:: OEChem


.. meta::
   :keywords: OERxnAutomapperOptions, RxnAutomapperOptions


.. _OEChem_OERxnAutomapperOptions:

.. oe:class:: OERxnAutomapperOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OERxnAutomapperOptions

   Encapsulates the properties that control reaction mapping using :ref:`OERxnAutomapper <OEChem_OERxnAutomapper>`.

   .. seealso::

      * :ref:`OERxnAutomapper <OEChem_OERxnAutomapper>` class

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

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

         .. oe:api::

            OERxnAutomapperOptions()

      .. oe:language:: python

         .. oe:api:: python

            OERxnAutomapperOptions() -> OERxnAutomapperOptions

      Default constructor that initializes an :ref:`OERxnAutomapperOptions <OEChem_OERxnAutomapperOptions>`
      object with the following properties:

      .. list-table::  **Default parameters of OERxnAutomapperOptions**
         :widths: 50 50 50
         :header-rows: 1

         * - Description
           - Option
           - Default value

         * - Mapping Method
           - :oe:meth:`GetMappingMethod()<OEChem::OERxnAutomapperOptions::GetMappingMethod>`
           - :oe:const:`OEChem::OERxnAutomapMethod::MCSMapping`

         * - MCS Mapping Mode
           - :oe:meth:`GetMCSExhaustiveMode()<OEChem::OERxnAutomapperOptions::GetMCSExhaustiveMode>`
           - ``false``

         * - Clear Mapping
           - :oe:meth:`GetClearMapping()<OEChem::OERxnAutomapperOptions::GetClearMapping>`
           - ``true``

         * - Extend Mapping
           - :oe:meth:`GetExtendMappedRegions()<OEChem::OERxnAutomapperOptions::GetExtendMappedRegions>`
           - ``true``

         * - Strict Mapping
           - :oe:meth:`GetStrictMapping()<OEChem::OERxnAutomapperOptions::GetStrictMapping>`
           - ``false``

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

         .. oe:api::

            OERxnAutomapperOptions(const OERxnAutomapperOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OERxnAutomapperOptions(arg2: OERxnAutomapperOptions) -> OERxnAutomapperOptions

      Copy constructor.

   .. ################################################################
      # operator=
      ################################################################

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OERxnAutomapperOptions &operator=(const OERxnAutomapperOptions &rhs)

      Assignment operator.

   .. ################################################################
      # GetClearMapping
      ################################################################

   .. oe:method:: GetClearMapping

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

         .. oe:api::

            bool GetClearMapping() const

      .. oe:language:: python

         .. oe:api:: python

            GetClearMapping() -> bool

      Returns whether existing atom-atom mappings should be cleared prior
      to attempting the reaction mapping activity.  Existing atom-atom mappings
      *may* be used to guide the reaction mapping activity if not cleared.

      .. seealso::

         * :oe:meth:`OEChem::OEAtomBase::GetMapIdx` method
         * :oe:meth:`OEChem::OEAtomBase::SetMapIdx` method

   .. ################################################################
      # GetExtendMappedRegions
      ################################################################

   .. oe:method:: GetExtendMappedRegions

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

         .. oe:api::

            bool GetExtendMappedRegions() const

      .. oe:language:: python

         .. oe:api:: python

            GetExtendMappedRegions() -> bool

      Returns whether unassigned mapped regions can be augmented with unambiguous
      reactant and product atom correspondences to maximize the size of the reaction mapping.

   .. ################################################################
      # GetMappingMethod
      ################################################################

   .. oe:method:: GetMappingMethod

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

         .. oe:api::

            unsigned GetMappingMethod() const

      .. oe:language:: python

         .. oe:api:: python

            GetMappingMethod() -> int

      Returns the requested mapping method to use for the reaction mapping correspondence.

   .. ################################################################
      # GetMCSExhaustiveMode
      ################################################################

   .. oe:method:: GetMCSExhaustiveMode

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

         .. oe:api::

            bool GetMCSExhaustiveMode() const

      .. oe:language:: python

         .. oe:api:: python

            GetMCSExhaustiveMode() -> bool

      Returns whether the exhaustive MCS mapping mode should being used
      when the automapping is using the MCS method.

   .. ################################################################
      # GetStrictMapping
      ################################################################

   .. oe:method:: GetStrictMapping

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

         .. oe:api::

            bool GetStrictMapping() const

      .. oe:language:: python

         .. oe:api:: python

            GetStrictMapping() -> bool

      Returns the requested activation state for strict reaction mapping validation activities.

   .. ################################################################
      # SetClearMapping
      ################################################################

   .. oe:method:: SetClearMapping

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

         .. oe:api::

            bool SetClearMapping(bool flag)

      .. oe:language:: python

         .. oe:api:: python

            SetClearMapping(value: bool) -> bool

      Sets whether existing atom-atom mappings should be cleared prior
      to attempting the reaction mapping activity.  Existing atom-atom mappings
      may be used to guide the reaction mapping activity if not cleared.

      .. seealso::

         * :oe:meth:`OEChem::OERxnAutomapperOptions::GetClearMapping` method

   .. ################################################################
      # SetExtendMappedRegions
      ################################################################

   .. oe:method:: SetExtendMappedRegions

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

         .. oe:api::

            bool SetExtendMappedRegions(bool flag)

      .. oe:language:: python

         .. oe:api:: python

            SetExtendMappedRegions(value: bool) -> bool

      Sets whether unassigned mapped regions can be augmented with unambiguous
      reactant and product atom correspondences to maximize the size of the reaction mapping.

   .. ################################################################
      # SetMappingMethod
      ################################################################

   .. oe:method:: SetMappingMethod

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

         .. oe:api::

            bool SetMappingMethod(unsigned method)

      .. oe:language:: python

         .. oe:api:: python

            SetMappingMethod(value: int) -> bool

      Sets the requested mapping method to use for the reaction mapping correspondence.
      This is simply a placeholder for future methods, currently only an MCS mapping approach
      is available.

   .. ################################################################
      # SetMCSExhaustiveMode
      ################################################################

   .. oe:method:: SetMCSExhaustiveMode

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

         .. oe:api::

            bool SetMCSExhaustiveMode(bool flag)

      .. oe:language:: python

         .. oe:api:: python

            SetMCSExhaustiveMode(value: bool) -> bool

      Sets whether the slower exhaustive MCS mapping mode should be used
      when the automapping is using the MCS method.

   .. ################################################################
      # SetStrictMapping
      ################################################################

   .. oe:method:: SetStrictMapping

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

         .. oe:api::

            bool SetStrictMapping(bool flag)

      .. oe:language:: python

         .. oe:api:: python

            SetStrictMapping(value: bool) -> bool

      Enables or disables strict reaction mapping validation activities.

