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

.. oe:namespace:: OEChem

.. oe:constnamespace:: OEHelmParsingReturnCode

   .. attention::

      |PRELIMINARY-API|

   The :oe:constns:`OEChem::OEHelmParsingReturnCode` namespace
   contains codes representing the success or various issues of :term:`HELM` string
   parsing when using the :oe:func:`OEChem::OEHelmToMol` function. 

   .. seealso::

      * :oe:cls:`OEChem::OEHelmParsingResult` class

   .. oe:constant:: Success

      Represents that the HELM is **successfully** parsed.

   .. oe:constant:: HelmInvalidComponent

   .. oe:constant:: HelmInvalidVersion

   .. oe:constant:: HelmSyntaxError

   .. oe:constant:: InvalidConnectionChainId

      The HELM connection component references a chain that does not exist.

   .. oe:constant:: InvalidConnectionMonomerIdx

      The HELM connection component references a monomer that does not exist.

   .. oe:constant:: InvalidConnectionRGroupIdx

      The HELM connection component references a chain that does not exist.


   .. oe:constant:: InvalidEmbeddedSmiles

      The HELM contains embedded :term:`SMILES` string that can not be parsed and converted into a 
      monomer.

   .. oe:constant:: InvalidMonomerConnection

      The HELM contains monomer connections that are invalid.

   .. oe:constant:: NotSupported

      The HELM contains features that is not supported yet in the current implementation.

   .. oe:constant:: UnrecognizedMonomerCode

      The HELM string includes a monomer code that is not present in the selected code sets.
