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

.. oe:namespace:: OEMedChem

.. meta::
   :keywords: OECreateMMPIndexStatus, CreateMMPIndexStatus


.. _OEMedChem_OECreateMMPIndexStatus:

.. oe:class:: OECreateMMPIndexStatus

   .. oe:api::

      class OECreateMMPIndexStatus

   Encapsulates the status information returned from a matched pair indexing analysis.

   .. seealso::

      * :oe:func:`OEMedChem::OECreateMMPIndexFile` function

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

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

         .. oe:api::

            OECreateMMPIndexStatus(bool valid = true)
            OECreateMMPIndexStatus(const OECreateMMPIndexStatus& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OECreateMMPIndexStatus(valid: bool = True) -> OECreateMMPIndexStatus
            OECreateMMPIndexStatus(rhs: OECreateMMPIndexStatus) -> OECreateMMPIndexStatus

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

      .. oe:api::

        OECreateMMPIndexStatus& operator+=(const OECreateMMPIndexStatus &addstatus)

      Summation operator that increments the current instance based on data from the 'addstatus' :ref:`OECreateMMPIndexStatus <OEMedChem_OECreateMMPIndexStatus>` object.

   .. ################################################################
      # AddIndexedMol
      ################################################################

   .. oe:method:: AddIndexedMol

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

         .. oe:api::

            unsigned int AddIndexedMol()

      .. oe:language:: python

         .. oe:api:: python

            AddIndexedMol() -> int

      Increment the internal count of indexed molecule records by one.

   .. ################################################################
      # AddUnindexedMol
      ################################################################

   .. oe:method:: AddUnindexedMol

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

         .. oe:api::

            unsigned int AddUnindexedMol()

      .. oe:language:: python

         .. oe:api:: python

            AddUnindexedMol() -> int

      Increment the internal count of unindexed molecule records by one.

   .. ################################################################
      # GetNumMatchedPairs
      ################################################################

   .. oe:method:: GetNumMatchedPairs

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

         .. oe:api::

            unsigned int GetNumMatchedPairs() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumMatchedPairs() -> int

      Return the number of Matched Pairs generated from indexing.

   .. ################################################################
      # GetNumMols
      ################################################################

   .. oe:method:: GetNumMols

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

         .. oe:api::

            unsigned int GetNumMols() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumMols() -> int

      Return the internal count of indexed molecule records.

   .. ################################################################
      # GetTotalMols
      ################################################################

   .. oe:method:: GetTotalMols

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

         .. oe:api::

            unsigned int GetTotalMols() const

      .. oe:language:: python

         .. oe:api:: python

            GetTotalMols() -> int

      Return the internal count of indexed plus unindexed molecule, (i.e., total) records.

   .. ################################################################
      # GetUnindexedMols
      ################################################################

   .. oe:method:: GetUnindexedMols

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

         .. oe:api::

            unsigned int GetUnindexedMols() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnindexedMols() -> int

      Return the internal count of unindexed molecule records.

   .. ################################################################
      # SetNumMatchedPairs
      ################################################################

   .. oe:method:: SetNumMatchedPairs

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

         .. oe:api::

            void SetNumMatchedPairs(unsigned int mmps)

      .. oe:language:: python

         .. oe:api:: python

            SetNumMatchedPairs(nummmps: int) -> None

      Sets the internal count for the number of Matched Pairs generated from indexing.

   .. ################################################################
      # SetNumMols
      ################################################################

   .. oe:method:: SetNumMols

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

         .. oe:api::

            void SetNumMols(unsigned int indexed)

      .. oe:language:: python

         .. oe:api:: python

            SetNumMols(nummols: int) -> None

      Sets the internal count of indexed molecule records to the specified value.

   .. oe:method:: SetUnindexedMols

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

         .. oe:api::

            void SetUnindexedMols(unsigned int unindexed)

      .. oe:language:: python

         .. oe:api:: python

            SetUnindexedMols(unindexed: int) -> None

      Sets the internal count of unindexed molecule records to the specified value.

   .. ################################################################
      # SetValid
      ################################################################

   .. oe:method:: SetValid

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

         .. oe:api::

            void SetValid(bool valid)

      .. oe:language:: python

         .. oe:api:: python

            SetValid(valid: bool) -> None

      Sets the boolean validity of this status class.
