.. oe:namespace:: OEChem


.. _OEChem_OEMMFFTypeResult:

.. oe:class:: OEMMFFTypeResult

   .. oe:api::

      class OEMMFFTypeResult

   Used by the :oe:func:`OEChem::OEMMFFAtomType` function to retrieve
   the MMFF94 type of an atom.

   The following table describes how the result should be interpreted:

   .. list-table::
      :widths: 100 50 150
      :header-rows: 1

      * - GetMMFFType()
        - GetFailed()
        - interpretation

      * - :oe:const:`OEChem::OEMMFFType::UNK`
        - true
        - MMFF atom type **can not** be identified

      * - *not* :oe:const:`OEChem::OEMMFFType::UNK`
        - true
        - an **alternative** MMFF atom type is identified

      * - *not* :oe:const:`OEChem::OEMMFFType::UNK`
        - false
        - MMFF atom type is identified **successfully**

   .. oe:method:: Constructors

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

         .. oe:api::

            OEMMFFTypeResult(unsigned int type, bool failed)

      .. oe:language:: python

         .. oe:api:: python

            OEMMFFTypeResult(type: int, failed: bool) -> OEMMFFTypeResult
            OEMMFFTypeResult(rhs: OEMMFFTypeResult) -> OEMMFFTypeResult

      Constructor

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

      .. oe:api::

         OEMMFFTypeResult & operator=(const OEMMFFTypeResult & rhs)

      Assignment operator.


   .. oe:method:: GetFailed

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

         .. oe:api::

            bool GetFailed() const

      .. oe:language:: python

         .. oe:api:: python

            GetFailed() -> bool

      Returns whether MMFF94 type can be assigned to an atom.

   .. oe:method:: GetMMFFType

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

         .. oe:api::

            unsigned int GetMMFFType() const

      .. oe:language:: python

         .. oe:api:: python

            GetMMFFType() -> int

      Returns MMFF94 type from the :oe:constns:`OEChem::OEMMFFType`
      namespace.


