.. oe:namespace:: OEMedChem


.. oe:constnamespace:: OEMatchedPairIndexStatus

   This namespace contains constants representing status information
   returned from matched pair indexing.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: BinaryIOError

      This value indicates a serialization or deserialization
      issue during molecule fragmentation import or export.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: CopyMolError

      This value indicates that an internal error was encountered when
      attempting to copy the input structure for indexing manipulations.

   .. ################################################################
      #
      ################################################################

   .. oe:constant: DataFilter  # NOT_YET

      This value indicates that the structure was not added to the
      index as a result not satisfying the input SD data requirements.

   .. ################################################################
      #
      ################################################################

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Deactivated

      This value indicates that an index loaded from serialization
      output encountered an internal loading failure and cannot be
      used as an active index.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DuplicateRecordID

      This value indicates that the record id provided for the structure
      is already in use.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: DuplicateStructure

      This value indicates that the structure is already present in
      the index.

      .. seealso::

         * :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::SetOptions`
         * :oe:const:`OEMedChem::OEMatchedPairOptions::UniquesOnly`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: FragmentRangeFilter

      This value indicates that the structure was not added to the
      index as a result of exceeding the allowed range of the indexable
      fragment filter.

      .. seealso::

         * :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::SetIndexableFragmentRange`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: FragmentationLimitFilter

      This value indicates that the structure was not added to the
      index as a result of exceeding the number of allowed fragmentation bonds.

      .. seealso::

         * :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::SetFragmentationLimit`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: HeavyAtomFilter

      This value indicates that the structure was not added to the
      index due to exceeding the heavy atom limit.

      .. seealso::

         * :oe:meth:`OEMedChem::OEMatchedPairAnalyzerOptions::SetMaxAtomFilter`

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: IncompatibleOptions

      This value indicates that an internal mismatch in fragmentation arguments and those
      for the target :ref:`OEMatchedPairAnalyzer <OEMedChem_OEMatchedPairAnalyzer>` instance was identified.
      Contact support@eyesopen.com with details.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NoError

      This value indicates a successful indexing status.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NoFragmentationBonds

      This value indicates the structure contains no fragmentation
      bonds.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: NoStructure

      This value indicates that the structure is empty, or contains
      no heavy atoms.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ProcessorError

      This value indicates that the internal processing engine has rejected
      the structure for unspecified reasons.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: ProcessorFilter

      This value indicates that the internal processing engine has rejected
      the structure based on the filter steps prior to indexing.  One possible
      reason for the rejection is the presence of one or more unspecified
      atom types in the structure being indexed.

   .. ################################################################
      #
      ################################################################

   .. oe:constant:: Unspecified

      This value indicates an abnormal indexing status return of an
      unspecified nature.
