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

.. oe:namespace:: OEChem

.. _OEHelmParsingResult:

.. oe:class:: OEHelmParsingResult

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHelmParsingResult

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

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

         .. oe:api::

            OEHelmParsingResult()
            OEHelmParsingResult(const OEHelmParsingResult &)

      .. oe:language:: python

         .. oe:api:: python

            OEHelmParsingResult() -> OEHelmParsingResult
            OEHelmParsingResult(arg2: OEHelmParsingResult) -> OEHelmParsingResult

      Default and copy constructor.

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

      .. oe:api::

         OEHelmParsingResult &operator=(const OEHelmParsingResult &)

      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 parse the :term:`HELM` string.

   .. oe:method:: GetErrorPosition

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

         .. oe:api::

            unsigned GetErrorPosition() const

      .. oe:language:: python

         .. oe:api:: python

            GetErrorPosition() -> int

      If the HELm parsing fails, i.e. the return code is not 
      :oe:const:`OEChem::OEHelmParsingReturnCode::Success`,
      this shows the position in the HELM string where the failure occurs.

   .. 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::OEHelmParsingReturnCode` namespace.

   .. 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` parsing fails, i.e. the return code is not 
      :oe:const:`OEChem::OEHelmParsingReturnCode::Success`,
      this message provides details about the reason for the failure.
