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

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

.. oe:namespace:: OEChem


.. meta::
   :keywords: OERxnAutomapper, RxnAutomapper


.. _OEChem_OERxnAutomapper:

.. oe:class:: OERxnAutomapper

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OERxnAutomapper

   Applies reactant and product reaction mapping correspondence information to a reaction molecule.

   .. seealso::

      * :ref:`OERxnAutomapperOption <OEChem_OERxnAutomapperOptions>` class

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

   .. oe:method:: Constructors

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

         .. oe:api::

            OERxnAutomapper()

      .. oe:language:: python

         .. oe:api:: python

            OERxnAutomapper() -> OERxnAutomapper

      Default constructor that initializes an :ref:`OERxnAutomapper <OEChem_OERxnAutomapper>`
      object.

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

         .. oe:api::

            OERxnAutomapper(const OERxnAutomapperOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            OERxnAutomapper(opts: OERxnAutomapperOptions) -> OERxnAutomapper

      Constructor that initializes an :ref:`OERxnAutomapper <OEChem_OERxnAutomapper>`
      object with the provided option class settings.

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

         .. oe:api::

            OERxnAutomapper(const OERxnAutomapper& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OERxnAutomapper(arg2: OERxnAutomapper) -> OERxnAutomapper

      Copy constructor.

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

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

      .. oe:api::

         OERxnAutomapper &operator=(const OERxnAutomapper &rhs)

      Assignment operator.

   .. ################################################################
      # AutoMapRxn
      ################################################################

   .. oe:method:: AutoMapRxn

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

         .. oe:api::

            unsigned AutoMapRxn(OEMolBase& rxn)

      .. oe:language:: python

         .. oe:api:: python

            AutoMapRxn(rxn: Union[OEGraphMol,OEMol,OEQMol]) -> int

      Requests the provided reaction be processed to apply atom-atom mapping correspondence.

   .. seealso::

      * :ref:`OERxnAutomapStatus <OEChem_OERxnAutomapStatus>` namespace

   .. ################################################################
      # GetOptions
      ################################################################

   .. oe:method:: GetOptions

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

         .. oe:api::

            const OERxnAutomapperOptions& GetOptions() const
            OERxnAutomapperOptions& GetOptions()

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OERxnAutomapperOptions

      Returns the internal option class that controls the automap activities.

