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

.. oe:namespace:: OEChem

.. oe:class:: OEHelmGenerationResult

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHelmGenerationResult

   This class is used to return additional information when using the  
   :oe:cls:`OEChem::OEMolToHelm` function.

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHelmGenerationResult()
            OEHelmGenerationResult(const OEHelmGenerationResult &)

      .. oe:language:: python

         .. oe:api:: python

            OEHelmGenerationResult() -> OEHelmGenerationResult
            OEHelmGenerationResult(arg2: OEHelmGenerationResult) -> OEHelmGenerationResult

      Default and copy constructor.

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

      .. oe:api::

         OEHelmGenerationResult &operator=(const OEHelmGenerationResult &)

      Assignment operator. 

   .. oe:method:: GetCodeSet

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

         .. oe:api::

            std::string GetCodeSet() const

      .. oe:language:: python

         .. oe:api:: python

            GetCodeSet() -> str

      Returns the name of the code-set that is used to successfully generate the :term:`HELM` string.

   .. oe:method:: GetReturnCode

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

         .. oe:api::

            unsigned GetReturnCode() const

      .. oe:language:: python

         .. oe:api:: python

            GetReturnCode() -> int

      Returns a code from the  
      :oe:constns:`OEChem::OEHelmGenerationReturnCode` namespace.

   .. oe:method:: GetUnmappedFragments

      Returns the SMILES representation of unmapped fragments in the molecule.

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

         .. oe:api::

            std::vector<std::string> GetUnmappedFragments() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnmappedFragments() -> OEStringVector

   .. oe:method:: GetWarning

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

         .. oe:api::

            std::string GetWarning() const

      .. oe:language:: python

         .. oe:api:: python

            GetWarning() -> str

      If the :term:`HELM` generation fails, i.e. the return code is not 
      :oe:const:`OEChem::OEHelmGenerationReturnCode::Success`,
      this message provides details about the reason for the failure.
   
