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

.. oe:namespace:: OEChem

.. _OEChem_OERxnAutomapStatus:

.. oe:constnamespace:: OERxnAutomapStatus

   .. attention::

      |PRELIMINARY-API|

   The :oe:constns:`OEChem::OERxnAutomapStatus` namespace encodes symbolic constants
   representing the status returned from reaction automapping.

   .. seealso::

      * :ref:`OERxnAutomapper <OEChem_OERxnAutomapper>` class

   This namespace contains the following constants:

   .. oe:constant:: Failure

      This status indicates a general failure attempting to automap a reaction.

   .. oe:constant:: InvalidComponents

      This status indicates that the input reaction is missing either reactants
      or products and thus cannot have mapping correspondence assigned.

   .. oe:constant:: InvalidMethod

      This status indicates that an invalid mapping method was requested.

   .. oe:constant:: NonReactionInput

      This status indicates that the input structure is not identified as a reaction.

      .. seealso::

         * :oe:meth:`IsRxn<OEChem::OEMolBase::IsRxn>`

   .. oe:constant:: Success

      This status indicates success.

