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

.. oe:namespace:: OEChem

.. _OEChem_OEMonomerValidationResult:

.. oe:class:: OEMonomerValidationResult

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEMonomerValidationResult

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

   .. oe:method:: Constructors

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

         .. oe:api::

            OEMonomerValidationResult()
            OEMonomerValidationResult(const OEMonomerValidationResult &)

      .. oe:language:: python

         .. oe:api:: python

            OEMonomerValidationResult() -> OEMonomerValidationResult
            OEMonomerValidationResult(arg2: OEMonomerValidationResult) -> OEMonomerValidationResult

      Default and copy constructor.

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

      .. oe:api::

         OEMonomerValidationResult &operator=(const OEMonomerValidationResult &)

      Assignment operator.

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

