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

.. oe:namespace:: OEChem

.. oe:constnamespace:: OEHelmGenerationReturnCode

   .. attention::

      |PRELIMINARY-API|

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


   .. seealso::

      * :oe:cls:`OEChem::OEHelmGenerationResult` class


   .. oe:constant:: Success

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


   .. oe:constant:: InvalidCodeSet

      Returned if the the monomers set used for :term:`HELM` generation does not have the specified
      code-set.

   .. oe:constant:: InvalidMonomerGraph

      Returns if after the monomers mapped to the molecule, the monomer graph can not be fully traversed
      to encode all the monomer components in the :term:`HELM` string.

   .. oe:constant:: InvalidUnmappedFragment

      Returned if there is any unmapped monomer in the molecule that can not be represented
      in the :term:`HELM` as an embedded SMILES string.

   .. oe:constant:: NoSequence

      Returned if the molecule has large portion of its sequence unmapped to known monomers.

   .. oe:constant:: TooLarge

      Returned if the molecule has more than 2048 heavy atoms and it is considered
      too large for :term:`HELM` generation.

   .. oe:constant:: UnmappedFragments

      Returns if there are any unmapped fragments in the molecule that would obstruct
      the generation of a valid :term:`HELM` string without embedded SMILES.

      .. seealso::

         * :oe:meth:`OEChem::OEHelmGenerationOptions::GetAllowUnmatchedFragments` method

   .. oe:constant:: UnspecifiedAtomStereo

      Returns if there is any unspecified stereo of a chiral atom in the molecule that would obstruct
      the generation of a valid :term:`HELM` string without embedded SMILES.

      .. seealso::

         * :oe:meth:`OEChem::OEHelmGenerationOptions::SetAllowUnspecifiedStereo` method

   .. oe:constant:: UnspecifiedBondStereo

      Returns if there is any unspecified stereo of a chiral bond in the molecule that would obstruct
      the generation of a valid :term:`HELM` string without embedded SMILES.

      .. seealso::

         * :oe:meth:`OEChem::OEHelmGenerationOptions::SetAllowUnspecifiedStereo` method
